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)
commitc5bec6a88a927506df5edaaec5a24602b32c6360
tree3af2859cb343b8a9acfe29283ee49eeaa4c90a8a
parent1129afd34896c9a9778e9467318cde2bb1676e24
LU-930 doc: fix format man page sections for lctl

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