Bug 30618

Summary: Replace defunct update-dbus-docs.sh with makefile rules
Product: dbus Reporter: Will Thompson <will>
Component: coreAssignee: Rob Taylor <rob.taylor>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: medium CC: christian
Version: unspecifiedKeywords: patch
Hardware: Other   
OS: All   
URL: http://git.collabora.co.uk/?p=user/wjt/dbus.git;a=shortlog;h=refs/heads/documentation-build-system
Whiteboard:
i915 platform: i915 features:
Attachments: Use Automake 1.11, if available, for silent rules
Squash warnings and spurious output from autogen.sh
Silence silent build a bit more.
Update a load of .gitignores
Build Doxygen documentation for `make all`.
Move manpages to doc/
Report correct result of doxygen/xml doc checks
Integrate building HTML-ified manpages with the build system
Move uploading docs into build system.

Description Will Thompson 2010-10-05 03:49:03 UTC
update-dbus-docs.sh supposedly uploaded the various bits of documentation to the web, but hasn't worked for ages. I integrated building and uploading the documentation with the build system, so now one should be able to run:

  % make maintainer-upload-docs

to push the latest version of the specification, API documentation, etc. to dbus.freedesktop.org. It worked for me when I tried it a few weeks ago. :)
Comment 1 Will Thompson 2010-10-05 03:50:34 UTC
Created attachment 39170 [details] [review]
Use Automake 1.11, if available, for silent rules

Automake 1.11 adds support for silent rules, which are conditionally
enabled in configure.in if available.

Also, previously it was impossible to override the version chosen by
this script; this patch makes that possible.
Comment 2 Will Thompson 2010-10-05 03:50:39 UTC
Created attachment 39171 [details] [review]
Squash warnings and spurious output from autogen.sh
Comment 3 Will Thompson 2010-10-05 03:50:44 UTC
Created attachment 39172 [details] [review]
Silence silent build a bit more.
Comment 4 Will Thompson 2010-10-05 03:50:48 UTC
Created attachment 39173 [details] [review]
Update a load of .gitignores
Comment 5 Will Thompson 2010-10-05 03:50:52 UTC
Created attachment 39174 [details] [review]
Build Doxygen documentation for `make all`.

This depends on GNU Make for the wildcard dependency on all the source
files in dbus/. If anyone objects very strongly to this, I'd welcome
suggestions of a more portable way to do this.
Comment 6 Will Thompson 2010-10-05 03:50:55 UTC
Created attachment 39175 [details] [review]
Move manpages to doc/

This will make integrating the building of HTML versions of these
manpages into the build system way easier, at the cost of keeping
manpages in a different directory to the source for the program they
describe. I think this is an acceptable trade-off.
Comment 7 Will Thompson 2010-10-05 03:50:59 UTC
Created attachment 39176 [details] [review]
Report correct result of doxygen/xml doc checks

Previously the configure output always said these were enabled during
the 'Checking for...' stage, even if they weren't. The summary at the
end of configure was correct, though.
Comment 8 Will Thompson 2010-10-05 03:51:02 UTC
Created attachment 39177 [details] [review]
Integrate building HTML-ified manpages with the build system
Comment 9 Will Thompson 2010-10-05 03:51:07 UTC
Created attachment 39178 [details] [review]
Move uploading docs into build system.

This uploads a doc tarball, and its contents, to the appropriate
location on dbus.freedesktop.org. It also uploads the DTDs to the
appropriate location on specifications.freedesktop.org.

I believe this uploads the same files as the old update-dbus-docs.sh
script did.
Comment 10 Will Thompson 2010-10-05 04:57:05 UTC
Christian Dywan had the following to say on IRC:

 <kalikiana> might be nice to check if scp actually succeeded, though the old script didn't either
Comment 11 Will Thompson 2010-10-26 09:12:45 UTC
(In reply to comment #10)
> Christian Dywan had the following to say on IRC:
> 
>  <kalikiana> might be nice to check if scp actually succeeded, though the old
> script didn't either

Ah, we get that for free of course, because it's a Makefile. So I'm going to ship this. Thanks for the review!

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.