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 622971 - List of typos in the GTK-doc manual
List of typos in the GTK-doc manual
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: 1.16
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2010-06-27 19:48 UTC by Alexander Saprykin
Modified: 2010-07-06 04:34 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Alexander Saprykin 2010-06-27 19:48:19 UTC
Here is a list of typos I found during gtk-doc-manual reading. Typos followed by URL where it can be found.

(1)
http://library.gnome.org/devel/gtk-doc-manual/stable/howdoesgtkdocwork.html.en

"On the first run this file is copied to <module>-sections.txt  The author can rearrange the sections" - period is missing.

"If for some reason one would like some sybols to show up in the docs, where the full declaration cannot be found by th scanner or the declaration should appear differently, one can place enties similar to the ones in <module>-decl.txt into <module>-overrides.txt." - typos in "sybols" and "th".

"If there are no tmpl files used it only reads takes docs from sources and introspection data." - "reads takes" looks strange.

"Likewise gtkdoc-mkpdf turns the SGML/XML files into a PDF docuemnt called <package>.pdf." - typo in "docuemnt"

(2)
http://library.gnome.org/devel/gtk-doc-manual/stable/gettinggtkdoc.html.en

"Modular DocBook Stylesheets  This is the DSSSL code to convert DocBook to HTML" - period is missing

(3)
http://library.gnome.org/devel/gtk-doc-manual/stable/settingup.html.en

"Theses section assume we work on a project called 'meep'." - I think "These sections" should be.

(4)
http://library.gnome.org/devel/gtk-doc-manual/stable/settingup_docfiles.html.en

"This can then look as show below:" - I think "shown" should be.

(5)
http://library.gnome.org/devel/gtk-doc-manual/stable/settingup_automake.html.en

"The next step is to edit the setting inside the Makefile.am" - should be "settings" I think

"Just add then one-liner show in the next example to you top-level Makefile.am" - should be "shown" again.

(6)
http://library.gnome.org/devel/gtk-doc-manual/stable/settingup_autogen.html.en

"If also check you configure script for the GTK_DOC_CHECK  invocation." - this sentence looks strange, maybe "It also checks your configure script" should be?

"When running gtkdocize it copies gtk-doc.make to you project root" - "your" instead of "you"?

"Historically GTK-Doc was gerating template files where developers entered the docs. this turned out to be not so good" - typo in "gerating", "this" should start from capitalized letter.

"they can be added also to a environment variable" - "an" instead of "a".

(7)
http://library.gnome.org/devel/gtk-doc-manual/stable/documenting.html.en

"During the next section you find all information about the syntax of the comments." - "you will find" instead?

(8)
http://library.gnome.org/devel/gtk-doc-manual/stable/documenting_sections.html.en

"A list of symbols that are related to this section.." - extra period.

"For GObjects the <title> is used as a section_id and for other section it is <MODULE>-<title>." - "for other sections" should be, I think.

"* @Image: application.png" - "@image" should be.

(9)
http://library.gnome.org/devel/gtk-doc-manual/stable/documenting_symbols.html.en

"Thus function are usually documented in the c-source and macros, struct and enum in the header file." - I think "fucntions", "structs", "macroses" and "enums" should be, shouldn't?

"for the reverse behavirour" - typo in "behavirour", occurred twice.

(10)
http://library.gnome.org/devel/gtk-doc-manual/stable/metafiles_master.html.en

"The master document includes them and place them in a order." - "an order".

(11)
http://library.gnome.org/devel/gtk-doc-manual/stable/reports.html.en

"The first and can be compared with the section file if that is manualy maintained. The second lists all declarations fromt he headers If a symbol is missing one could check if this file contains it." - maybe useless "and" in "The first and can"?

(12)
http://library.gnome.org/devel/gtk-doc-manual/stable/faq.html.en

Why only one "Frequently Asked Question"?
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2010-07-05 07:27:52 UTC
Thanks! I guess many projects would prefer this kind of report in the form of a patch. Please ask if you need help in making a patch. But be assured that it is actually easier than writing down the chapters one by one.

commit 92ae5fc857f11611080205d27c8e26dce93d7e49
Author: Stefan Kost <ensonic@users.sf.net>
Date:   Mon Jul 5 10:24:23 2010 +0300

    manual: fix spelling and make small clarifications.
    
    Correct typos and spelling as pointed out by  Alexander Saprykin. Fixes #622971.
Comment 2 Alexander Saprykin 2010-07-06 04:34:44 UTC
Thanks, Stefan. I'll write a patch next time.