After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 622379 - A list of possible typos in Application Developer Manual
A list of possible typos in Application Developer Manual
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
0.10.29
Other Linux
: Normal normal
: 0.10.30
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2010-06-22 11:09 UTC by Alexander Saprykin
Modified: 2010-07-01 18:59 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Alexander Saprykin 2010-06-22 11:09:42 UTC
Here is a list of possible typos I found during reading this manual.

"events can be synchronised", while everywhere "synchronized" variant is used:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-intro-basics-communication.html

What is the meaning of this phrase: "application against the uninstalled location."? Here:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-helloworld-compilerun.html

"a specific stream-property related to progress tracking", maybe unnecessary dash? Here:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/chapter-queryevents.html#section-querying

"XVImageSink", I think it should be "XvImageSink", here:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-interfaces-proprobe.html

"all plugins that implement a typefinder. when one of the typefinders recognizes the stream", I think that "When" should start with capital letter, here:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-typefinding.html

"can set the GOBject property", "GObject" should be, here: 
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-dparams-parameters.html

"will disable color debugging You can also set", dot is missing; "Note that if you are disabling color purely to avoid messing up your pager output, trying using less -R.", strange sentence, maybe there should be "try" instead of "trying"? All is here:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-checklist-debug.html
Comment 1 Tim-Philipp Müller 2010-07-01 18:59:50 UTC
> "events can be synchronised", while everywhere "synchronized" variant is used:
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-intro-basics-communication.htm

Yeah, well, I don't think I'm not going to start "fixing" American English vs. British English spelling, seems a bit pointless.
 

> What is the meaning of this phrase: "application against the uninstalled
> location."? Here:
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-helloworld-compilerun.html

Looks like a copy'n'paste artifact. Fixed.


> "a specific stream-property related to progress tracking", maybe unnecessary
> dash? Here:
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/chapter-queryevents.html#section-querying

Agreed, fixed.


> "XVImageSink", I think it should be "XvImageSink", here:
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-interfaces-proprobe.html

Changed to XVideo, that seemed more consistent.


> "all plugins that implement a typefinder. when one of the typefinders
> recognizes the stream", I think that "When" should start with capital letter,
> here:
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-typefinding.html

Fixed.


> "can set the GOBject property", "GObject" should be, here: 
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-dparams-parameters.html

Fixed.

 
> "will disable color debugging You can also set", dot is missing; "Note that if
> you are disabling color purely to avoid messing up your pager output, trying
> using less -R.", strange sentence, maybe there should be "try" instead of
> "trying"? All is here:
> http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-checklist-debug.html

Fixed and Fixed.

commit 2f149355cd449e7f3a653103c4b8d26204e92226
Author: Tim-Philipp Müller <tim.muller@collabora.co.uk>
Date:   Thu Jul 1 19:58:09 2010 +0100

    docs: fix a couple of typos in the manual
    
    Spotted by Alexander Saprykin.
    
    Fixes #622379.