Whamcloud - gitweb
LU-4315 doc: updating llapi-[cr-f] man page style 38/56138/3
authorFrederick Dilger <fdilger@whamcloud.com>
Fri, 23 Aug 2024 16:24:33 +0000 (10:24 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 16 Sep 2024 15:11:36 +0000 (15:11 +0000)
commit351537f9861f214a7502c5c9114ef2a0ccaf45f3
treeceff16be390428b23b422ed95458dd8814e3e882
parent005da89eae3d3a9143806356aa69167e1e18630b
LU-4315 doc: updating llapi-[cr-f] 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_create_volatile_param.3
- llapi_fd2parent.3
- llapi_fid_parse.3
- llapi_fid_to_handle.3
- llapi_file_create.3
- llapi_file_create_foreign.3
- llapi_file_get_stripe.3
- llapi_file_open.3

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: I9b9728e9611da455cb4ff61f424f4b976c533b36
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56138
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
lustre/doc/llapi_create_volatile_param.3
lustre/doc/llapi_fid_parse.3
lustre/doc/llapi_fid_to_handle.3
lustre/doc/llapi_file_create_foreign.3
lustre/doc/llapi_file_get_stripe.3
lustre/doc/llapi_file_open.3