Whamcloud - gitweb
LU-4315 doc: add man pages to checkpatch 54/55954/54
authorFrederick Dilger <fdilger@whamcloud.com>
Wed, 7 Aug 2024 09:34:02 +0000 (03:34 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 16 Sep 2024 15:08:36 +0000 (15:08 +0000)
commitd15955d374d5c2e927dd4dd8d0d223707ee52e42
tree086b1504183cfd0ef4028db1a47ee00121628096
parent790c14ea05c7df5b23a3b8549c9bbba5e7fb3fcf
LU-4315 doc: add man pages to checkpatch

Add formatting rules for Lustre Manual pages to checkpatch.
This will encourage not only a uniform formatting for new manual
pages, but it will help when updating older manual pages to ensure
they are following new formatting style.

Note that there is a new AVAILABILITY section that is required for
all pages. This section should include the release and commit
versions that the subject of the page was added.
The checkpatch-man.pl script will generate version based on
what appear in the NAME section of the manual which is also
a required section. This only occurs if the AVAILABILITY
section already exists but is missing either "release X.X.X"
or "commit X.X.X-*"

Using the following pages as guidelines for creating style
rules for man pages:
https://liw.fi/manpages/
https://man7.org/linux/man-pages/man7/man-pages.7.html

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: I5bd7af0cdbeb49a9edc07d0cc2f8a0dccca39a9e
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/55954
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Timothy Day <timday@amazon.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
contrib/scripts/checkpatch-man.pl [new file with mode: 0755]
contrib/scripts/checkpatch.pl
contrib/scripts/lustre-checkpatch.patch
contrib/scripts/spelling-man.txt [new file with mode: 0644]