jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-19 07:20:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
829e484371
openafs/doc/xml/AdminRef/Makefile.in

47 lines
1.4 KiB
Makefile
Raw Normal View History

doc: generate admin ref from the pod documentation 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>
2011-08-13 15:18:45 +01:00
# Makefile to build the AFS Reference Guide for Unix.
BOOK = auarf000
all: $(BOOK).pdf $(BOOK).epub $(BOOK).mobi
include @TOP_OBJDIR@/src/config/Makefile.config
VERSION=version
include @TOP_OBJDIR@/src/config/Makefile.version
SRCS = $(BOOK).xml preface.xml $(VERSION).xml \
doc: Add section 3 man pages to AdminRef 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>
2024-08-08 18:57:05 +01:00
entities.dtd sect1.xml sect3.xml sect5.xml sect8.xml
doc: generate admin ref from the pod documentation 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>
2011-08-13 15:18:45 +01:00
DOCBOOK_STYLESHEETS = @DOCBOOK_STYLESHEETS@
doc: set use.id.as.filename for chunk.xsl 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>
2016-02-13 19:02:55 +00:00
XSLTPROC = @XSLTPROC@ --stringparam variablelist.as.blocks 1 --param use.id.as.filename 1
doc: generate admin ref from the pod documentation 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>
2011-08-13 15:18:45 +01:00
DOCBOOK2PDF = @DOCBOOK2PDF@
DBTOEPUB = $(DOCBOOK_STYLESHEETS)/epub/bin/dbtoepub
doc: fix kindle builds of documentation 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>
2012-09-24 00:02:19 +01:00
KINDLEGEN = @KINDLEGEN@
doc: generate admin ref from the pod documentation 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>
2011-08-13 15:18:45 +01:00
doc: Add section 3 man pages to AdminRef 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>
2024-08-08 18:57:05 +01:00
entities.dtd sect1.xml sect3.xml sect5.xml sect8.xml:
doc: generate admin ref from the pod documentation 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>
2011-08-13 15:18:45 +01:00
./generate-xml.pl $(TOP_SRCDIR)
$(BOOK).pdf: $(SRCS)
if test "x$(DOCBOOK2PDF)" = "xfop"; then \
$(XSLTPROC) $(DOCBOOK_STYLESHEETS)/fo/docbook.xsl $(BOOK).xml > $(BOOK).fo; \
$(DOCBOOK2PDF) $(BOOK).fo $(BOOK).pdf; \
else \
$(DOCBOOK2PDF) $(BOOK).xml; \
fi
$(BOOK).epub: $(SRCS)
if test -x "$(DBTOEPUB)" ; then \
$(DBTOEPUB) -s $(TOP_SRCDIR)/../doc/xml/mobi-fixup.xsl $(BOOK).xml; \
fi
$(BOOK).mobi: $(BOOK).epub
doc: fix kindle builds of documentation 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>
2012-09-24 00:02:19 +01:00
if test -n "$(KINDLEGEN)" && test -x "$(DBTOEPUB)" ; then \
$(KINDLEGEN) $(BOOK).epub -o $(BOOK).mobi; \
fi
doc: generate admin ref from the pod documentation 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>
2011-08-13 15:18:45 +01:00
check:
xmllint --noout --valid $(BOOK).xml
clean:
rm -f $(BOOK).pdf $(BOOK).mobi $(BOOK).epub $(BOOK).fo \
doc: Add section 3 man pages to AdminRef 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>
2024-08-08 18:57:05 +01:00
entities.dtd sect1.xml sect3.xml sect5.xml sect8.xml $(VERSION).xml
rm -rf sect1 sect3 sect5 sect8
Reference in New Issue Copy Permalink