Whamcloud - gitweb
LU-930 doc: fix format man page sections for lctl 75/41075/4
authorJames Nunez <jnunez@whamcloud.com>
Tue, 22 Dec 2020 15:56:45 +0000 (08:56 -0700)
committerOleg Drokin <green@whamcloud.com>
Fri, 26 Feb 2021 21:06:48 +0000 (21:06 +0000)
For lctl man pages, add proper formatting for the NAME
and TITLE sections so that 'man -k lctl*' reports the
real explanation for the command/utility and not
"(unknown subject)".

Modifications in this patch include:
- add a dash between multi-word name commands in NAME
- format the date to YYYY-MM-DD in TITLE
- capitalize command in TITLE
- change hyphen (-) to underscore in command where necessary

Test-Parameters: trivial
Signed-off-by: James Nunez <jnunez@whamcloud.com>
Change-Id: I946a3683b0a48b662c4e3b7b5783d389fa710e08
Reviewed-on: https://review.whamcloud.com/41075
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: John L. Hammond <jhammond@whamcloud.com>
33 files changed:
lustre/doc/lctl-barrier.8
lustre/doc/lctl-get_param.8
lustre/doc/lctl-lcfg.8
lustre/doc/lctl-lfsck-query.8
lustre/doc/lctl-lfsck-start.8
lustre/doc/lctl-lfsck-stop.8
lustre/doc/lctl-list_param.8
lustre/doc/lctl-llog_cancel.8
lustre/doc/lctl-llog_catlist.8
lustre/doc/lctl-llog_info.8
lustre/doc/lctl-llog_print.8
lustre/doc/lctl-network.8
lustre/doc/lctl-nodemap-activate.8
lustre/doc/lctl-nodemap-add-idmap.8
lustre/doc/lctl-nodemap-add-range.8
lustre/doc/lctl-nodemap-add.8
lustre/doc/lctl-nodemap-del-idmap.8
lustre/doc/lctl-nodemap-del-range.8
lustre/doc/lctl-nodemap-del.8
lustre/doc/lctl-nodemap-modify.8
lustre/doc/lctl-nodemap-set-fileset.8
lustre/doc/lctl-nodemap-set-sepol.8
lustre/doc/lctl-pcc.8
lustre/doc/lctl-pool_add.8
lustre/doc/lctl-pool_new.8
lustre/doc/lctl-set_param.8
lustre/doc/lctl-snapshot-create.8
lustre/doc/lctl-snapshot-destroy.8
lustre/doc/lctl-snapshot-list.8
lustre/doc/lctl-snapshot-modify.8
lustre/doc/lctl-snapshot-mount.8
lustre/doc/lctl-snapshot-umount.8
lustre/doc/lctl.8

index a08c359..a360dab 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-barrier 8 "2017 Apr 13" Lustre "Lustre write barrier on all MDTs"
+.TH LCTL-BARRIER 8 "2017-07-18" Lustre "configuration utilities"
+.SH NAME
+lctl-barrier \- Lustre write barrier utilities
 .SH SYNOPSIS
 .br
 .B lctl barrier_freeze \fR{fsname} [timeout]
 .SH SYNOPSIS
 .br
 .B lctl barrier_freeze \fR{fsname} [timeout]
index d2db46d..e1c992d 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl 8 "2019 Jun 17" Lustre "configuration utilities"
+.TH LCTL-GET_PARAM 8 "2019-06-17" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl get_param \- retrieve tunable parameters
+lctl-get_param \- retrieve configuration parameters
 .SH SYNOPSIS
 .br
 .IR "\fBlctl get_param " [ -F "] [" -n | -N "] [" -R "] <" parameter ...>
 .SH SYNOPSIS
 .br
 .IR "\fBlctl get_param " [ -F "] [" -n | -N "] [" -R "] <" parameter ...>
index 8d63c4b..2d19d8e 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-lcfg 8 "2017 Apr 13" Lustre "Maintain Lustre configuration"
+.TH LCTL-LCFG 8 "2017-04-13" Lustre "configuration utilities"
+.SH NAME
+lctl-lcfg \- Lustre configuration utilities
 .SH SYNOPSIS
 .br
 .B lctl fork_lcfg \fR{fsname} {newname}
 .SH SYNOPSIS
 .br
 .B lctl fork_lcfg \fR{fsname} {newname}
index 9ae8d59..65ff515 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-lfsck-stop 8 "2016 Apr 1" Lustre "Lustre online fsck"
+.TH LCTL-LFSCK_QUERY 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-lfsck_query \- get Lustre File System Check global status
 .SH SYNOPSIS
 .br
 .B lctl lfsck_query \fR[-M | --device MDT_device] [-h | --help]
 .SH SYNOPSIS
 .br
 .B lctl lfsck_query \fR[-M | --device MDT_device] [-h | --help]
index 30fc226..1a40a15 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-lfsck-start 8 "2016 Apr 1" Lustre "Lustre online fsck"
+.TH LCTL-LFSCK_START 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-lfsck_start \- start online Lustre File System Check
 .SH SYNOPSIS
 .br
 .B lctl lfsck_start \fR[-M | --device [MDT,OST]_device]
 .SH SYNOPSIS
 .br
 .B lctl lfsck_start \fR[-M | --device [MDT,OST]_device]
index 30dbbfc..6006f62 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-lfsck-stop 8 "2016 Apr 1" Lustre "Lustre online fsck"
+.TH LCTL-LFSCK_STOP 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-lfsck_stop \- stop the online Lustre File System Check
 .SH SYNOPSIS
 .br
 .B lctl lfsck_stop  \fR[-M | --device [MDT,OST]_device] [-A | --all] [-h | --help]
 .SH SYNOPSIS
 .br
 .B lctl lfsck_stop  \fR[-M | --device [MDT,OST]_device] [-A | --all] [-h | --help]
index 6917a3f..10371ef 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-list_param 8 "2019 Sep 30" Lustre "configuration utilities"
+.TH LCTL-LIST_PARAM 8 "2019-06-16" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl list_param \- list configuration parameter names
+lctl-list_param \- list configuration parameter names
 .SH SYNOPSIS
 .BR list_param " [" -F | -R ]
 .RI < param_search " ...>"
 .SH SYNOPSIS
 .BR list_param " [" -F | -R ]
 .RI < param_search " ...>"
index ee60d81..50f279c 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-llog_cancel 8 "2019 Jan 10" Lustre "configuration utilities"
+.TH LCTL-LLOG_CANCEL 8 "2020-06-12" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl llog_cancel \- cancel a record in a Lustre llog file
+lctl-llog_cancel \- cancel a record in a Lustre log file
 .SH SYNOPSIS
 .B lctl
 .B llog_cancel --log_idx
 .SH SYNOPSIS
 .B lctl
 .B llog_cancel --log_idx
index 0c0fa45..e0fdc7f 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-llog_catlist 8 "2019 Jan 10" Lustre "configuration utilities"
+.TH LCTL-LLOG_CATLIST 8 "2020-06-12" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl llog_catlist \- list Lustre configuration log files
+lctl-llog_catlist \- list Lustre configuration log files
 .SH SYNOPSIS
 .B lctl
 [--device <\fIdevice\fR>]
 .SH SYNOPSIS
 .B lctl
 [--device <\fIdevice\fR>]
index 141055d..f581550 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-llog_info 8 "2019 Jan 10" Lustre "configuration utilities"
+.TH LCTL-LLOG_INFO 8 "2020-06-12" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl llog_info \- print information about a Lustre configuration log
+lctl-llog_info \- print information about a Lustre configuration log
 .SH SYNOPSIS
 .B lctl llog_info
 .RI < logname >
 .SH SYNOPSIS
 .B lctl llog_info
 .RI < logname >
index 30b4c9a..d2c49f7 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-llog_print 8 "2019 Jan 10" Lustre "configuration utilities"
+.TH LCTL-LLOG_PRINT 8 "2020-06-12" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl llog_print \- print the content of a configuration log
+lctl-llog_print \- print the content of a configuration log
 .SH SYNOPSIS
 .B lctl llog_print
 .RB [ --start
 .SH SYNOPSIS
 .B lctl llog_print
 .RB [ --start
index 6917574..fa6c99e 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-network 8 "2014 May 28" Lustre "configuration utilities"
+.TH LCTL-NETWORK 8 "2016-09-06" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl network \- start or stop an LNet network or set network type
+lctl-network \- start or stop an LNet network or set network type
 .SH SYNOPSIS
 .B lctl network
 .I up
 .SH SYNOPSIS
 .B lctl network
 .I up
index bbbd0fe..4c743e5 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-nodemap-activate 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_ACTIVATE 8 "2015-01-20" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-activate \- Activate or deactivate the nodemap feature.
+lctl-nodemap_activate \- activate or deactivate the nodemap feature
 .SH SYNOPSIS
 .br
 .B lctl nodemap_activate "<0|1>"
 .SH SYNOPSIS
 .br
 .B lctl nodemap_activate "<0|1>"
index a2b9f8c..b69b749 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-add-idmap 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_ADD_IDMAP 8 "2015-01-20" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-add-idmap \- Define a range of NIDs for a nodemap.
-
+lctl-nodemap_add_idmap \- define a range of NIDs for a nodemap
 .SH SYNOPSIS
 .br
 .B lctl nodemap_add_idmap <--name name> <--idtype {uid|gid}>
 .SH SYNOPSIS
 .br
 .B lctl nodemap_add_idmap <--name name> <--idtype {uid|gid}>
index ee2e26e..8672cf4 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-add-range 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_ADD_RANGE 8 "2015-01-20" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-add-range \- Define a range of NIDs for a nodemap.
-
+lctl-nodemap_add_range \- define a range of NIDs for a nodemap
 .SH SYNOPSIS
 .br
 .B lctl nodemap_add_range <--name name> <--range range>
 .SH SYNOPSIS
 .br
 .B lctl nodemap_add_range <--name name> <--range range>
index 58d2e37..77a193a 100644 (file)
@@ -1,8 +1,7 @@
-.TH lctl-nodemap-add 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_ADD 8 "2015-01-20" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-add \- Add a new nodemap, to which NID ranges, identities, and
-properties can be added.
-
+lctl-nodemap_add \- add a new nodemap, to which NID ranges, identities, and
+properties can be added
 .SH SYNOPSIS
 .br
 .B lctl nodemap_add <name>
 .SH SYNOPSIS
 .br
 .B lctl nodemap_add <name>
index d5af221..640f58c 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-del-idmap 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_DEL_IDMAP 8 "2015-01-20" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-del-idmap \- Delete an existing idmap from a nodemap.
-
+lctl-nodemap_del_idmap \- delete an existing idmap from a nodemap
 .SH SYNOPSIS
 .br
 .B lctl nodemap_del_idmap <--name name> <--idtype [uid|gid]>
 .SH SYNOPSIS
 .br
 .B lctl nodemap_del_idmap <--name name> <--idtype [uid|gid]>
index 1eec160..65266be 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-del-range 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_DEL_RANGE 8 "2015-01-20" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-del-range \- Delete an existing NID range from a nodemap.
-
+lctl-nodemap_del_range \- delete an existing NID range from a nodemap
 .SH SYNOPSIS
 .br
 .B lctl nodemap_del_range "<--name name> <--range range>"
 .SH SYNOPSIS
 .br
 .B lctl nodemap_del_range "<--name name> <--range range>"
index fe6c44b..f557e69 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-del 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_DEL 8 "2015-01-20" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-del \- Delete an existing nodemap.
-
+lctl-nodemap_del \- delete an existing nodemap
 .SH SYNOPSIS
 .br
 .B lctl nodemap_del "<name>"
 .SH SYNOPSIS
 .br
 .B lctl nodemap_del "<name>"
index 6dfd0be..970cc56 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-modify 8 "2015 Jan 20" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_MODIFY 8 "2019-01-22" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-modify \- Modify a nodemap property.
-
+lctl-nodemap_modify \- modify a nodemap property
 .SH SYNOPSIS
 .br
 .B lctl nodemap_modify <--name nodemap_name> <--property property_name>
 .SH SYNOPSIS
 .br
 .B lctl nodemap_modify <--name nodemap_name> <--property property_name>
index d224d7f..4bba67f 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-set-fileset 8 "2019 Jan 17" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_SET_FILESET 8 "2019-01-17" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-set-fileset \- Add a fileset to a nodemap.
-
+lctl-nodemap_set_fileset \- add a fileset to a nodemap
 .SH SYNOPSIS
 .br
 .B lctl nodemap_set_fileset --name
 .SH SYNOPSIS
 .br
 .B lctl nodemap_set_fileset --name
index 0c04b74..e6faf07 100644 (file)
@@ -1,7 +1,6 @@
-.TH lctl-nodemap-set-sepol 8 "2019 Jan 21" Lustre "configuration utilities"
+.TH LCTL-NODEMAP_SET_SEPOL 8 "2019-01-21" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl-nodemap-set-sepol \- Set SELinux policy info on a nodemap.
-
+lctl-nodemap_set_sepol \- set SELinux policy info on a nodemap
 .SH SYNOPSIS
 .br
 .B lctl nodemap_set_sepol --name
 .SH SYNOPSIS
 .br
 .B lctl nodemap_set_sepol --name
index 759a670..27f05ea 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl-pcc 8 2019-04-15 "Lustre" "configuration Utilities"
+.TH LCTL-PCC 8 "2019-04-24" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl pcc commands used to interact with PCC features.
+lctl-pcc \- commands used to interact with PCC features
 .SH SYNOPSIS
 .B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>]
 .br
 .SH SYNOPSIS
 .B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>]
 .br
index 7c168cf..ed68033 100644 (file)
@@ -1,6 +1,6 @@
-.TH LCTL-POOL_ADD 8 2018-10-27 "Lustre" "Lustre Utilities"
+.TH LCTL-POOL_ADD 8 "2018-12-12" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl pool_add \- add OSTs to a named pool
+lctl-pool_add \- add OSTs to a named pool
 .SH SYNOPSIS
 .B lctl pool_add \fI<fsname>.<poolname>\fR \fI<ost_index> ...\fR
 .br
 .SH SYNOPSIS
 .B lctl pool_add \fI<fsname>.<poolname>\fR \fI<ost_index> ...\fR
 .br
index 97d541e..d9dd914 100644 (file)
@@ -1,6 +1,6 @@
-.TH LCTL-POOL_NEW 8 2018-10-27 "Lustre" "Lustre Utilities"
+.TH LCTL-POOL_NEW 8 "2018-12-12" Lustre "Lustre Utilities"
 .SH NAME
 .SH NAME
-lctl pool_new \- create a new OST pool
+lctl-pool_new \- create a new OST pool
 .SH SYNOPSIS
 .B lctl pool_new \fI<fsname>.<poolname>\fR
 
 .SH SYNOPSIS
 .B lctl pool_new \fI<fsname>.<poolname>\fR
 
index bb69c4e..28477a3 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl 8 "2019 Jun 17" Lustre "configuration utilities"
+.TH LCTL-SET_PARAM 8 "2019-05-10" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl set_param \- Low level Lustre filesystem configuration utility
+lctl-set_param \- Lustre filesystem set parameter utility
 .SH SYNOPSIS
 .IR "\fBlctl set_param " [ -n "] [" -P "] [" -d "] <" parameter \B= value ...>
 .br
 .SH SYNOPSIS
 .IR "\fBlctl set_param " [ -n "] [" -P "] [" -d "] <" parameter \B= value ...>
 .br
index c6b9f68..0615453 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-snapshot-create 8 "2017 Apr 13" Lustre "create Lustre snapshot"
+.TH LCTL-SNAPSHOT_CREATE 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-snapshot_create \- create Lustre snapshot
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_create \fR[-b | --barrier [on | off]] [-c | --comment comment]
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_create \fR[-b | --barrier [on | off]] [-c | --comment comment]
index 09387de..5c49ddd 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-snapshot-destroy 8 "2017 Apr 13" Lustre "destroy Lustre snapshot"
+.TH LCTL-SNAPSHOT_DESTROY 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-snapshot_destroy \- destroy Lustre snapshot
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_destroy \fR[-f | --force] {-F | --fsname fsname} [-h | --help]
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_destroy \fR[-f | --force] {-F | --fsname fsname} [-h | --help]
index 54c4354..06a0f94 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-snapshot-list 8 "2017 Apr 13" Lustre "query Lustre snapshot"
+.TH LCTL-SNAPSHOT_LIST 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-snapshot_list \- query Lustre snapshot
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_list \fR[-d | --detail] {-F | --fsname fsname} [-h | --help]
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_list \fR[-d | --detail] {-F | --fsname fsname} [-h | --help]
index c05e311..32967b1 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-snapshot-modify 8 "2017 Apr 13" Lustre "modify Lustre snapshot"
+.TH LCTL-SNAPSHOT_MODIFY 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-snapshot_modify \- modify Lustre snapshot
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_modify \fR[-c | --comment comment] {-F | --fsname fsname}
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_modify \fR[-c | --comment comment] {-F | --fsname fsname}
index c24a0a3..82719f2 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-snapshot-mount 8 "2017 Apr 13" Lustre "mount Lustre snapshot"
+.TH LCTL-SNAPSHOT_MOUNT 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-snapshot_mount \- mount Lustre snapshot
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_mount \fR{-F | --fsname fsname} [-h | --help]
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_mount \fR{-F | --fsname fsname} [-h | --help]
index a4af22b..28ac1f8 100644 (file)
@@ -1,4 +1,6 @@
-.TH lctl-snapshot-umount 8 "2017 Apr 13" Lustre "umount Lustre snapshot"
+.TH LCTL-SNAPSHOT_UMOUNT 8 "2017-05-13" Lustre "configuration utilities"
+.SH NAME
+lctl-snapshot_umount \- unmount Lustre snapshot
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_umount \fR{-F | --fsname fsname} [-h | --help]
 .SH SYNOPSIS
 .TP
 .B lctl snapshot_umount \fR{-F | --fsname fsname} [-h | --help]
index 58a18c3..0801934 100644 (file)
@@ -1,6 +1,6 @@
-.TH lctl 8 "2017 Jan 12" Lustre "configuration utilities"
+.TH LCTL 8 "2019-06-16" Lustre "configuration utilities"
 .SH NAME
 .SH NAME
-lctl \- Low level Lustre filesystem configuration utility
+lctl \- Lustre filesystem administrator configuration tool
 .SH SYNOPSIS
 .br
 .B lctl
 .SH SYNOPSIS
 .br
 .B lctl