Whamcloud - gitweb
LU-4315 doc: updating lctl-[p-s] man page style 71/56071/8
authorFrederick Dilger <fdilger@whamcloud.com>
Thu, 15 Aug 2024 06:59:20 +0000 (00:59 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 2 Dec 2024 05:47:15 +0000 (05:47 +0000)
commitf714875b1be6c05c5cadd5bff046e9b78e940ab7
tree1c2f60f9ef5cf2fb1587778acee7d237e2440290
parent70d8107c48abe2f82f714ca82e488d953642ce06
LU-4315 doc: updating lctl-[p-s] man page style

Updating files to match the new code style for Lustre manual pages as
enforced by 'contrib/scripts/checkpatch-man.pl'.

This also includes other changes like removing < > or { } for singular
required arguments and placing [ ] around optional ones as well as
making all arguments CAPITAL and italicized, literal arguments are
bolded. Lines over 80 characters should be split at the natural line
end rather than the word that goes over the limit as fewer lines will
need to be modified when making changes if each sentence is on it's
own line.

Only using features that appear in groff 1.22.3 as this is the
available version is CentOS 8.

Checked files:
- lctl-pcc.8
- lctl-pool_add.8
- lctl-pool_new.8
- lctl-set_param.8
- lctl-snapshot-create.8
- lctl-snapshot-destroy.8
- lctl-snapshot-list.8
- lctl-snapshot-modify.8
- lctl-snapshot-mount.8
- lctl-snapshot-umount.8

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: Icd30b49a3025aede26524b09cefa438bdca2ccc4
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56071
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
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