Whamcloud - gitweb
LU-4315 doc: updating llapi-[cha] man page style 31/56131/3
authorFrederick Dilger <fdilger@whamcloud.com>
Thu, 22 Aug 2024 21:20:29 +0000 (15:20 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 2 Dec 2024 05:47:52 +0000 (05:47 +0000)
commit219c0bec564605a96314830fd12a1e8d8d9477f0
tree11376e8385886373b016b77a496a37701e215a8d
parent9f72288799364d85be49710c09784174928dc2aa
LU-4315 doc: updating llapi-[cha] 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:
- llapi_changelog_clear.3
- llapi_changelog_fini.3
- llapi_changelog_free.3
- llapi_changelog_get_fd.3
- llapi_changelog_in_buf.3
- llapi_changelog_recv.3
- llapi_changelog_set_xflags.3
- llapi_changelog_start.3

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: Id2b6f92811b8ffbe23fc7a902a14360b8cf583c5
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56131
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/llapi_changelog_clear.3
lustre/doc/llapi_changelog_get_fd.3
lustre/doc/llapi_changelog_in_buf.3
lustre/doc/llapi_changelog_recv.3
lustre/doc/llapi_changelog_start.3