Whamcloud - gitweb
LU-4315 doc: updating ll[d-v] man page style 90/56190/3
authorFrederick Dilger <fdilger@whamcloud.com>
Wed, 28 Aug 2024 20:45:11 +0000 (14:45 -0600)
committerOleg Drokin <green@whamcloud.com>
Wed, 25 Sep 2024 04:06:48 +0000 (04:06 +0000)
commit0caae7865f9a2d10518291e44a550875b1e257d3
tree34dd748acd27df6d7d1dbd5d633474eac8d3004c
parent59bbec814c4ee5cac2c52fabde6ea1f39d072c06
LU-4315 doc: updating ll[d-v] 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:
- ll_decode_filter_fid.8
- ll_decode_linkea.8
- lljobstat.8
- llobdstat.8
- llog_reader.8
- llsom_sync.8
- llstat.8
- llverdev.8
- llverfs.8

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: Id0b09d1e1826f95d6e5fe820f61ed5e32232ce90
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56190
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
lustre/doc/ll_decode_filter_fid.8
lustre/doc/ll_decode_linkea.8
lustre/doc/lljobstat.8
lustre/doc/llobdstat.8
lustre/doc/llog_reader.8
lustre/doc/llsom_sync.8
lustre/doc/llstat.8
lustre/doc/llverdev.8
lustre/doc/llverfs.8