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 741763 - Example Makefile.am improvements
Example Makefile.am improvements
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other All
: Normal normal
: 1.22
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2014-12-19 13:50 UTC by Philip Withnall
Modified: 2014-12-29 14:31 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
examples: Remove outdated variables from example Makefile.am (1.57 KB, patch)
2014-12-19 13:50 UTC, Philip Withnall
committed Details | Review
examples: Enable gtk-doc `make check` tests by default (953 bytes, patch)
2014-12-19 13:50 UTC, Philip Withnall
committed Details | Review
make: Automatically clean sections.txt if --rebuild-sections is used (2.00 KB, patch)
2014-12-19 13:50 UTC, Philip Withnall
committed Details | Review
make: Use $(expand_content_files) wherever $(content_files) is used (5.11 KB, patch)
2014-12-19 13:50 UTC, Philip Withnall
committed Details | Review
make: Use $(expand_content_files) wherever $(content_files) is used (5.12 KB, patch)
2014-12-29 14:31 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review
make: Automatically clean sections.txt if --rebuild-sections is used (2.01 KB, patch)
2014-12-29 14:31 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review
examples: Enable gtk-doc `make check` tests by default (970 bytes, patch)
2014-12-29 14:31 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review
examples: Remove outdated variables from example Makefile.am (1.58 KB, patch)
2014-12-29 14:31 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review

Description Philip Withnall 2014-12-19 13:50:27 UTC
A few improvements to the examples/Makefile.am to simplify it, adding some more logic to gtk-doc.make to ensure the user has to do less stuff manually.
Comment 1 Philip Withnall 2014-12-19 13:50:29 UTC
Created attachment 293050 [details] [review]
examples: Remove outdated variables from example Makefile.am

Everyone has automake 1.6 now. Specifying EXTRA_DIST is a bit pointless.
Comment 2 Philip Withnall 2014-12-19 13:50:32 UTC
Created attachment 293051 [details] [review]
examples: Enable gtk-doc `make check` tests by default

Otherwise they never get enabled. If people have problems getting the
tests to pass, they should either fix their documents, or we should make
the tests cleverer.
Comment 3 Philip Withnall 2014-12-19 13:50:36 UTC
Created attachment 293052 [details] [review]
make: Automatically clean sections.txt if --rebuild-sections is used

Rather than documenting it in a comment in the example Makefile.am;
might as well automate it.
Comment 4 Philip Withnall 2014-12-19 13:50:40 UTC
Created attachment 293053 [details] [review]
make: Use $(expand_content_files) wherever $(content_files) is used

This means we can eliminate the advice that all $(expand_content_files)
entries must also be in $(content_files), simplifying people’s makefiles
a little.
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 12:29:27 UTC
Review of attachment 293050 [details] [review]:

Looks good, the EXTRA_DIST was meant as an example.
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 12:30:39 UTC
Review of attachment 293051 [details] [review]:

+100
Comment 7 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 12:31:33 UTC
Review of attachment 293052 [details] [review]:

Thanks!
Comment 8 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 12:31:50 UTC
Review of attachment 293050 [details] [review]:

Looks good, the EXTRA_DIST was meant as an example.
Comment 9 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 12:33:01 UTC
Review of attachment 293053 [details] [review]:

LGTM
Comment 10 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 14:30:41 UTC
The following fixes have been pushed:
7a9ae69 make: Use $(expand_content_files) wherever $(content_files) is used
bea2c36 make: Automatically clean sections.txt if --rebuild-sections is used
0349425 examples: Enable gtk-doc `make check` tests by default
cebfe06 examples: Remove outdated variables from example Makefile.am
Comment 11 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 14:31:02 UTC
Created attachment 293436 [details] [review]
make: Use $(expand_content_files) wherever $(content_files) is used

This means we can eliminate the advice that all $(expand_content_files)
entries must also be in $(content_files), simplifying people’s makefiles
a little.
Comment 12 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 14:31:06 UTC
Created attachment 293437 [details] [review]
make: Automatically clean sections.txt if --rebuild-sections is used

Rather than documenting it in a comment in the example Makefile.am;
might as well automate it.
Comment 13 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 14:31:10 UTC
Created attachment 293438 [details] [review]
examples: Enable gtk-doc `make check` tests by default

Otherwise they never get enabled. If people have problems getting the
tests to pass, they should either fix their documents, or we should make
the tests cleverer.
Comment 14 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-29 14:31:15 UTC
Created attachment 293439 [details] [review]
examples: Remove outdated variables from example Makefile.am

Everyone has automake 1.6 now. Specifying EXTRA_DIST is a bit pointless.