Whamcloud - gitweb
LU-4315 doc: updating lfs-[c-g] man page style 72/56072/6
authorFrederick Dilger <fdilger@whamcloud.com>
Thu, 15 Aug 2024 07:03:19 +0000 (01:03 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 16 Sep 2024 15:09:22 +0000 (15:09 +0000)
commit5bb91eaff0265c02ef53695f622d6d5be9961429
treed9c3dc20fbb1b27ec06718b912983dc1f5b14df0
parent18e3d4929982c4f61673b2c78b0e9abced5239d7
LU-4315 doc: updating lfs-[c-g] 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-changelog.1
- lfs-changelog_clear.1
- lfs-df.1
- lfs-fid2path.1
- lfs-find.1
- lfs-flushctx.1
- lfs-getdirstripe.1
- lfs-getname.1
- lfs-getsom.1
- lfs-getstripe.1

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: I238e137b3d85972229d256e09f620ec8112fd5ea
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56072
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-changelog.1
lustre/doc/lfs-df.1
lustre/doc/lfs-fid2path.1
lustre/doc/lfs-find.1
lustre/doc/lfs-flushctx.1
lustre/doc/lfs-getdirstripe.1
lustre/doc/lfs-getname.1
lustre/doc/lfs-getsom.1
lustre/doc/lfs-getstripe.1