Whamcloud - gitweb
LU-4315 doc: updating llapi-[g-h] man page style 70/56170/4
authorFrederick Dilger <fdilger@whamcloud.com>
Mon, 26 Aug 2024 22:54:36 +0000 (16:54 -0600)
committerOleg Drokin <green@whamcloud.com>
Sat, 22 Feb 2025 23:41:11 +0000 (23:41 +0000)
commitd0a47cd7704cbd6fa8723e08f494880b83a68078
tree9efad54cac5b4bedfdb20e8b87c978de221951ea
parentc9042de70e93159c02bd94f5b2d92c27157767cb
LU-4315 doc: updating llapi-[g-h] 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_get_fsname.3
- llapi_get_fsname_instance.3
- llapi_get_instance.3
- llapi_get_lum_dir.3
- llapi_get_lum_dir_fd.3
- llapi_get_lum_file.3
- llapi_get_lum_file_fd.3
- llapi_getname.3
- llapi_group_lock.3
- llapi_group_unlock.3
- llapi_heat_get.3
- llapi_heat_set.3
- llapi_hsm_action_begin.3
- llapi_hsm_action_end.3
- llapi_hsm_action_get_dfid.3
- llapi_hsm_action_get_fd.3
- llapi_hsm_action_progress.3
- llapi_hsm_copytool_get_fd.3
- llapi_hsm_copytool_recv.3
- llapi_hsm_copytool_register.3
- llapi_hsm_copytool_unregister.3
- llapi_hsm_state_get.3
- llapi_hsm_state_set.3

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: I0b503f02f8d5b80a3888bd57676001f7a0bc1dc5
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56170
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
lustre/doc/llapi_get_fsname_instance.3
lustre/doc/llapi_get_lum_file_fd.3
lustre/doc/llapi_group_lock.3
lustre/doc/llapi_heat_get.3
lustre/doc/llapi_hsm_action_begin.3
lustre/doc/llapi_hsm_copytool_register.3
lustre/doc/llapi_hsm_state_get.3
lustre/doc/llapi_hsm_state_set.3