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 303571 - Expansion of extra content files
Expansion of extra content 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 15:30 UTC by Owen Taylor
Modified: 2005-05-16 15:47 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Patch implementing --extra-db-files (5.86 KB, patch)
2005-05-09 15:32 UTC, Owen Taylor
none Details | Review

Description Owen Taylor 2005-05-09 15:30:20 UTC
For a long time, an annoying aspect of gtk-doc is that you
can't use the handy abbreviations (#GtkWidget) in extra material
included with the manual that doesn't live in the templates.

The attached patch:

 - Adds a --extra-db-files option to gtkdoc-mkdb which specifies
   extra files to expand and copy into the output directory

 - Adds a $expand_content_files variable to gtk-doc.make

Thinking it over, it's probably better to rename the gtkdoc option
to --expand-content-files as well. It's --extra-db-files on 
rough analogy to --main-sgml-file.
Comment 1 Owen Taylor 2005-05-09 15:32:22 UTC
Created attachment 46241 [details] [review]
Patch implementing --extra-db-files
Comment 2 Owen Taylor 2005-05-09 23:26:12 UTC
Turns out that this patch causes a problem ... you can't reference undefined
variables in EXTRA_DIST, so makefiles with the new gtk-doc.make 
break until expand_content_files is added to them.

The only easy thing I can think of is to require people to list such content
files in *both* content_files and in expand_content_files rather than make
them parallel. I don't like it so much, but it should be workable.
Comment 3 Damon Chaplin 2005-05-10 09:29:33 UTC
Looks fine. I agree that '--expand-content-files' is better.
Comment 4 Owen Taylor 2005-05-10 16:30:55 UTC
OK if I bump the gtk-doc version to 1.4 when committing this?
I need a new version number to actually use this stuff in the Cairo
docs.
Comment 5 Damon Chaplin 2005-05-11 10:15:50 UTC
Sure.
Comment 6 Owen Taylor 2005-05-16 15:47:25 UTC
2005-05-10  Owen Taylor  <otaylor@redhat.com>

        * gtkdoc-mkdb.in: Add an --expand-content-files option
        to specify extra files to expand abbreviations in and
        copy into the output directory.

        * gtk-doc.make examples/Makefile.am: Add expand_content_files
        variable.

        * configure.in: Up version to 1.4.