Whamcloud - gitweb
LU-4315 doc: updating lfs-[h-l] man page style 90/56090/3
authorMaximilian Dilger <mdilger@whamcloud.com>
Wed, 7 Aug 2024 09:34:02 +0000 (03:34 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 16 Sep 2024 15:09:34 +0000 (15:09 +0000)
commit005da89eae3d3a9143806356aa69167e1e18630b
treefc58350cdeeb5bb9db3179a76d6c87c76a013229
parent5bb91eaff0265c02ef53695f622d6d5be9961429
LU-4315 doc: updating lfs-[h-l] 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:
- lfs-heat_get.1
- lfs-heat_set.1
- lfs-hsm.1
- lfs-hsm_action.1
- lfs-hsm_clear.1
- lfs-hsm_set.1
- lfs-hsm_state.1
- lfs-ladvise.1

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: I58223c11b886fcc8abcf9aab37d72e36a5d98af3
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56090
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/lfs-heat_get.1
lustre/doc/lfs-hsm.1
lustre/doc/lfs-ladvise.1