Whamcloud - gitweb
LU-4315 doc: updating lctl-[e-lf] man page style 28/56028/10
authorFrederick Dilger <fdilger@whamcloud.com>
Tue, 13 Aug 2024 23:19:59 +0000 (17:19 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 16 Sep 2024 15:08:53 +0000 (15:08 +0000)
commitc57ba5bfc437ac62328b69f1371d366571c2d12d
tree164544f545e1ee013553eace3a53097080b562e1
parentdf01caa1cae35067ab31bb238f70c3358e646925
LU-4315 doc: updating lctl-[e-lf] 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-erase_lcfg.8
- lctl-fork_lcfg.8
- lctl-get_param.8
- lctl-lcfg_clear.8
- lctl-lcfg_erase.8
- lctl-lcfg_fork.8
- lctl-lfsck-query.8
- lctl-lfsck-start.8
- lctl-lfsck-stop.8

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: Ie4c66833f9aa577d1b6f57cbb079211450efdd4c
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56028
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/Makefile.am
lustre/doc/lctl-get_param.8
lustre/doc/lctl-lcfg_clear.8
lustre/doc/lctl-lcfg_erase.8
lustre/doc/lctl-lcfg_fork.8
lustre/doc/lctl-lfsck-query.8
lustre/doc/lctl-lfsck-start.8
lustre/doc/lctl-lfsck-stop.8
lustre/doc/lctl-lfsck_query.8 [new file with mode: 0644]
lustre/doc/lctl-lfsck_start.8 [new file with mode: 0644]
lustre/doc/lctl-lfsck_stop.8 [new file with mode: 0644]