Whamcloud - gitweb
LU-4315 doc: updating lctl-[li-ne] man page style 55/56055/5
authorFrederick Dilger <fdilger@whamcloud.com>
Wed, 14 Aug 2024 05:42:04 +0000 (23:42 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 16 Sep 2024 15:09:03 +0000 (15:09 +0000)
commita7acf56fadf0ffb10ca4454b1024da9720863967
tree74b758ca569f6db9e9b3e9c1afcf9ce5ea327e35
parentc57ba5bfc437ac62328b69f1371d366571c2d12d
LU-4315 doc: updating lctl-[li-ne] 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-list_param.8
- lctl-llog_cancel.8
- lctl-llog_catlist.8
- lctl-llog_info.8
- lctl-llog_print.8
- lctl-network.8

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