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 303563 - Support pared-down template files
Support pared-down template files
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2005-05-09 14:28 UTC by Owen Taylor
Modified: 2005-05-16 15:47 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Patch implementing --only-section-tmpl (3.65 KB, patch)
2005-05-09 14:29 UTC, Owen Taylor 		accepted-commit_now Details | Review

Description Owen Taylor 2005-05-09 14:28:46 UTC 
For a project that is putting all symbol docs inline, the
updating of template files is just a source of CVS conflicts.

One approach is to put the section docs inline, but editing
long section docs in comments is a bit annoying, so here's
a patch that adds a --only-section-tmpl option to 
gtkdoc-mktmpl. The effect is that all symbol documentation is 
excluded from the template files.
Comment 1 Owen Taylor 2005-05-09 14:29:37 UTC 
Created attachment 46238 [details] [review]
Patch implementing --only-section-tmpl
Comment 2 Damon Chaplin 2005-05-10 09:11:46 UTC 
Looks fine.

Though at some point I would prefer to get rid of the template files
altogether, and just use an 'include' feature to include long descriptions
where needed.
Comment 3 Owen Taylor 2005-05-16 15:47:51 UTC 
2005-05-10  Owen Taylor  <otaylor@redhat.com>

        * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
        --only-section-tmpl flag so that projects that keep everything
        but section descriptions inline can avoid cvs conflicts.

        * gtk-doc.make examples/Makefile.am: Add support for
        MKTMPL_OPTIONS