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 719644 - docs: make yelp usage conditional in manual
docs: make yelp usage conditional in manual
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.20
Other All
: Normal normal
: 1.20
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2013-12-01 15:01 UTC by Sebastian Rasmussen
Modified: 2014-01-05 22:09 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Proposed patch to make yelp usage conditional in manual (980 bytes, patch)
2013-12-01 15:01 UTC, Sebastian Rasmussen 		committed Details | Review
docs: make yelp usage conditional in manual (978 bytes, patch)
2013-12-01 16:29 UTC, Stefan Sauer (gstreamer, gtkdoc dev) 		committed Details | Review

Description Sebastian Rasmussen 2013-12-01 15:01:21 UTC 
I didn't have yelp installed on my system when I (after configuring) executed:

make -C help
make: Entering directory `help'
make[1]: Entering directory `help'
make[1]: Nothing to be done for `all-am'.
make[1]: Leaving directory `help'
  GEN      .gitignore
make[1]: Entering directory `help'
make[2]: Entering directory `help/manual'
Makefile:452: *** missing separator.  Stop.
make[2]: Leaving directory `help/manual'
Skipping manual
make[1]: Leaving directory `help'
make: Leaving directory `help'

Even worse, when I tried distclean at the top-level:

make distclean
Making distclean in help
make[1]: Entering directory `help'
Making distclean in manual
make[2]: Entering directory `help/manual'
Makefile:452: *** missing separator.  Stop.
make[2]: Leaving directory `help/manual'
make[1]: *** [distclean-recursive] Error 1
make[1]: Leaving directory `help'
make: *** [distclean-recursive] Error 1

The attached patch resolves this issue by making the yelp usage in help/manual/Makefile.am conditional on whether yelp is available or not.
Comment 1 Sebastian Rasmussen 2013-12-01 15:01:56 UTC 
Created attachment 263237 [details] [review]
Proposed patch to make yelp usage conditional in manual
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2013-12-01 16:29:42 UTC 
The following fix has been pushed:
5a06d25 docs: make yelp usage conditional in manual
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2013-12-01 16:29:48 UTC 
Created attachment 263240 [details] [review]
docs: make yelp usage conditional in manual

The help/manual directory will be recursed into (so make dist can
include everything) even if not in SUBDIRS in help/Makefile.am. Because
of this help/manual/Makefile.am is always used to generate the
help/manual/Makefile. And so if help/manual/Makefile.am includes
unconditional yelp usage then help/manual/Makefile will also include
yelp usage, even if yelp is not available.

Fixes