Bug 106171

Summary:	Fix installation of dbus-api-design documentation
Product:	dbus	Reporter:	Simon McVittie <smcv>
Component:	core	Assignee:	Simon McVittie <smcv>
Status:	RESOLVED FIXED	QA Contact:	D-Bus Maintainers <dbus>
Severity:	normal
Priority:	medium	Keywords:	patch
Version:	git master
Hardware:	Other
OS:	All
Whiteboard:	review+
i915 platform:		i915 features:
Attachments:	[1/2] doc: Only install ancillary files from yelp-build if they exist [2/2] doc: Install highlight.pack.js if present

Description Simon McVittie 2018-04-21 18:41:14 UTC

The build system for the API design guidelines makes assumptions about yelp-build behaviour that are no longer true, leading to:

/usr/bin/install -c -m 644 dbus-faq.html dbus-specification.html dbus-test-plan.html dbus-tutorial.html dbus-cleanup-sockets.1.html dbus-daemon.1.html dbus-launch.1.html dbus-monitor.1.html dbus-run-session.1.html dbus-send.1.html dbus-test-tool.1.html dbus-update-activation-environment.1.html dbus-uuidgen.1.html dbus.devhelp dbus-api-design.html yelp.js C.css /home/smcv/src/dbus/doc/jquery.js /home/smcv/src/dbus/doc/jquery.syntax.js /home/smcv/src/dbus/doc/jquery.syntax.brush.html.js /home/smcv/src/dbus/doc/jquery.syntax.core.js /home/smcv/src/dbus/doc/jquery.syntax.layout.yelp.js '/home/smcv/tmp/usr/share/doc/dbus'
/usr/bin/install: cannot stat '/home/smcv/src/dbus/doc/jquery.js': No such file or directory
/usr/bin/install: cannot stat '/home/smcv/src/dbus/doc/jquery.syntax.js': No such file or directory
/usr/bin/install: cannot stat '/home/smcv/src/dbus/doc/jquery.syntax.brush.html.js': No such file or directory
/usr/bin/install: cannot stat '/home/smcv/src/dbus/doc/jquery.syntax.core.js': No such file or directory
/usr/bin/install: cannot stat '/home/smcv/src/dbus/doc/jquery.syntax.layout.yelp.js': No such file or directory
make[2]: *** [Makefile:674: install-htmlDATA] Error 1

Comment 1 Simon McVittie 2018-04-21 18:41:59 UTC

Created attachment 138983 [details] [review]
[1/2] doc: Only install ancillary files from yelp-build if they  exist

Newer versions of yelp-build don't install jquery.

Comment 2 Simon McVittie 2018-04-21 18:42:24 UTC

Created attachment 138984 [details] [review]
[2/2] doc: Install highlight.pack.js if present

Newer versions of yelp-build use this instead of a jQuery syntax
highlighter.

Comment 3 Philip Withnall 2018-04-23 12:34:06 UTC

Comment on attachment 138983 [details] [review]
[1/2] doc: Only install ancillary files from yelp-build if they  exist

Review of attachment 138983 [details] [review]:
-----------------------------------------------------------------

r+. This should work with the old and new versions of yelp-build, so we don’t need to bump our dependency requirements.

Comment 4 Philip Withnall 2018-04-23 12:36:29 UTC

Comment on attachment 138984 [details] [review]
[2/2] doc: Install highlight.pack.js if present

Review of attachment 138984 [details] [review]:
-----------------------------------------------------------------

r+, although I suspect you might want to add it to doc/.gitignore too, since all the jQuery files are listed there too.

Comment 5 Simon McVittie 2018-04-23 16:45:30 UTC

(In reply to Philip Withnall from comment #4)
> r+, although I suspect you might want to add it to doc/.gitignore too

(done)

Comment 6 Simon McVittie 2018-04-23 17:29:22 UTC

Fixed in git for 1.12.8 and 1.13.4.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.