From 288de5ead43b421f4b368bddd4091a2968833118 Mon Sep 17 00:00:00 2001 From: Oleg Drokin Date: Wed, 7 Aug 2024 17:51:51 -0400 Subject: [PATCH] LU-18110 doc: grammar fixes in llapi changelog and pcc man pages There are some minor grammar issues there highighted by my latest toy. Test-Parameters: trivial Change-Id: Ib37d30acf9bbabb6c71158d0658a18224997a177 Signed-off-by: Oleg Drokin Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/55960 Reviewed-by: Andreas Dilger Tested-by: jenkins Tested-by: Maloo --- lustre/doc/llapi_changelog_get_fd.3 | 2 +- lustre/doc/llapi_changelog_in_buf.3 | 2 +- lustre/doc/llapi_pcc_clear.3 | 2 +- lustre/doc/llapi_pcc_del.3 | 2 +- lustre/doc/llapi_pcc_detach_fid_fd.3 | 11 +++++------ lustre/doc/llapi_pcc_state_get.3 | 4 ++-- 6 files changed, 11 insertions(+), 12 deletions(-) diff --git a/lustre/doc/llapi_changelog_get_fd.3 b/lustre/doc/llapi_changelog_get_fd.3 index a9396a1..d178979 100644 --- a/lustre/doc/llapi_changelog_get_fd.3 +++ b/lustre/doc/llapi_changelog_get_fd.3 @@ -11,7 +11,7 @@ llapi_changelog_get_fd \- Return the file descriptor of the changelog device .PP The function .B llapi_changelog_get_fd() -return the file descriptor of changelog char device for the instance +returns the file descriptor of changelog char device for the instance .IR priv . .PP This can be used to call diff --git a/lustre/doc/llapi_changelog_in_buf.3 b/lustre/doc/llapi_changelog_in_buf.3 index 6e8cf61..749ca37 100644 --- a/lustre/doc/llapi_changelog_in_buf.3 +++ b/lustre/doc/llapi_changelog_in_buf.3 @@ -21,7 +21,7 @@ with can be used to dequeue all the changelog records still in the read buffer. .SH RETURN VALUES .PP -Return 1 if changelogs records are present in the internal read buffer, +Returns 1 if changelogs records are present in the internal read buffer, otherwise return 0. .SH "SEE ALSO" .BR llapi_changelog_clear (3) diff --git a/lustre/doc/llapi_pcc_clear.3 b/lustre/doc/llapi_pcc_clear.3 index bbdd678..952eb59 100644 --- a/lustre/doc/llapi_pcc_clear.3 +++ b/lustre/doc/llapi_pcc_clear.3 @@ -14,7 +14,7 @@ The function .BR llapi_pcc_clear() deletes all PCC backends on the client with the mount point referenced by .IR mntpath . -Refer +Refer to .BR llapi_pcc_del() for the usage of the input parameter .IR flags . diff --git a/lustre/doc/llapi_pcc_del.3 b/lustre/doc/llapi_pcc_del.3 index d3fb187..cd63525 100644 --- a/lustre/doc/llapi_pcc_del.3 +++ b/lustre/doc/llapi_pcc_del.3 @@ -16,7 +16,7 @@ deletes a PCC backend referenced by .IR pccpath on the client with the mount point of .IR mntpath . -By default, when remove a PCC backend from a client, the action is to scan the +By default, when removing a PCC backend from a client, the action is to scan the PCC backend fs, uncache (detach and remove) all scanned PCC copies from PCC by FIDs. The input parameter .IR flags diff --git a/lustre/doc/llapi_pcc_detach_fid_fd.3 b/lustre/doc/llapi_pcc_detach_fid_fd.3 index 736f236..aee5ea3 100644 --- a/lustre/doc/llapi_pcc_detach_fid_fd.3 +++ b/lustre/doc/llapi_pcc_detach_fid_fd.3 @@ -24,19 +24,18 @@ llapi_pcc_detach_file \- detach the given file from PCC .BR llapi_pcc_detach_fid_str() , and .BR llapi_pcc_detach_file() -detach a cached file from PCC by an ioctl on the dir or the file itself. The -file is referenced -by +detach a cached file from PCC by an ioctl on the directory or the file itself. +The file is referenced by .IR fid , .IR fidstr , or .IR path . -The dir, which usually a mount point dir that the copytool already has opened, -is referenced by +The directory, which is usually a mount point that the copytool +already has opened, is referenced by .IR dirfd , .IR mntpath , .IR path . -The detach flags is specified by +The detach flags are specified by .IR flags argument, which is a .B enum lu_pcc_detach_flags diff --git a/lustre/doc/llapi_pcc_state_get.3 b/lustre/doc/llapi_pcc_state_get.3 index 2d2a9d2..ca4cab0 100644 --- a/lustre/doc/llapi_pcc_state_get.3 +++ b/lustre/doc/llapi_pcc_state_get.3 @@ -12,11 +12,11 @@ related to a file .fi .SH DESCRIPTION .PP -The function +The functions .BR llapi_pcc_state_get() and .BR llapi_pcc_state_get_fd() -returns the PCC state information for the file referenced by +return the PCC state information for the file referenced by .IR path or .IR fd . -- 1.8.3.1