b=3399

r=braam
update lmc.lyx and lconf.lyx

diff --git a/lustre/doc/lconf.lyx b/lustre/doc/lconf.lyx
index 1c6d878..a7d8b62 100644 (file)
--- a/lustre/doc/lconf.lyx
+++ b/lustre/doc/lconf.lyx
@@ -56,10 +56,18 @@ This program configures a node following directives in the <XML-config-file>.
  on an LDAP server that can be reached from all the cluster nodes.
 \layout Description
 
+--client_uuid\SpecialChar ~
+<uuid> The failed client (required for recovery).
+\layout Description
+
 --config\SpecialChar ~
 <arg> Cluster configuration name used for LDAP query
 \layout Description
 
+--conn_uuid\SpecialChar ~
+<uuid> The failed connection (required for recovery).
+\layout Description
+
 --d|--cleanup Unconfigure a node.
  The same config and 
 \emph on 
@@ -70,6 +78,10 @@ This program configures a node following directives in the <XML-config-file>.
  including unloading the kernel modules.
 \layout Description
 
+--debug_path\SpecialChar ~
+<path> Path to save debug dumps.
+\layout Description
+
 --dump\SpecialChar ~
 <file> Dump the kernel debug log to the specified file before portals
  is unloaded during cleanup.
@@ -160,6 +172,43 @@ When used in conjunction with cleanup, services are torn down up to a certain
  Default is 0.
 \layout Description
 
+--mkfsoptions\SpecialChar ~
+<options> Specify additional options for the mk*fs command
+ line.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Specify additional options for mount fs command
+ line.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding 
+\begin_inset Quotes eld
+\end_inset 
+
+,extents
+\begin_inset Quotes erd
+\end_inset 
+
+ to the --mountfsoptions option.
+ 
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
+\layout Description
+
 --node\SpecialChar ~
 node_name Specify a specific node to configure.
  By default, lconf will search for nodes with the local hostname and 'localhost'.
@@ -190,6 +239,11 @@ node_name
 --nosetup Only load modules, do not configure devices or services.
 \layout Description
 
+--portals\SpecialChar ~
+<path> Specify portals source directory.
+ If this is a relative path, then it is assumed to be relative to lustre.
+\layout Description
+
 --portals_upcall\SpecialChar ~
 <path> Specify the location of the Portals upcall scripts
  used by the client for recovery
@@ -201,6 +255,18 @@ level This options can be used to set the required debug
  level.
 \layout Description
 
+--record Write config information on mds.
+\layout Description
+
+--record_log\SpecialChar ~
+<arg> Specify the name of config record log.
+\layout Description
+
+--record_device\SpecialChar ~
+<arg> Specify MDS device name that will record the config
+ commands.
+\layout Description
+
 --recover\SpecialChar ~
 <arg> Recover a device.
 \layout Description
@@ -213,10 +279,17 @@ level This options can be used to set the required debug
 <arg> Select a particular node for a service 
 \layout Description
 
+--single_socket Specify socknal option: only use one socket instead of bundle.
+\layout Description
+
 --subsystem\SpecialChar ~
 <arg> Set the portals debug subsystem.
 \layout Description
 
+--tgt_uuid\SpecialChar ~
+<uuid> Specify the failed target (required for recovery).
+\layout Description
+
 --timeout\SpecialChar ~
 <arg> Set the recovery timeout period.
 \layout Description

diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx
index bb6ca2b..5a73e06 100644 (file)
--- a/lustre/doc/lmc.lyx
+++ b/lustre/doc/lmc.lyx
@@ -119,11 +119,7 @@ net
 \series default 
 ,
 \series bold 
- 
-\series default 
-or
-\series bold 
- echo_client.
+ echo_client, or cobd.
  
 \series default 
 We describe the arguments required for the addition of each 
@@ -172,6 +168,15 @@ The arguments required are:
 --upcall\SpecialChar ~
 <path> Specify the location of both (Lustre and Portals) upcall
  scripts used by the client for recovery
+\layout Description
+
+--ptldebug\SpecialChar ~
+<debug_level> Set the portals debug level.
+\layout Description
+
+--subsytem\SpecialChar ~
+<subsystem_name> Specify which Lustre subsystems have debug output
+ recorded in the log.
 \end_deeper 
 \layout Description
 
@@ -195,7 +200,7 @@ The arguments required are:
 \layout Description
 
 --nettype\SpecialChar ~
-<type> This can be 
+<type> Specify the network type.This can be 
 \series bold 
 tcp, elan, gm.
 \layout Description
@@ -231,7 +236,13 @@ client
  configuration.
 \layout Description
 
---hostaddr addr
+--cluster_id\SpecialChar ~
+id Specify the cluster ID.
+\layout Description
+
+--hostaddr\SpecialChar ~
+addr Specify the host address.
+ lconf will transfer it to the real host address.
 \layout Description
 
 --router Optional flag to mark this node as a router
@@ -272,7 +283,10 @@ name> Name of the node on which the MDS resides
 \layout Description
 
 --mds\SpecialChar ~
-<mds_name> 
+<mds_name> Specify MDS name.
+\layout Description
+
+--failover Enable failover support on MDS.
 \layout Description
 
 --dev\SpecialChar ~
@@ -280,6 +294,10 @@ name> Name of the node on which the MDS resides
  If the is a file, then a loop device is created and used as the block device.
 \layout Description
 
+--backdev\SpecialChar ~
+<pathname> Path of the device for backing storage on local system.
+\layout Description
+
 --size\SpecialChar ~
 <size> Optional argument indicating the size (in KB) of the device
  to be created (used typically for loop devices).
@@ -299,6 +317,46 @@ extN|ext3 Optional argument used to specify the file system type.
  Default is ext3.
 \layout Description
 
+--backfstype\SpecialChar ~
+ext3|tmpfs Optional argument to specify the backing filesystem
+ type.
+\layout Description
+
+--nspath Local mount point of server namespace.
+\layout Description
+
+--inode_size\SpecialChar ~
+<size> Specify new inode size for underlying ext3 file system.
+\layout Description
+
+--mkfsoptions\SpecialChar ~
+<options> Optional argument to mkfs.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Optional argument to mount fs.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding ",extents" to the --mountfsopt
+ions option.
+ 
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
+\layout Description
+
 --journal_size\SpecialChar ~
 <size> Optional arguement to specify the journal size for
  the ext2/ext3 file system.
@@ -323,15 +381,15 @@ mds_name
 \layout Description
 
 --lov\SpecialChar ~
-<name>
+<name> Specify LOV name.
 \layout Description
 
 --mds\SpecialChar ~
-<name>
+<name> Specify the mds name.
 \layout Description
 
 --stripe_sz\SpecialChar ~
-<size>
+<size> Specify the stripe size in bytes.
 \layout Description
 
 --stripe_cnt\SpecialChar ~
@@ -360,19 +418,26 @@ ost Creates an OBD, OST, and OSC.
  node.
 \layout Description
 
+--failover Enable failover support on OST.
+\layout Description
+
 --dev\SpecialChar ~
 <pathname> Path of device on local system.
  If this is a file, then a loop device is created and used as the block
  device.
 \layout Description
 
+--backdev\SpecialChar ~
+<pathname> Path of the device for backing storage on local system.
+\layout Description
+
 --size\SpecialChar ~
 [size] Optional argument indicating the size (in KB) of the device
  to be created (used typically for loop devices).
 \layout Description
 
---obdtype\SpecialChar ~
-obdfilter|obdecho 
+--osdtype\SpecialChar ~
+obdfilter|obdecho Specify the type of OSD.
 \layout Description
 
 --lov\SpecialChar ~
@@ -391,6 +456,46 @@ extN|ext3 Optional arguement used to specify the file system type.
  Default is ext3.
 \layout Description
 
+--backfstype\SpecialChar ~
+ext3|tmpfs Optional argument to specify the backing filesystem
+ type.
+\layout Description
+
+--inode_size\SpecialChar ~
+<size> Specify new inode size for underlying ext3 file system.
+\layout Description
+
+--nspath Local mount point of server namespace.
+\layout Description
+
+--mkfsoptions\SpecialChar ~
+<options> Optional argument to mkfs.
+\layout Description
+
+--mountfsoptions\SpecialChar ~
+<options> Optional argument to mount fs.
+ Mount options will be passed by this argument.
+ For example, extents are to be enabled by adding ",extents" to the --mountfsopt
+ions option.
+ 
+\begin_inset Quotes eld
+\end_inset 
+
+errors=remount-ro
+\begin_inset Quotes erd
+\end_inset 
+
+ and 
+\begin_inset Quotes eld
+\end_inset 
+
+asyncdel
+\begin_inset Quotes erd
+\end_inset 
+
+ can also be added to it.
+\layout Description
+
 --journal_size\SpecialChar ~
 <size> Optional arguement to specify the journal size for
  the ext2/ext3 file system.
@@ -419,19 +524,20 @@ mtpt
 \layout Description
 
 --path\SpecialChar ~
-/mnt/path\SpecialChar ~
-
+/mnt/path Specify the mountpoint for Lustre.
 \layout Description
 
 --mds\SpecialChar ~
-mds_name 
+mds_name Specify the mds name, which will provide service for this
+ client.
 \layout Description
 
 --ost\SpecialChar ~
 ost_name\SpecialChar ~
 |\SpecialChar ~
 --lov\SpecialChar ~
-lov_name
+lov_name Specify the ost or lov, which will provide service
+ for this client.
 \end_deeper 
 \layout Description
 
@@ -452,6 +558,9 @@ nid
 node Node to add the route to.
 \layout Description
 
+--router Optional flag to mark a node as router.
+\layout Description
+
 --gw\SpecialChar ~
 nid The 
 \emph on 
@@ -460,10 +569,14 @@ nid
  of the gateway (must be a local interface or a peer).
 \layout Description
 
---tgt\SpecialChar ~
-nid For a specific route, this is the target 
-\emph on 
-nid.
+--gateway_cluster_id\SpecialChar ~
+id Specify the id of the cluster, to which the gateway
+ belongs.
+\layout Description
+
+--target_cluster_id\SpecialChar ~
+id Specify the id of the cluster, to which the target
+ of the route belongs.
 \layout Description
 
 --lo\SpecialChar ~
@@ -486,13 +599,42 @@ echo-client Used for testing purpose only.
 \layout Description
 
 --node\SpecialChar ~
-node
+nodename
+\emph on 
+ 
+\emph default 
+Node on which the echo-client resides.
+\end_deeper 
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold 
+--add\SpecialChar ~
+cobd 
+\series default 
+Create the cobd on the specified node.
+\begin_deeper 
+\layout Description
+\noindent \align left 
+--node\SpecialChar ~
+nodename
 \emph on 
  
+\emph default 
+Node on which the cobd resides.
+\layout Description
+
+--cache_obd\SpecialChar ~
+obd_name Specify the cache device for the cache obd system.
 \layout Description
 
---obd\SpecialChar ~
-obd_name 
+--real_obd\SpecialChar ~
+obd_name
+\emph on 
+ 
+\emph default 
+Specify the real device for the cache obd system.
 \end_deeper 
 \layout List
 \labelwidthstring 00.00.0000
@@ -502,6 +644,16 @@ obd_name
 Options
 \layout Description
 
+--reference Print short reference for commands.
+\layout Description
+
+--verbose Print system commands as they are run.
+\layout Description
+
+--batch\SpecialChar ~
+filename Used to execute lmc commands in batch mode.
+\layout Description
+
 --output\SpecialChar ~
 filename Send output to the file.
  If the file exists, it will be overwritten.