Fix various issues so that building the documentation in doc/xml works
for objdir builds:
- set srcdir=@srcdir@ like all other Makefile's, so VPATH is set
correctly via Makefile.config
- Pass "--path '@abs_builddir@'" to all xml/xsl processors, so they
can find the generated version.xml (otherwise they only look in
srcdir)
- Pass --output when building PDFs, so the generated PDF doesn't go in
srcdir
- Specify $(srcdir) for $(BOOK).xml and generate-xml.pl
- Change generate-xml.pl to find pod2refentry in srcdir instead of '.'
Change-Id: Id09595dba6e70e3d367a26e279446844750d1fd4
Reviewed-on: https://gerrit.openafs.org/15856
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Tested-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: Cheyenne Wills <cwills@sinenomine.net>
The section 3 man pages are missing in the AdminRef document, so add
section 3 to the Makefile and perl script which generates the AdminRef
doc.
Currently, the only man page in section 3 is the AFS::ukernel, so only
one page is missing.
Change-Id: I3c7401f2eeafa505b9de4545b9d9c4b5cfd617e2
Reviewed-on: https://gerrit.openafs.org/15828
Reviewed-by: Cheyenne Wills <cwills@sinenomine.net>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
The AdminRef is a collection of OpenAFS man pages in a single document.
Unfortunately, the man pages are not listed in any particular order, but
rather just the order found by reading the unsorted directory entries.
Change the generate-xml script so the man pages are in sorted order in
the generated AdminRef document. Instead of writing the man page
references after processing each page, save each entry in a list, and
then sort the list after all the pages have been processed.
Also, check the exit code of the pod2refentry script so errors are not
ignored while generating the AdminRef document.
Change-Id: I624485e4efd1fb0c08642b379a12c946f5793336
Reviewed-on: https://gerrit.openafs.org/15827
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Cheyenne Wills <cwills@sinenomine.net>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
The deployed documentation on docs.openafs.org uses html file names
that match the id element for the XML elements in question. On
recent Debian systems, rebuilding these documents uses different
names for the files, based on their position within the document
hierarchy.
For consistency with past usage, and to avoid breaking direct links
when possible, set the xsl parameter use.id.as.filename to go back
to the old naming scheme.
Change-Id: I6d3fa2b74e319d1375891170817760d027e82f03
Reviewed-on: https://gerrit.openafs.org/12189
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: Benjamin Kaduk <kaduk@mit.edu>
Use kindlegen located by the configure stage and test for
kindlegen and dbtoepub before building in all cases.
Change-Id: Ieb46023ddf0725a2c93f96e29f942b71343d53dd
Reviewed-on: http://gerrit.openafs.org/8148
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@your-file-system.com>
Reviewed-by: Ken Dreyer <ktdreyer@ktdreyer.com>
a bit convoluted but this generates docbook from the pod documentation and
from that pdf, epub and mobi versions. we are using variablelist.as.block
since that looks prettier on smaller devices/screen.
Change-Id: I5cd51ef10448373960a0aeed15212bbcf6f44039
Change-Id: Ib222dbfa30e3af644b1dbc6738df1d39cc33c92f
Reviewed-on: http://gerrit.openafs.org/5255
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementix.org>
