LUDOC-130 fix: improvements for accuracy.

This patch updates LUDOC-130 work to enhance accuracy.
The improvments implemented in the patch were provided against a
recently landed patch http://review.whamcloud.com/#/c/6608/

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I1fc7c5b1a71fe293b5308b1ba61c4e5151494222
Reviewed-on: http://review.whamcloud.com/7511
Tested-by: Hudson

LUDOC-73 bugfix: Removed text describing obsolete lfs df -i behavior

Deleted outdated text from Section 18.5.1. Checking File System Free Space

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I0f7036f0313f8c468abacd2eba9efc24a04f3f45
Reviewed-on: http://review.whamcloud.com/7587
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-65 bugfix: Added workaround needed for setting quotas.

Also, split section 25.1 into two subsections, one addressing the 2.4+ solution
and one addressing pre-2.4 releases (including workaround). Added l24 condition
to 2.4 section.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I01fd4ab846fb788cbeb10d6f34a360c0769e184e
Reviewed-on: http://review.whamcloud.com/7540
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-64 bugfix: Changed path2fid to fid2path

In Section 13.14, corrected Step 2 describing how to look up FID on MDS.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I3aefa3426e87759994424aec13b4cd5fed08aac8
Reviewed-on: http://review.whamcloud.com/7465
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Hudson

LUDOC-61 bugfix: Added note to lfs setstripe about inactive OSTs.

Added a note describing what happens if lfs setstripe specifies
a start OST that is inactive or degraded.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I068f0636acdadd22a6984d33f2c61c8b5d418473
Reviewed-on: http://review.whamcloud.com/7471
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-166 mgs: Document new "lctl set_param -P" option

The new "lctl set_param -P" syntax for setting permanent
configuration parameters in LU-3155 needs to be added to
the Lustre manual.

Xyratex-bug-id: MRP-272
Signed-off-by: Artem Blagodarenko <artem_blagodarenko@xyratex.com>
Change-Id: I44d89d1219ed865d87368ef958a9f5aa207db49e
Reviewed-on: http://review.whamcloud.com/7458
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-130 install-progrIF: Updated install procedures. Also LUDOC-116,158.

Updates to Chapter 8 (Installing from RPMs), new content
in Chapter 29 (Installing from source), updates to Chapter 33
(Programming Interfaces), new content in Chapter 16 (Upgrading).
All of these chapters are interconnected by cross-references to
target text that required editing.  Since Ch 33 was being edited,
it was updated with changes unrelated to installation as well.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I4e2f696d043979cb4a490bd3af376bf894e784b1
Reviewed-on: http://review.whamcloud.com/6608
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-45 bugfixes: Changed iokit script names from *_survey to *-survey

Fixed iokit script names in Ch 10, Ch 24, and Ch 36.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I41e77b06c18c8a141121b92e93f31214d85b1127
Reviewed-on: http://review.whamcloud.com/7474
Tested-by: Hudson
Reviewed-by: Minh Diep <minh.diep@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-177 bug: manual now builds again.

A recent commit broke the manual. A bug in the custom
transforms means you can't apply a 'condition' to an orderedlist.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Id4d18510e6304b410fafc953c6c9d1fe2a0134b2
Reviewed-on: http://review.whamcloud.com/7455
Tested-by: Hudson

LUDOC-168 proc: Reworked Ch 31: LustreProc

Reorganized and updated Chapter 31.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ifebf0a24aaafc5b6a0b603f2062edf06c08ed19e
Reviewed-on: http://review.whamcloud.com/7362
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-102 format-options: Fixed inode ratio description. Also addressed LUDOC-49.

Updated section 5.3 content about setting file system formatting options.
Removed obsolete note. Changed chapter title.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ib4368708c23d50c750c208a81d32294425a3fb2f
Reviewed-on: http://review.whamcloud.com/6847
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Keith Mannthey <keith.mannthey@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-159 extents-glossary: Glossary updated. Extents definition added.

Glossary entries have been updated and edited and trademark compliance completed.
A definition for extents has been added.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I298a9a08dc7dc7a5d30532c26e456ea458b167a4
Reviewed-on: http://review.whamcloud.com/6990
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>

LUDOC-154 striping: Updated Ch 18. Also fixes LUDOC-132.

Updated Ch 18: Managing File Striping and Free Space.
Added wide striping content. Corrected content in
Ch 31: LustreProc.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I9978788c7970e6c231148c63eddc0a8bd08b3317
Reviewed-on: http://review.whamcloud.com/7042
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Hudson

LUDOC-144 LustreProc:  Also LUDOC-143. Bug fixes and formatting.

Updated content, corrected errors, fixed mis-aligned tables.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I258df4809026ac6e53b95205eb8a1da869d6af58
Reviewed-on: http://review.whamcloud.com/6941
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-119 build: chunked html output directory.

The chunked-html output goes into a suitabably named
directory.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I1e7c431c22c27cd24ef0d992adaa215e3724301d
Reviewed-on: http://review.whamcloud.com/6943
Tested-by: Hudson
Reviewed-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>

LUDOC-119: Segment HTML version of Lustre manual

Change of the Lustre documentation Makefile.
The new created rule "chunked-html" allows
to divide the manual into sections. Output files
are created under the directory ./{$TGT_BASE}.

Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Change-Id: I195ac7cdb52591b262934dcba7bb8602ec41adc9
Reviewed-on: http://review.whamcloud.com/5834
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-147 lnet: Describe routes config in Manual

Describe how to dynamically configure LNET routes using the two new
scripts which were added: luster_routes_config and
lustre_routes_conversion.
Sections 15.5 was added in the Lustre Manual.

LU-2950 tracks the change which landed to provide the
above functionality.

Signed-off-by: Amir Shehata <amir.shehata@intel.com>
Change-Id: I3974286bce9d726abd12a5deb568740bca4544aa
Reviewed-on: http://review.whamcloud.com/6538
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>

LUDOC-12 intro: add Windows and Mac OS X

Allow searching for Windows and MacOS in the manual, so that users can
at least get a starting point.  Support for multiple OSs needs its own
section.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I1a7c26ec25e06f88e7c52f19a4df889152f2d1cd
Reviewed-on: http://review.whamcloud.com/6133
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-146 benchmark: water-down obdfilter-survey warning.

The obdfilter-survey uses a different object sequence (2) compared to
normal filesystem objects (currently always 0), so the two do not
collide.

The manual now indicates that obdfilter-survey may not destroy
production data. A brief description of the object sequence difference
between obdfilter_survey and normal objects is included.

The task to provide evidence to reduce the vagueness of this warning
is LU-3444.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Iac5fd3d9a89906dd04290ab62b2cff43ece29e53
Reviewed-on: http://review.whamcloud.com/6416
Tested-by: Hudson

LUDOC-19 bug: Updated Reporting Lustre Bug section

Updated procedure with new content and several links.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I2aed9e4cbbcd6e7a26f1c516c6f40ae538035e6d
Reviewed-on: http://review.whamcloud.com/6545
Tested-by: Hudson
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-74 bug: Fixed dd option.

Added conv=notrunc

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I0b3a802b41e16dbca167b1e4b5584c333f40d7e5
Reviewed-on: http://review.whamcloud.com/6581
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-151 quota: wrong least inode qunit

The least inode qunit is 1024 but not 1000.

Signed-off-by: Niu Yawei <yawei.niu@intel.com>
Change-Id: Ia54a82c9c0143468a350567af3ccaf0b6a7395a5
Reviewed-on: http://review.whamcloud.com/6455
Tested-by: Hudson
Reviewed-by: Johann Lombardi <johann.lombardi@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-109: Added scheduler default and recommendations.

Added note about scheduler default (deadline)
and recommendations (deadline, noop).

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I8cd1e3d9e547b28ccf87274b3d1737762c8fc21f
Reviewed-on: http://review.whamcloud.com/6486
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-140 Add contents info to pdf edition

Enable a "fop1.extensions" in order to show
bookmarks in a pdf version of the manual.

Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Change-Id: I07a55d227ebf169587ef6671eddb633b1cbdb1f4
Reviewed-on: http://review.whamcloud.com/6008
Tested-by: Hudson
Reviewed-by: Nathaniel Clark <nathaniel.l.clark@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-118 trademarks: trademark policy must be applied.

A trademark compliance review was completed on the opening content and
Section 1: Lustre Intro and a few additional minor edits were made.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Iaedab4e3d1b4f53e2d0d6c35171c4b270d37b909
Reviewed-on: http://review.whamcloud.com/6303
Tested-by: Hudson

LUDOC-117 cleanup: minor changes to wording and markup.

Minor changes to add clarify.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Ic5c8c6cf23d9779c0d1ad7a5cb702a179f9dca0b
Reviewed-on: http://review.whamcloud.com/6218
Tested-by: Hudson
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>

LUDOC-79 ptlrpc: Add NRS documentation

This patch adds a description of NRS changes added to Lustre from
LU-398, including policies and their tunables.

Signed-off-by: Nikitas Angelinas <nikitas_angelinas@xyratex.com>
Change-Id: I87de8c3d63d84a23215a5375384462a3429bcbab
Oracle-bug-id: b=13634
Xyratex-bug-id: MRP-73
Reviewed-on: http://review.whamcloud.com/5848
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-80: 4MB RPC Doc Changes

Reflect changes introduced in LU-1431 in the Lustre manual:
maximum value of max_pages_per_rpc is now 1024.

Change-Id: I0a2e5c6c94f99f5380200cfc1e856f4f2e3d2585
Signed-off-by: Sergii Glushchenko <sergii_glushchenko@xyratex.com>
Xyratex-bug-id: MRP-319
Reviewed-on: http://review.whamcloud.com/5534
Tested-by: Hudson
Reviewed-by: Oleg Drokin <oleg.drokin@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-117 cleanup: minor changes to wording and cleanup.

Minor wording changes to add clarity.

Reviewed position of replaceable markup tags.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: If0be703ac384d468cd56262fa3dd789209d009be
Reviewed-on: http://review.whamcloud.com/4974
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>

LUDOC-28 llapi: clean up sample code

Clean up the examples for using the lustreapi interfaces.

This code is updated following fixes for the client API which
are tracked against LU-1606.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I87f8f5a5d7f7f4792e088b45863b6656391525e9
Reviewed-on: http://review.whamcloud.com/1879
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-11 cleanup: cleanups of examples and text

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

When the --index parameter is passed to mkfs.lustre, it will already
assign an OST or MDT index, so OSTffff will not be in the output.

Clean up the example for multiple NIDs to remove the use of the old
elan network type.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Ibe1068d66627e72a88c2584f413d2c40df99cab0
Reviewed-on: http://review.whamcloud.com/2181
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-11: Removed Serna note.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I2f66d7239769822dec401ecc518bf03631867825
Reviewed-on: http://review.whamcloud.com/6118
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-11 typos: Correct assorted minor errors

Correct the following errors:
Section 8.1.1.2 Changed "utilities are must be" to "utilities must be"
Section 9.1 Changed text formatting of "networks" to match "ip2nets"
Section 9.1 Changed text formatting of "routes" to match "networks"
and "ip2nets" in the same section
Section 10.1 Changed "and MGS" to "an MGS"
Section 10.1 Changed "simplify the translating" to "simplify
translating"
Section 26.1.2 Extended text formatting to the end of the line
"Lustre logs are dumped to /proc/sys/lnet/debug_path"
Section 30.6 Changed "will still be notified reconnect" to "will
still be notified to reconnect"
Section 30.6 Changed "the last the non-IR client" to "the last non-IR
client"

Signed-off-by: James Nunez <james.a.nunez@intel.com>
Change-Id: I0148156245452e231a15fa1f863830b6df30e8bc
Reviewed-on: http://review.whamcloud.com/5976
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-126 startup: component start-up order.

Component startup order is now correct.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I3b9f24323c539d042858e98a1566ce1fadee0748
Reviewed-on: http://review.whamcloud.com/5645
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>
Reviewed-by: Cory Spitz <spitzcor@cray.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-85 enhance: new LFSCK options are now documented.

LFSCK has added significant functionality in the recent release. The
manual now makes a clear distinction which version of lustre supports
the various lfsck options.

LFSCK namespace is now included and documented.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Iff0ff5b696b8a55fefedfcfe78031e28c2a93749
Reviewed-on: http://review.whamcloud.com/5801
Tested-by: Hudson
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>

LUDOC-11 typos: minor cleanup of text.

Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Change-Id: I6047faadbead0e81c7c0dd94ec3ef2cd94e109ca
Reviewed-on: http://review.whamcloud.com/5853
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-104 style: added style elements for 2.1, 2.2 and 2.5

Style rules now support condition='{l21|l22|l23|l24|l25}'.
Code refactored for simplicity.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I2ef60e50f390b566a2193a0114bfbac3aee54979
Reviewed-on: http://review.whamcloud.com/5753
Tested-by: Hudson

LUDOC-129:  Corrected dircount language

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ifea277ebb4199db5abde7b37d4638d1e8c38604e
Reviewed-on: http://review.whamcloud.com/5788
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-70: Small editing changes

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>

LUDOC-128 build: commit hooks

Commit hooks help commit messages conform to best practice. These
hooks are copied from the Lustre code commit hooks. Modified to make
them specific to the Manual.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I407644562011fe66ace0e34667f67f04b9d58070
Reviewed-on: http://review.whamcloud.com/5646
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-34 remove modules with 'lustre_rmmod'

Use "lustre_rmmod" instead of
"lctl modules | awk '{print $2}' | xargs rmmod" to remove modules.
(Corrected tip in section 15.2.2)

Change-Id: I833f83a85e87d00427ed41180e0db6fa51074d2d
Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Reviewed-on: http://review.whamcloud.com/5668
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-125 lnet: Add Remote Network Hash Table Size Parameter

Change LU-2466 added a new module parameter: rnet_htable_size
to let the user optimize the size of the LNet remote networks
hash table.

This change is to document rnet_htable_size in the manual.

Signed-off-by: Doug Oucharek <doug.s.oucharek@intel.com>
Change-Id: I4e95acb752c6c1accf13307990210120cbb78c4c
Reviewed-on: http://review.whamcloud.com/5510
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-123: provide instruction on listing debug masks.

Clarifies instructions for the subsystem_mask parameter of lctl debug.
Provides examples.

Change-Id: I51e2104469721d15a29dda1dbaf3caeebe65b252
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Signed-off-by: Cliff White <cliff.white@intel.com>
Reviewed-on: http://review.whamcloud.com/5320
Tested-by: Hudson
Reviewed-by: John Hammond <johnlockwoodhammond@gmail.com>

LUDOC-111 recovery: Add a section on "suppress_pings"

This patch adds a section on the new ptlrpc kernel module parameter
"suppress_pings".

Signed-off-by: Li Wei <wei.g.li@intel.com>
Change-Id: I93a63df4fa0cd15b2901161201a578236baa2d01
Reviewed-on: http://review.whamcloud.com/5588
Tested-by: Hudson
Reviewed-by: Emoly Liu <emoly.liu@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>

LUDOC-91: Add wireshark to debugging tools

Add section on wireshark and pointing to wireshark plugins in contrib.

Change-Id: Id7bcbcb1ac7803c1893a75d08a62edc6f45e548b
Signed-off-by: Nathaniel Clark <nathaniel.l.clark@intel.com>
Reviewed-on: http://review.whamcloud.com/5197
Tested-by: Hudson
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

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 <richard.henwood@intel.com>
Change-Id: Idd2cb762e219204bfc63c9ed81ccedd49b2c43ac
Reviewed-on: http://review.whamcloud.com/4611
Tested-by: Hudson

LUDOC-11 typo: minor cleanup of virtual block device section.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Ib29454dd0d4105f35ee0d049cf5f66fdc77fb196
Reviewed-on: http://review.whamcloud.com/5201
Tested-by: Hudson

LUDOC-117 style: use <replaceable> in example text

Use the <replaceable> tag and {} instead of <emphasis> and
<> for user-supplied text.  The XML markup is intended to
be semantic, so <replaceable> is more correct to use.

The use of <> makes the XML ugly, since it needs to be
written as &gt;&lt; in the .xml files.

Some incorrect usages of <emphasis> were corrected.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I8edb59a100e20573e06f11ce10fe1642d45fbd4f
Reviewed-on: http://review.whamcloud.com/5006
Tested-by: Hudson

LUDOC-71: clean-up of OST removal text.

There is no-longer duplicate text in the introduction to
removing OSTs.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Icfce0c0bdefded1202af7c2fa0ce8831e0c824d5
Reviewed-on: http://review.whamcloud.com/4585
Tested-by: Hudson

LUDOC-108 dne: Manual includes DNE usage instructions.

The manual now includes instructions to:
- add a MDT.
- remove a MDT.
- upgrade to multiple MDT configurations.
- designing active-active MDS configurations.
- warns against having chained remote directories.
- added administrative documentation for lfs.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I9b4fb35d7932b9e90561e03b0b72271b9c2728cf
Reviewed-on: http://review.whamcloud.com/4773
Tested-by: Hudson

LUDOC-11: Correct assorted minor errors

Corrected three minor errors:
Section 1.2.3 removed "something" before the link to the LNET section.

Section 9.1 removed duplicate text "Setting the LNET Module ip2nets Parameter"

Section 23.1 added closing parenthesis

Signed-off-by: James Nunez <james.a.nunez@intel.com>
Change-Id: If1bac00b0245e82d21290f86ce9890a167478ada
Reviewed-on: http://review.whamcloud.com/4941
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-89 quota: updates for new quota implementation

2.4 comes with many quota changes which require updates to the
lustre documentation.

Signed-off-by: Johann Lombardi <johann.lombardi@intel.com>
Change-Id: If465eb2b92d955a29799d041662b770e84891d39
Reviewed-on: http://review.whamcloud.com/4600
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-100 monitoring: jobstats manual

Update manual for jobstats.

Signed-off-by: Niu Yawei <niu@whamcloud.com>
Change-Id: Icfd85f788c1657b0601d06f2890db03068ea5c06
Reviewed-on: http://review.whamcloud.com/4500
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-95: fix server kernel RPM entry.

Table 8.1 in Section 8.1.1 in the Lustre manual contains
outdated references to the Lustre patched kernel RPM
kernel-ib-<ver>. This has been removed.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I9a4c9024faa34e6fa26e8aee16d2518682172d8a
Reviewed-on: http://review.whamcloud.com/4584
Tested-by: Hudson
Reviewed-by: Brian J. Murrell <brian.murrell@intel.com>

LUDOC-99 quota: clarified quota behavior.

Documentation has been corrected to remove erroneous
wording that implied a quota could be applied to a directory.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I46161dcff8e57b5c224270c85d99311d9882725c
Reviewed-on: http://review.whamcloud.com/4492
Tested-by: Hudson
Reviewed-by: Bob Glossman <bob.glossman@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>

LUDOC-103 version: mds-survey is now marked as 2.2 and beyond.

mds-survey is only available in version of Lustre version 2.2. The
Manual now includes text to this effect.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I43349f5994d7ff0f55db7cf58b3fd3b316f200fc
Reviewed-on: http://review.whamcloud.com/4527
Tested-by: Hudson
Reviewed-by: wangdi <di.wang@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>

LUDOC-66 lfsck: improve online LFSCK documentation

Improve the description of the online LFSCK feature, providing a
high-level overview of the feature of what the LFSCK feature is,
and improving the readability of the text.

Also update the Backup/Restore section to replace bugzilla reference
with Jira bug reference.  Also mention that the OST device label needs
to be reset for 2.4 and later filesystems.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Iadbdec4f17ca7bc1ad49065756088e4d05ddcab0
Reviewed-on: http://review.whamcloud.com/4506
Tested-by: Hudson
Reviewed-by: Fan Yong <yong.fan@whamcloud.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-76 license: change Whamcloud to Intel

Change references in the manual from Whamcloud over to Intel in
both the license cover page as well as within the manual.

Update URLs for package downloads to reference the release download
title page instead of the top-level wiki page.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I8d0926881a140e3e76202dc442037366046b6469
Reviewed-on: http://review.whamcloud.com/4497
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

LUDOC-97 tuning: SMP node affinity parameters are now documented.

SMP Node Affinity arrived with Lustre 2.3 (LU-56). The default
values SMP machines are judged to be suitable for most workloads.
If and administrator does want to tinker, this change records
the available parameters.

Entries added to the glossary for NUMA and Node Affinity.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Signed-off-by: Liang Zhen <liang.zhen@intel.com>
Change-Id: Ib5dd25431046d2842cbde77f0b6fede47a790da7
Reviewed-on: http://review.whamcloud.com/4413
Tested-by: Hudson
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Liang Zhen <liang@whamcloud.com>
Reviewed-by: Cliff White <cliff.white@intel.com>

LUDOC-11 fix assorted minor errors

A number of grammatical, spelling, and formatting errors were found by
running the html manual through aspell -H.

Signed-off-by: Ned Bass <bass6@llnl.gov>
Change-Id: Ie4f3cfba62cfb452c1bddb21a3137142dada9d47
Reviewed-on: http://review.whamcloud.com/3908
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>

LUDOC-75 lnet: Add lst utility environment variable LST_FEATURES

Change LU-521 added a new environment variable LST_FEATURES.
This change is to document LST_FEATURES in the manul.

Signed-off-by: Doug Oucharek <doug.s.oucharek@intel.com>
Change-Id: I8760bb902b45d82203645f26c0d1df3e17b8891b
Reviewed-on: http://review.whamcloud.com/3893
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
Reviewed-by: Liang Zhen <liang@whamcloud.com>
Reviewed-by: Cliff White <cliffw@whamcloud.com>

LUDOC-11 debug: fix wrong libcfs debug header path

An incorrect path was given to the header file listing debug
subsystems and message types.

Signed-off-by: Ned Bass <bass6@llnl.gov>
Change-Id: Ib272ed9630f23f99d5f66760804bc3627d58f5dc
Reviewed-on: http://review.whamcloud.com/3882
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
Tested-by: Richard Henwood <Richard.Henwood@intel.com>

LUDOC-66 lfsck: User interface documentation.

lfsck with OI Scrub is new in Lustre 2.3. The user interface is documented by
this change.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I5a74e3ed143ed1c067e41731edf666e900a3b485
Reviewed-on: http://review.whamcloud.com/3368
Tested-by: Hudson
Reviewed-by: Fan Yong <yong.fan@whamcloud.com>
Reviewed-by: Cliff White <cliffw@whamcloud.com>
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>

LUDOC-62 admin: better OST/MDT migrate description

Instead of restating the backup/restore steps for OST/MDT migration,
reference the existing file/device backup/restore process.  Clean up
the formatting of backup/restore examples a bit.

Update the OST object-to-MDS file mapping process to reference new
MDT FIDs and fid2path, in preference to the old 1.8 debugfs method.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ida33c2f055cf9f66fa1ec7463e1ca36875aecab0
Reviewed-on: http://review.whamcloud.com/3827
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
Reviewed-by: Cliff White <cliffw@whamcloud.com>

Merge "LUDOC-62 backup: file-level MDT backup now supported."

LUDOC-58: Clarify multiple file system issues.

Manual is updated to emphasise Lustre is designed to only have one MGS. If
there are multiple MGSs then best practice suggests fsname must be unique.

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

LUDOC-62 backup: file-level MDT backup now supported.

Because LU-957 will land for 2.3 the Manual now describes file level
back for both an MDT and an OST.

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

Merge "LUDOC-49: MDT sizing hint for stripes."

LUDOC-11: tidied up minor word ordering errors.

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

LUDOC-24 Glossary: Fix a typo

Change-Id: I1349f0a79729efcdb94d25a1da0977450250915a
Signed-off-by: Cliff White <cliffw@whamcloud.com>

Merge "LUDOC-39"

LUDOC-39

Add Imperative Recovery to the manual
Include tuning parameters.

Change-Id: I856d92078dc1f7e72c29816197e71851c423f1f2
Signed-off-By: Cliff White <cliffw@whamcloud.com>

LUDOC-11 ptlrpc: fix max_rpcs_in_flight_limit

The maximum number of RPCs in flight per OSC is actually 256, not 32.

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

Merge "LUDOC-42 document Statahead and AGL"

Merge "LUDOC-40 - Add ptlrpcd thread pool"

LUDOC-42 document Statahead and AGL

Update the directory statahead tunable interface descriptions and
add the document for AGL (asynchronous glimpse lock).

Signed-off-by: Yu Jian <yujian@whamcloud.com>
Change-Id: I9dbe2a78f351704bd6ea05093489affea993ea1a

LUDOC-20 admin: fix mount lustre on ldiskfs

lustre can only mount using ldiskfs, not ext4

Signed-off-by: Minh Diep <mdiep@whamcloud.com>
Change-Id: Ifecc9f8302fa777bfe2a1e07e79d42d5c3b803e4

LUDOC-40 - Add ptlrpcd thread pool

Add Ptlrpcd Thread Pool to manual.

Change-Id: I34ff809d9550c6003cc77383a5950c2fe9097779
Signed-off-By: cliff white <cliffw@whamcloud.com>

LUDOC-20 admin: Add instructions for separate MGS

1. Fix order list for Lustre Maintenance section
2. Add instructions on how to separate MGS

Signed-off-by: Minh Diep <mdiep@whamcloud.com>
Change-Id: I69288028cb012f9d0d944cf8809d2660b7ad36d0

LUDOC-2 add "--raw" option to "lfs getstripe"

A new option to "lfs getstripe" is introduced; the "--raw" or
"-R" option.

If this option is specified, the stripe information is printed
without substituting the filesystem's default values for
unspecified fields. If the striping EA is not set, 0, 0, and -1
will be printed for the stripe count, size, and offset respectively.

Signed-off-by: Yu Jian <yujian@whamcloud.com>
Change-Id: I2d4a1bf8fd063afb40345609db9c8204d6e3cc09

Merge "LUDOC-33: fixed identity information upcall 2.x"

LUDOC-33: fixed identity information upcall 2.x

Pre 2.x, Lustre used the user identity information upcall on Lustre MDS side is
through the /proc interface: /proc/fs/lustre/mds/{mdsname}/group_upcall

From 2.x: interface has been replaced (since Lustre-2.0 release) by:
/proc/fs/lustre/mdt/{mdtname}/identity_upcall, and this interface has been
superseded by lctl set_param mdt.{mdtname}.identity_info={path}. "NONE" means
no identity_upcall.

In addition, the following substitutions have been made for Lustre 2.x
"group_info" becomes "identity_info"
"mds_grp_downcall_data" becomes "identity_downcall_data"
"l_getgroups" becomes "l_getidentity"

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

LUDOC-36 iokit: add mds-survey information

Added mds-survey in lustre-iokit

Signed-off-by: Minh Diep <mdiep@whamcloud.com>
Change-Id: Ia5e62b8caa9ae9ff34dea5a95e7f2836f52661c1

LUDOC-49: MDT sizing hint for stripes.

MDT sizing now provides basic advice on including strip count in
calculations.

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

Merge "LU-1203 Replace 'mds' with 'mdt' in root_squash section"

LU-1203 Replace 'mds' with 'mdt' in root_squash section

Fix parameter documentation for root_squash
Addressed Richards correction

Signed-off-by: cliffw@whamcloud.com
Change-Id: I99d1c2df310406848eb6096af84fb8fdf840a0fb

LUDOC-29 upgrade/downgrade process with wide striping feature

Document the process to upgrade from an existing filesystem to
enable wide striping on the MDT and how to downgrade the MDT
filesystem to an earlier version of Lustre that does not support
wide striping.

Signed-off-by: Yu Jian <yujian@whamcloud.com>
Change-Id: I0b3c0b365b5a9fd5bc330cadddf0be147cec9b12

LU-1203 - undo previous changes

Change-Id: I4074c12dff5bcb7987d402c15a10a495926ca3c3

LU-1203 Fix root_squash documentation for mdt

Replace 'mds' with 'mdt' in root_sqaush setup

Change-Id: I410c5078b3f0a44b3e40b7b7814e31c913a424ad

LU-1203 Fix root_squash in manual

Replace 'mds' with 'mdt' in root_squash examples

Fixes root squash section to use mdt instead of mds

Merge "LUDOC-11 upgrade: document 2.1 upgrade requirement"

LU-680 manual: documentation for instance <-> path mapping.

A new feature was added to lfs with LU-680. This change records
the usage of this new feature in the manual.

lfs commands are now listed in alphabetical order.

The code changeset is:
http://review.whamcloud.com/#change,1373

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

LUDOC-29 increase maximum stripe count from 160 to 2000

The wide striping feature increases the maximum stripe count from
160 to 2000. This patch fixes this limit in the manual.

Signed-off-by: Yu Jian <yujian@whamcloud.com>
Change-Id: I8b3496f3e71debc314d97669dbc8db81a5a4c9a4

LUDOC-11 upgrade: document 2.1 upgrade requirement

The 1.8->2.x upgrade section was referring only to Lustre 2.0, but
should refer to Lustre 2.x more generically.

Update the minimum 1.8 version for 2.1 interoperability to 1.8.6.

Remove statement that allows both 1.8 and 2.x servers to be running
at the same time, since this is not tested.  Instead, require that
both the MDS and OSS nodes are upgraded to 2.x at the same time.

Remove references to ancient 1.4.x Lustre versions, and distinctions
that are only present for versions of Lustre 1.6.5 and older.

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

LUDOC-13 build: Disable diff in Makefile

If diff fails, the build is marked as failing. Make all now doesn't
have diff enabled until it has had the bugs worked out.

Added epub to clean.

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

LUDOC-25: typo fix

tthat becomes that. The sentences simplified for clarity.

Signed-off-by: Richard Henwood <rhenwood@ywhamcloud.com>
Change-Id: I983fec8aa0c6db088ba802f61d360cab4bc26864

Merge "LUDOC-32: build epub from manual."

LUDOC-32: build epub from manual.

Makefile now contains the correct rules to build an epub version
of the manual.

Signed-off-by: Richard Henwood <rhenwood@ywhamcloud.com>
Change-Id: I5e126b137b535522c720fdac863562f194a2e17e

Merge "LUDOC-13: enhanced diff to work with larger changes."