Whamcloud - gitweb
LU-4315 doc: updating lfs-[mirr] man page style 02/56102/14
authorFrederick Dilger <fdilger@whamcloud.com>
Thu, 15 Aug 2024 21:21:04 +0000 (15:21 -0600)
committerOleg Drokin <green@whamcloud.com>
Sun, 2 Feb 2025 06:24:46 +0000 (06:24 +0000)
commitedabcf5ee2fdea18d55ea86cfab2b6013de1d50a
tree3aaa0e677dad5c4e7dc664ce92173d2055e1d4dd
parent54e304b9b52b1ca78d8b4a947cbba3f746489bdb
LU-4315 doc: updating lfs-[mirr] 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-migrate.1
- lfs_migrate.1
- lfs-mirror-copy.1
- lfs-mirror-create.1
- lfs-mirror-delete.1
- lfs-mirror-extend.1
- lfs-mirror-read.1
- lfs-mirror-resync.1
- lfs-mirror-split.1
- lfs-mirror-verify.1
- lfs-mirror-write.1

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: I79cb0cdd33242cf39536f29d954ae0631559e7e3
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56102
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>
12 files changed:
lustre/doc/lfs-migrate.1
lustre/doc/lfs-mirror-copy.1
lustre/doc/lfs-mirror-create.1
lustre/doc/lfs-mirror-delete.1
lustre/doc/lfs-mirror-extend.1
lustre/doc/lfs-mirror-read.1
lustre/doc/lfs-mirror-resync.1
lustre/doc/lfs-mirror-split.1
lustre/doc/lfs-mirror-verify.1
lustre/doc/lfs-mirror-write.1
lustre/doc/lfs_migrate.1
lustre/utils/lfs.c