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 591975 - Section_Id always embeds a trailing newline
Section_Id always embeds a trailing newline
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.12
Other Linux
: Normal trivial
: 1.14
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2009-08-16 14:59 UTC by Nicola Fontana
Modified: 2009-12-19 21:25 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Simply strips any trailing blank on non-empty section_id (995 bytes, text/plain)
2009-08-16 15:07 UTC, Nicola Fontana
Details

Description Nicola Fontana 2009-08-16 14:59:57 UTC
The following docblock:

/**
 * SECTION:adg-pair
 * @Section_Id:AdgPair-GBoxed
 * ...
 **/

gives me this xml fragment:

<refentry id="AdgPair-GBoxed
">
<refmeta>
<refentrytitle role="top_of_page" id="AdgPair-GBoxed
.top_of_page">AdgPair</refentrytitle>
...

and in the final HTML the newlines are converted to spaces. I didn't find any way to get rid of this newline other than patch gtkdoc-mkdb.
Comment 1 Nicola Fontana 2009-08-16 15:07:25 UTC
Created attachment 140891 [details]
Simply strips any trailing blank on non-empty section_id

Sanitizing this id should be considered too, I think something like this:

$section_id = &CreateValidSGMLID ($section_id);
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2009-12-19 21:25:40 UTC
commit bf3485d864f1b3475f10c6e3d0b01815e3d5dc69
Author: Nicola Fontana <ntd@entidi.it>
Date:   Sun Aug 16 15:48:47 2009 +0200

    gtkdoc-mkdb: remove trailing blanks from Section_Id, Fixes #591975
    
    $SourceSymbolDocs always embeds the trailing newline. Being an id, there
    is no reasons to keep any blank at the end of a section id.