Whamcloud - gitweb
LU-4315 doc: updating llapi-[o-u] man page style 88/56188/4
authorFrederick Dilger <fdilger@whamcloud.com>
Wed, 28 Aug 2024 15:52:49 +0000 (09:52 -0600)
committerOleg Drokin <green@whamcloud.com>
Mon, 2 Dec 2024 05:48:18 +0000 (05:48 +0000)
commitd67847d049e250d0d06bd092af9bda1f9825500f
tree0eca6ac4eea94f7645dcc335305112ced6e82c75
parentc791602d1e000bacee6fa871ac15e715ed1363d1
LU-4315 doc: updating llapi-[o-u] 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_open_by_fid.3
- llapi_open_by_fid_at.3
- llapi_param_get_paths.3
- llapi_param_get_value.3
- llapi_path2fid.3
- llapi_path2parent.3
- llapi_pcc_attach.3
- llapi_pcc_attach_fid.3
- llapi_pcc_attach_fid_str.3
- llapi_pcc_clear.3
- llapi_pcc_del.3
- llapi_pcc_detach_fid.3
- llapi_pcc_detach_fid_fd.3
- llapi_pcc_detach_fid_str.3
- llapi_pcc_detach_file.3
- llapi_pccdev_get.3
- llapi_pccdev_set.3
- llapi_pcc_state_get.3
- llapi_pcc_state_get_fd.3
- llapi_quotactl.3
- llapi_rmfid.3
- llapi_rmfid_at.3
- llapi_root_path_open.3
- llapi_search_mdt.3
- llapi_search_ost.3
- llapi_search_rootpath.3
- llapi_search_rootpath_by_dev.3
- llapi_search_tgt.3
- llapi_unlink_foreign.3

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: Ia31335f543b306c4b2081401133555c5a55401e0
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56188
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>
19 files changed:
lustre/doc/llapi_open_by_fid.3
lustre/doc/llapi_param_get_paths.3
lustre/doc/llapi_param_get_value.3
lustre/doc/llapi_path2fid.3
lustre/doc/llapi_path2parent.3
lustre/doc/llapi_pcc_attach.3
lustre/doc/llapi_pcc_clear.3
lustre/doc/llapi_pcc_del.3
lustre/doc/llapi_pcc_detach_fid_fd.3
lustre/doc/llapi_pcc_state_get.3
lustre/doc/llapi_pccdev_get.3
lustre/doc/llapi_pccdev_set.3
lustre/doc/llapi_quotactl.3
lustre/doc/llapi_rmfid.3
lustre/doc/llapi_root_path_open.3
lustre/doc/llapi_search_rootpath.3
lustre/doc/llapi_search_rootpath_by_dev.3
lustre/doc/llapi_search_tgt.3
lustre/doc/llapi_unlink_foreign.3