From e690ead9cf486221b193171347d07abca64c9cef Mon Sep 17 00:00:00 2001 From: Richard Henwood Date: Wed, 26 Dec 2012 15:01:43 -0600 Subject: [PATCH] LUDOC-104: Design elements to highlight lustre specific features. The Docbook 5 standard allows for a condition attribute to all elements. By setting this condition with the value of l23 or l24 passages of the manual that are specific to version of Lustre can be marked up. This change adds an annotation against elements that have the condition attribute set. Graphics are rendered in-line at the relevant point in the text and against the relevant entries in the table of contents. 'condition' annotations to two existing lustre specific sections of the to demonstrate this new design feature. The document design elements are displayed similarly across epub, html, xhtml and pdf renderings of the manual. Signed-off-by: Richard Henwood Change-Id: Idd2cb762e219204bfc63c9ed81ccedd49b2c43ac Reviewed-on: http://review.whamcloud.com/4611 Tested-by: Hudson --- BackupAndRestore.xml | 2 +- ConfiguringLustre.xml | 2 +- LustreTuning.xml | 2 +- Makefile | 22 +++++---- style/customstyle.xsl | 120 ++++++++++++++++++++++++++++++++++++++++++++++ style/customstyle_fo.xsl | 122 +++++++++++++++++++++++++++++++++++++++++++++++ style/manual.css | 20 ++++++++ 7 files changed, 279 insertions(+), 11 deletions(-) create mode 100644 style/customstyle.xsl create mode 100644 style/customstyle_fo.xsl create mode 100644 style/manual.css diff --git a/BackupAndRestore.xml b/BackupAndRestore.xml index 0724bd9..9de0266 100644 --- a/BackupAndRestore.xml +++ b/BackupAndRestore.xml @@ -193,7 +193,7 @@ Changelog records consumed: 42 Keeping an updated full backup of the MDT is especially important because a permanent failure of the MDT file system renders the much larger amount of data in all the OSTs largely inaccessible and unusable. - + In Lustre 2.0 through 2.2, the only successful way to backup and restore an MDT is to do a device-level backup as is described in this section. File-level restore of an MDT is not possible before Lustre 2.3, as the Object Index (OI) file cannot be rebuilt after restore without the OI Scrub functionality. Since Lustre 2.3, Object Index files are automatically rebuilt at first mount after a restore is detected (see LU-957), and file-level backup is supported (see ). If hardware replacement is the reason for the backup or if a spare storage device is available, it is possible to do a raw copy of the MDT or OST from one block device to the other, as long as the new device is at least as large as the original device. To do this, run: diff --git a/ConfiguringLustre.xml b/ConfiguringLustre.xml index 6d4d443..68e1783 100644 --- a/ConfiguringLustre.xml +++ b/ConfiguringLustre.xml @@ -61,7 +61,7 @@ See for more details. - + Optional for Lustre 2.4 and later. Add in additional MDTs. mkfs.lustre --fsname=fsname --mgsnode=nid --mdt --index=1 /dev/block_device Up to 4095 additional MDTs can be added. diff --git a/LustreTuning.xml b/LustreTuning.xml index d9eb216..0b5bd3c 100644 --- a/LustreTuning.xml +++ b/LustreTuning.xml @@ -105,7 +105,7 @@ Default values for the thread counts are automatically selected. The values are chosen to best exploit the number of CPUs present in the system and to provide best overall performance for typical workloads. -
+
<indexterm><primary>tuning</primary><secondary>MDS binding</secondary></indexterm>Binding MDS Service Thread to CPU Partitions With the introduction of Node Affinity () in Lustre 2.3, MDS threads can be bound to particular CPU Partitions (CPTs). Default values for bindings are selected automatically to provide good overall performance for a given CPU count. However, an administrator can deviate from these setting if they choose. diff --git a/Makefile b/Makefile index 7570a8a..a9571b1 100644 --- a/Makefile +++ b/Makefile @@ -25,6 +25,7 @@ XSL=$(or $(shell ls -d $(XSL_UBN) 2> /dev/null), \ $(shell ls -d $(XSL_REL) 2> /dev/null), \ $(shell ls -d $(XSL_F16) 2> /dev/null), \ $(shell ls -d $(XSL_MAC) 2> /dev/null)) +PRIMARYXSL=$(XSL)/$(subst $(TGT_BASE).,,$@)/docbook.xsl .PHONY: all all: clean check xhtml html pdf epub @@ -34,13 +35,16 @@ check: $(SRC_XML) xmllint --noout --xinclude --noent --relaxng $(RNG) ./index.xml # Note: can't use "suffix" instead of "subst", because it keeps the '.' -$(TGT_BASE).html $(TGT_BASE).xhtml $(TGT_BASE).epub $(TGT_BASE).fo: $(SRCS) - xsltproc --stringparam fop1.extensions 1 \ - --stringparam section.label.includes.component.label 1 \ - --stringparam section.autolabel 1 \ - --stringparam chapter.autolabel 1 \ - --stringparam appendix.autolabel 1 \ - --xinclude -o $@ $(XSL)/$(subst $(TGT_BASE).,,$@)/docbook.xsl ./index.xml +# Note: xsl:import is resolved at compile time, so the primary xsl +# is substituted into the custom xsl with sed before compliation. +$(TGT_BASE).html $(TGT_BASE).xhtml $(TGT_BASE).epub: $(SRCS) + sed -e 's;PRIMARYXSL;${PRIMARYXSL};' ./style/customstyle.xsl | \ + xsltproc --xinclude -o $@ - ./index.xml + +$(TGT_BASE).fo: $(SRCS) + sed -e 's;PRIMARYXSL;${PRIMARYXSL};' ./style/customstyle_fo.xsl | \ + xsltproc --xinclude -o $@ - ./index.xml + $(TGT_BASE).pdf: $(TGT_BASE).fo fop $< $@ @@ -58,6 +62,8 @@ pdf: $(TGT_BASE).pdf epub: $(TGT_BASE).epub echo "application/epub+zip" > mimetype cp -r ./figures ./OEBPS/ + mkdir ./OEBPS/style + cp ./style/manual.css ./OEBPS/style/ zip -0Xq $(TGT_BASE).epub mimetype zip -Xr9D $(TGT_BASE).epub OEBPS/* zip -Xr9D $(TGT_BASE).epub META-INF/* @@ -90,5 +96,5 @@ push: clean: rm -f $(TGT_BASE).html $(TGT_BASE).xhtml $(TGT_BASE).pdf\ mastermanual.revision mastermanual.index mimetype\ - $(TGT_BASE).diff.html $(TGT_BASE).epub + $(TGT_BASE).diff.html $(TGT_BASE).epub $(TGT_BASE).fo rm -rf ./META-INF ./OEBPS diff --git a/style/customstyle.xsl b/style/customstyle.xsl new file mode 100644 index 0000000..77c5576 --- /dev/null +++ b/style/customstyle.xsl @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + L 2.4 + + + L 2.3 + + + + diff --git a/style/customstyle_fo.xsl b/style/customstyle_fo.xsl new file mode 100644 index 0000000..aeee0c0 --- /dev/null +++ b/style/customstyle_fo.xsl @@ -0,0 +1,122 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + L 2.3 + L 2.4 + + + + + + + + + + + + bold + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/style/manual.css b/style/manual.css new file mode 100644 index 0000000..3082a88 --- /dev/null +++ b/style/manual.css @@ -0,0 +1,20 @@ +pre.programlisting, pre.screen +{ background-color: #e0e0e0; + padding: 5px; +} + +span.versionlabel { + display: inline-block; + position: relative; + top: -10px; + left: 10px; + background-color: white; + border: 1px solid gray; +} +div.versioncontent { + border: 1px solid gray; +} + +span.floatright { + float: right; +} -- 1.8.3.1