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 707531 - Two mistakes in the language definition 2.0 tutorial
Two mistakes in the language definition 2.0 tutorial
Status: RESOLVED FIXED
Product: gtksourceview
Classification: Platform
Component: General
git master
Other All
: Normal normal
: ---
Assigned To: GTK Sourceview maintainers
GTK Sourceview maintainers
Depends on:
Blocks:
 
 
Reported: 2013-09-05 03:39 UTC by Ming Hua
Modified: 2013-09-06 11:50 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
untested patch to fix mistakes in code snippets of the language-spec tutorial (603 bytes, patch)
2013-09-05 03:40 UTC, Ming Hua 		none Details | Review

Description Ming Hua 2013-09-05 03:39:01 UTC 
When following the tutorial to construct the full language-spec file (see bug #707372) I found the following two mistakes in the code snippet examples in the tutorial:

1. Characters "<" and ">" need to be escaped in XML;

2. The style for #include'ed header was defined as "style id="included-file"" earlier, so should be reference as such, instead of "style-ref="package"".

A patch is attached.  I didn't test it (don't really know how to build GTK+ documentation) but it should be obvious enough.

Regards,
Ming
Comment 1 Ming Hua 2013-09-05 03:40:31 UTC 
Created attachment 254152 [details] [review]
untested patch to fix mistakes in code snippets of the language-spec tutorial
Comment 2 Sébastien Wilmet 2013-09-06 11:50:14 UTC 
Thank you for the patch. Here is the commit:
https://git.gnome.org/browse/gtksourceview/commit/?id=7730714e33464562b625994184b08059c8487a41

To compile the doc, use the --enable-gtk-doc configure option.

The next time, please create the patch with git format-patch, it will simplify the live of the developer.