LUDOC-11 Misc cleanups of examples and text

Clean up some examples seen in the manual while working on LUDOC-14.

Use "ost0" and "ost1" in examples, to match the actual OST indices
used, instead of "ost1" and "ost2".  Same for "oss0" and "oss1", etc.

Use "lctl {get,set}_param" instead of direct /proc access in a few
places (there are a lot more that should be fixed).

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ibeb4e3318b6fbdb8a81283d5cfad14a69e27443b

LUDOC-14 Always use --index when formatting OSTs

To prepare users for changes that are upcoming in Lustre 2.3/2.4 for
the OSD restructuring project, the OST index should always be given
when formatting OSTs with mkfs.lustre.  This is already accepted as
standard practice for Lustre users today, so reflect that in the
examples in the manual.

Change-Id: I41cc175dc4392950c4376b3643c3017f6b9b2fcc
Signed-off-by: Andreas Dilger <adilger@whamcloud.com>

Merge "LUDOC-16 fix stale links."

LUDOC-16 fix stale links.

Links now point to accurate and actively maintained targets.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I3212ac2fb807108ca046b06ebfa7842474449127

Merge "LUDOC-13 render diff of html manual to enhance reviewability."

LUDOC-13 render diff of html manual to enhance reviewability.

Reviewing manual changes is challenging when only observing docbook
xml. This change provides code (./tools/diff.py) and a 'diff' make
target to generate a html page with annotated differences. An
example screenshot is attached to LUDOC-13.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: Ib19bae429235f9bf2b2b8d15a597baac8f12cc6e

LUDOC-11 debug: Fix malformed sentence

Fix incompletely edited sentence after review from Richard.

Change-Id: Ic9436d791104efec5c18d3ee5f2a36c7b859cf23
Signed-off-by: Andreas Dilger <adilger@whamcloud.com>

LUDOC-11 Minor improvements to debugging chapter

Fix formatting consistency of the debugging chapter.

Add a number of debug macros that were not being listed, and
improve the description and formatting of some others.

Update sample output to be consistent with what is generated
by modern Lustre tools.

Change-Id: Ie1276e49c784ccc6ee23c5609b996baa4ad57173
Signed-off-by: Andreas Dilger <adilger@whamcloud.com>

LUDOC-11 cleanups to Lustre limits table

The Lustre limits table was outdated in a few places, and not organized
in a logical manner.  Consolidate the table and update to latest values,
and remove unknown characters in table.

Clarify some of the Lustre feature descriptions in this section.

Change-Id: I4ee903ccc8446f1c32e456bc6535e1af09e39379
Signed-off-by: Andreas Dilger <adilger@whamcloud.com>

Merge "LUDOC-6 Add Makefile with check, pdf, html targets"

LUDOC-6 Add Makefile with check, pdf, html targets

Add a Makefile which will, by default, check the XML of the manual
for structural errors, or build a .html or .pdf version of the
Lustre manual.

It checks for Docbook style sheets on both Linux and MacOS.

Change-Id: I1583a0849ef14299a3df37328f4acc2a55a00fac
Signed-off-by: Andreas Dilger <adilger@whamcloud.com>

LUDOC-6 Add Makefile with check, pdf, html targets

Add a Makefile which will, by default, check the XML of the manual
for structural errors, or build a .html or .pdf version of the
Lustre manual.

It checks for Docbook style sheets on both Linux and MacOS.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>

LUDOC-7 cleanups to Lustre limits table

The Lustre limits table was outdated in a few places, and not organized
in a logical manner.  Consolidate the table and update to latest values,
and remove unknown characters in table.

Clarify some of the Lustre feature descriptions in this section.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>

Merge "LUDOC-5 fixed legal notice for Whamcloud modifications."

LUDOC-5 fixed legal notice for Whamcloud modifications.

Following legal advice, this change adds context for modifications from
Whamcloud to be admitted into this CC 3.0 licensed document. Docbook includes
copyright and legalnotice elements and these have been used. The copyright
notice that was previously in the Oracle legalnotice has been moved to a
copyright element.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I0b1584e8474a390136c052145aef5f2ba695c65a

FIX: improved formating of an example.

FIX: list items correctly grouped.

FIX: over-streatched image.

FIX: tidyup the copyright notice.

FIX: minor tweaks to the improve figures and revision info.

FIX: corrected linking of documents.

ADD: images for figures.

FIX: refactored to include legal notice.

FIX: added index.

FIX: typesetting

FIX: typesetting

FIX: typesetting

FIX: validation

FIX: validation, ulink -> link

FIX: validation, ulink -> link

FIX: validation, ulink -> link

FIX: validation, ulink -> link

FIX: validation, ulink -> link

FIX: validation, ulink -> link

FIX: validation, ulink -> link

FIX: validation

FIX: validation

FIX: validation

FIX: validation

FIX: proofed against origional

FIX: proofed against origional

FIX: proofed against origional

FIX: removed redundant anchors

FIX: removed redundant anchors

FIX: removed funny characters.

FIX: proof read against origional

FIX: proof read against origional

FIX: proof read against origional

FIX: proof read against origional

FIX: xrefs

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: article converted to chapter.

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: refactor part

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: refactor part

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: xrefs and tidying

FIX: refactor part

FIX: xrefs and tidying

FIX: xrefs

FIX: patched on additional missed content

FIX: patched on additional missed content

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: refactored

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: refactored part

FIX: xrefs

FIX: xrefs

FIX: xrefs

FIX: moved xincludes into main file

FIX: update xrefs and figures

FIX: part correctly references chapters.

FIX: converted to glossary and removed cruft

FIX: converted to chapter and removed cruft

FIX: converted to chapter and removed cruft

FIX: converted to chapter and removed cruft

FIX: converted to chapter and removed cruft

FIX: converted to chapter and removed cruft

FIX: converted to chapter and removed cruft

FIX: converted to chapter and removed cruft