Whamcloud - gitweb
LU-4315 doc: updating llapi-[i-l] man page style 71/56171/6
authorFrederick Dilger <fdilger@whamcloud.com>
Tue, 27 Aug 2024 17:58:46 +0000 (11:58 -0600)
committerOleg Drokin <green@whamcloud.com>
Wed, 25 Sep 2024 04:06:38 +0000 (04:06 +0000)
commit59bbec814c4ee5cac2c52fabde6ea1f39d072c06
tree7fd02266677b625cd657a0d6acf8e420759e3f8e
parent14e981db6cba0ee27af574e14ecc8965b9dfdd4e
LU-4315 doc: updating llapi-[i-l] 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_ioctl.3
- llapi_ladvise.3
- llapi_layout.7
- llapi_layout_alloc.3
- llapi_layout_comp_add.3
- llapi_layout_comp_del.3
- llapi_layout_comp_extent_get.3
- llapi_layout_comp_extent_set.3
- llapi_layout_comp_flags_clear.3
- llapi_layout_comp_flags_get.3
- llapi_layout_comp_flags_set.3
- llapi_layout_comp_id_get.3
- llapi_layout_comp_use.3
- llapi_layout_comp_use_id.3
- llapi_layout_extension_size_get.3
- llapi_layout_extension_size_set.3
- llapi_layout_file_comp_add.3
- llapi_layout_file_comp_del.3
- llapi_layout_file_create.3
- llapi_layout_file_open.3

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: I9e475fa6f170a52000b220e5e90f7e6c39bee737
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56171
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
14 files changed:
lustre/doc/llapi_ioctl.3
lustre/doc/llapi_ladvise.3
lustre/doc/llapi_layout.7
lustre/doc/llapi_layout_alloc.3
lustre/doc/llapi_layout_comp_add.3
lustre/doc/llapi_layout_comp_extent_get.3
lustre/doc/llapi_layout_comp_flags_get.3
lustre/doc/llapi_layout_comp_id_get.3
lustre/doc/llapi_layout_comp_use.3
lustre/doc/llapi_layout_comp_use_id.3
lustre/doc/llapi_layout_extension_size_get.3
lustre/doc/llapi_layout_file_comp_add.3
lustre/doc/llapi_layout_file_comp_del.3
lustre/doc/llapi_layout_file_create.3