Debian Bug report logs - #848297
gst-plugins-bad1.0: docstring collision

Toggle useless messages

Message #5 received at submit@bugs.debian.org (full text, mbox, reply):

From: Daniel Shahaf <danielsh@apache.org>

To: Debian Bug Tracking System <submit@bugs.debian.org>

Subject: gst-plugins-bad1.0: docstring collision

Date: Fri, 16 Dec 2016 00:44:38 +0000

Package: gst-plugins-bad1.0
Version: 1.10.2-1
Severity: minor
Tags: patch upstream
User: reproducible-builds@lists.alioth.debian.org
Usertags: randomness

Dear Maintainer,

The documentation of GstColorEffectsPreset sometimes uses the docstring
of GstColorEffectsPreset and sometimes the docstring of GstMirrorMode [1]:

│   │   │   ├── ./usr/share/gtk-doc/html/gst-plugins-bad-plugins-1.0/gst-plugins-bad-plugins-coloreffects.html
│   │   │   │ @@ -188,15 +188,15 @@
│   │   │   │  <div class="refsect2">
│   │   │   │  <a name="GstColorEffectsPreset"></a><h3>enum GstColorEffectsPreset</h3>
│   │   │   │ -<p>How to split the video frame and which side reflect</p>
│   │   │   │ +<p>The lookup table to use to convert input colors</p>

I believe that that is caused by the docstring of GstMirrorMode
mistakenly referring to GstColorEffectsPreset:

[[[
diff --git a/gst/geometrictransform/gstmirror.h b/gst/geometrictransform/gstmirror.h
index 2084f2c..22e6aa5 100644
--- a/gst/geometrictransform/gstmirror.h
+++ b/gst/geometrictransform/gstmirror.h
@@ -66,7 +66,7 @@ typedef struct _GstMirror GstMirror;
 typedef struct _GstMirrorClass GstMirrorClass;
 
 /**
- * GstColorEffectsPreset:
+ * GstMirrorMode:
  * @GST_MIRROR_MODE_LEFT: Split horizontally and reflect left into right
  * @GST_MIRROR_MODE_RIGHT: Split horizontally and reflect right into left
  * @GST_MIRROR_MODE_TOP: Split horizontally and reflect top into bottom
]]]

Cheers,

Daniel

P.S. Apologies for not making a more thorough investigation; I would,
but for health reasons.

[1] https://tests.reproducible-builds.org/debian/rb-pkg/unstable/armhf/gst-plugins-bad1.0.html

Message #10 received at submit@bugs.debian.org (full text, mbox, reply):

From: Sebastian Dröge <slomo@coaxion.net>

To: Daniel Shahaf <danielsh@apache.org>, 848297@bugs.debian.org, Debian Bug Tracking System <submit@bugs.debian.org>

Subject: Re: Bug#848297: gst-plugins-bad1.0: docstring collision

Date: Fri, 16 Dec 2016 13:29:02 +0200

[Message part 1 (text/plain, inline)]

On Fri, 2016-12-16 at 00:44 +0000, Daniel Shahaf wrote:
> 
> Dear Maintainer,
> 
> The documentation of GstColorEffectsPreset sometimes uses the
> docstring
> of GstColorEffectsPreset and sometimes the docstring of GstMirrorMode
[...]

Hi Daniel, I've merged your patch upstream and will include it in the
1.10.3 release:
http://cgit.freedesktop.org/gstreamer/gst-plugins-bad/commit/?id=a38887375f3631c9198fa328e76a7ae7b28a16c0

Thanks for noticing and reporting!

>  
> P.S. Apologies for not making a more thorough investigation; I would,
> but for health reasons.

No problem, hope you're feeling better again soon :)

[signature.asc (application/pgp-signature, inline)]

Message #20 received at 848297-done@bugs.debian.org (full text, mbox, reply):

From: Mattia Rizzolo <mattia@debian.org>

To: Sebastian Dröge <slomo@coaxion.net>, 848297-done@bugs.debian.org

Cc: Daniel Shahaf <danielsh@apache.org>

Subject: Re: Bug#848297: gst-plugins-bad1.0: docstring collision

Date: Tue, 8 Aug 2017 16:41:53 +0200

[Message part 1 (text/plain, inline)]

Version: 1.10.3-1

On Fri, Dec 16, 2016 at 01:29:02PM +0200, Sebastian Dröge wrote:
> On Fri, 2016-12-16 at 00:44 +0000, Daniel Shahaf wrote:
> > 
> > Dear Maintainer,
> > 
> > The documentation of GstColorEffectsPreset sometimes uses the
> > docstring
> > of GstColorEffectsPreset and sometimes the docstring of GstMirrorMode
> [...]
> 
> Hi Daniel, I've merged your patch upstream and will include it in the
> 1.10.3 release:
> http://cgit.freedesktop.org/gstreamer/gst-plugins-bad/commit/?id=a38887375f3631c9198fa328e76a7ae7b28a16c0
> 
> Thanks for noticing and reporting!

Thank you!


Closing this bug manually since it wasn't closed with the upload.

-- 
regards,
                        Mattia Rizzolo

GPG Key: 66AE 2B4A FCCF 3F52 DA18  4D18 4B04 3FCD B944 4540      .''`.
more about me:  https://mapreri.org                             : :'  :
Launchpad user: https://launchpad.net/~mapreri                  `. `'`
Debian QA page: https://qa.debian.org/developer.php?login=mattia  `-

[signature.asc (application/pgp-signature, inline)]

Send a report that this bug log contains spam.