LU-930 docs: fix whatis output

The ".SH NAME" section has to be formatted in a certain
way for whatis and apropos to work correctly. Otherwise,
users will just see "(unknown subject)".

This patch fixes issues for all man pages.

Add a couple of one-line man page redirects.

Test-Parameters: trivial
Signed-off-by: Timothy Day <timday@amazon.com>
Change-Id: Ie11eb921c84ff9ad19b50973c616f6fb6df1f461
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/50264
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>

diff --git a/lustre/doc/Makefile.am b/lustre/doc/Makefile.am
index af50ace..c0e4031 100644 (file)
--- a/lustre/doc/Makefile.am
+++ b/lustre/doc/Makefile.am
@@ -55,7 +55,8 @@ MANFILES =                                    \
        lfs-getname.1                           \
        lfs-getsom.1                            \
        lfs-getstripe.1                         \
-       lfs-heat.1                              \
+       lfs-heat_get.1                          \
+       lfs-heat_set.1                          \
        lfs-hsm.1                               \
        lfs-hsm_action.1                        \
        lfs-hsm_clear.1                         \
@@ -76,6 +77,7 @@ MANFILES =                                    \
        lfs-mkdir.1                             \
        lfs-path2fid.1                          \
        lfs-pcc-detach.1                        \
+       lfs-pcc-state.1                         \
        lfs-pcc.1                               \
        lfs-project.1                           \
        lfs-quota.1                             \

diff --git a/lustre/doc/lctl-del_ost.8 b/lustre/doc/lctl-del_ost.8
index e5fab71..7c9450b 100644 (file)
--- a/lustre/doc/lctl-del_ost.8
+++ b/lustre/doc/lctl-del_ost.8
@@ -1,6 +1,6 @@
 .TH lctl-del_ost 8 "2022-06-13" Lustre "configuration utilities"
 .SH NAME
-lctl del_ost \- permanently delete OST records
+lctl-del_ost \- permanently delete OST records
 .SH SYNOPSIS
 .B lctl del_ost
 .RB "[ --dryrun ]"

diff --git a/lustre/doc/lctl-device_list.8 b/lustre/doc/lctl-device_list.8
index b693b9c..293b751 100644 (file)
--- a/lustre/doc/lctl-device_list.8
+++ b/lustre/doc/lctl-device_list.8
@@ -1,6 +1,6 @@
 .TH lctl-device_list 8 "2023-01-09" Lustre "configuration utilities"
 .SH NAME
-lctl device_list \- show all local Lustre Object Based Devices
+lctl-device_list \- show all local Lustre Object Based Devices
 .SH SYNOPSIS
 .B lctl device_list
 .RB "[ --target|-t ]"

diff --git a/lustre/doc/lfs-changelog.1 b/lustre/doc/lfs-changelog.1
index c2c7374..bb35a70 100644 (file)
--- a/lustre/doc/lfs-changelog.1
+++ b/lustre/doc/lfs-changelog.1
@@ -1,6 +1,6 @@
 .TH lfs-changelog 1 "2022-11-22" Lustre "user utilities"
 .SH NAME
-lfs changelog, lfs changelog_clear \- client utility to read and clear Lustre changelogs
+lfs-changelog, lfs-changelog_clear \- client utility to read and clear Lustre changelogs
 .SH SYNOPSIS
 .br
 .B lfs changelog \fR[\fB--follow\fR] \fIMDTNAME\fR [\fISTARTREC \fR[\fIENDREC\fR]]

diff --git a/lustre/doc/lfs-df.1 b/lustre/doc/lfs-df.1
index e55f00f..8306769 100644 (file)
--- a/lustre/doc/lfs-df.1
+++ b/lustre/doc/lfs-df.1
@@ -1,6 +1,6 @@
 .TH lfs-df 1 "2016 Dec 7" Lustre "user utilities"
 .SH NAME
-lfs df \- report Lustre filesystem disk usage
+lfs-df \- report Lustre filesystem disk usage
 .SH SYNOPSIS
 .BR "lfs df" " [" -i "] [" -h | -H ]
 .RB [ --lazy | -l ]

diff --git a/lustre/doc/lfs-fid2path.1 b/lustre/doc/lfs-fid2path.1
index e33487f..b554d35 100644 (file)
--- a/lustre/doc/lfs-fid2path.1
+++ b/lustre/doc/lfs-fid2path.1
@@ -1,6 +1,6 @@
 .TH lfs-fid2path 1 "2018-11-24" Lustre "user utilities"
 .SH NAME
-lfs fid2path \- print the pathname(s) for a file identifier
+lfs-fid2path \- print the pathname(s) for a file identifier
 .SH SYNOPSIS
 .BR "lfs fid2path "
 [\fI\,OPTION\/\fR]... <\fI\,FSNAME\/\fR|\fI\,MOUNT_POINT\/\fR> <\fI\,FID\/\fR>...

diff --git a/lustre/doc/lfs-flushctx.1 b/lustre/doc/lfs-flushctx.1
index 75e784c..04c768f 100644 (file)
--- a/lustre/doc/lfs-flushctx.1
+++ b/lustre/doc/lfs-flushctx.1
@@ -1,6 +1,6 @@
 .TH LFS-FLUSHCTX 1 2021-01-04 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs flushctx \- flush security context of current user.
+lfs-flushctx \- flush security context of current user.
 .SH SYNOPSIS
 .B lfs flushctx
 .RB [ --help | -h "] [" -k "] [" -r "] [" \fIrootpath\fR "]"

diff --git a/lustre/doc/lfs-getdirstripe.1 b/lustre/doc/lfs-getdirstripe.1
index f2a4537..b3d50aa 100644 (file)
--- a/lustre/doc/lfs-getdirstripe.1
+++ b/lustre/doc/lfs-getdirstripe.1
@@ -1,6 +1,6 @@
 .TH LFS-GETDIRSTRIPE 1 2017-11-07 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs getdirstripe \- list the layout pattern of a given directory
+lfs-getdirstripe \- list the layout pattern of a given directory
 .SH SYNOPSIS
 .BR "lfs getdirstripe" " [" -cDhHimOrTXvy "]... " \fIDIR\fR...
 .SH DESCRIPTION

diff --git a/lustre/doc/lfs-getname.1 b/lustre/doc/lfs-getname.1
index f6ff53e..0b0217a 100644 (file)
--- a/lustre/doc/lfs-getname.1
+++ b/lustre/doc/lfs-getname.1
@@ -1,6 +1,6 @@
 .TH LFS-GETSOM 1 2018-10-04 "Lustre" "lustre Utilities"
 .SH NAME
-lfs getname \- retrieve the filesystem name and instance ID
+lfs-getname \- retrieve the filesystem name and instance ID
 .SH SYNOPSIS
 .B lfs getname
 .RB [ --help | -h "] [" --instance | -i "] [" --fsname | -n ]

diff --git a/lustre/doc/lfs-getsom.1 b/lustre/doc/lfs-getsom.1
index 64e2164..e9fba5a 100644 (file)
--- a/lustre/doc/lfs-getsom.1
+++ b/lustre/doc/lfs-getsom.1
@@ -1,6 +1,6 @@
 .TH LFS-GETSOM 1 2018-10-04 "Lustre" "lustre Utilities"
 .SH NAME
-lfs getsom \- list file attributes that are stored on an MDS
+lfs-getsom \- list file attributes that are stored on an MDS
 .SH SYNOPSIS
 .B lfs getsom
 [\fB\-s\fR | \fB\-b\fR | \fB\-f\fR] <file>

diff --git a/lustre/doc/lfs-getstripe.1 b/lustre/doc/lfs-getstripe.1
index 768a277..3a9c461 100644 (file)
--- a/lustre/doc/lfs-getstripe.1
+++ b/lustre/doc/lfs-getstripe.1
@@ -1,6 +1,6 @@
 .TH lfs-getstripe 1 "2018-01-24" Lustre "user utilities"
 .SH NAME
-lfs getstripe \- Lustre client command to print layout parameters of a file
+lfs-getstripe \- Lustre client command to print layout parameters of a file
 .SH SYNOPSIS
 .B lfs getstripe
 [\fB--component-count\fR|\fB--comp-count\fR]

diff --git a/lustre/doc/lfs-heat.1 b/lustre/doc/lfs-heat_get.1
similarity index 94%
rename from lustre/doc/lfs-heat.1
rename to lustre/doc/lfs-heat_get.1
index 752a182..761d069 100644 (file)
--- a/lustre/doc/lfs-heat.1
+++ b/lustre/doc/lfs-heat_get.1
@@ -1,7 +1,6 @@
 .TH lfs-heat 1 "Feb. 09, 2019" Lustre "Lustre utility"
 .SH NAME
-.B lfs heat_command
-lfs commands used to interact with file heat features
+lfs-heat_get, lfs-heat_set \- commands used to interact with file heat features
 .SH SYNOPSIS
 .B lfs heat_get|heat_set
 .IR \fR<\fIFILE \fR...>

diff --git a/lustre/doc/lfs-heat_set.1 b/lustre/doc/lfs-heat_set.1
new file mode 100644 (file)
index 0000000..405b8e0
--- /dev/null
+++ b/lustre/doc/lfs-heat_set.1
@@ -0,0 +1 @@
+.so man1/lfs-heat.1

diff --git a/lustre/doc/lfs-ladvise.1 b/lustre/doc/lfs-ladvise.1
index c6a1f05..26d3339 100644 (file)
--- a/lustre/doc/lfs-ladvise.1
+++ b/lustre/doc/lfs-ladvise.1
@@ -1,6 +1,6 @@
 .TH LFS-LADVISE 1 2015-11-30 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs ladvise \- give file access advices or hints to server.
+lfs-ladvise \- give file access advices or hints to server.
 .SH SYNOPSIS
 .br
 .B lfs ladvise [--advice|-a ADVICE ] [--background|-b]

diff --git a/lustre/doc/lfs-migrate.1 b/lustre/doc/lfs-migrate.1
index 02dd7bb..43fc9e4 100644 (file)
--- a/lustre/doc/lfs-migrate.1
+++ b/lustre/doc/lfs-migrate.1
@@ -1,6 +1,6 @@
 .TH LFS-MIGRATE 1 2021-11-08 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs migrate \- migrate files or directories between MDTs or OSTs.
+lfs-migrate \- migrate files or directories between MDTs or OSTs.
 .SH SYNOPSIS
 .B lfs migrate
 .RB [ -h "] [" -v ]

diff --git a/lustre/doc/lfs-mirror-copy.1 b/lustre/doc/lfs-mirror-copy.1
index 68bef53..5439237 100644 (file)
--- a/lustre/doc/lfs-mirror-copy.1
+++ b/lustre/doc/lfs-mirror-copy.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-COPY 1 2018-09-23 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror copy \- copy a mirror's content to other mirror(s) of a mirrored file
+lfs-mirror-copy \- copy a mirror's content to other mirror(s) of a mirrored file
 .SH SYNOPSIS
 .B lfs mirror copy
 {\fB\-\-read-mirror|\-i\fR <\fIid0\fR>}

diff --git a/lustre/doc/lfs-mirror-create.1 b/lustre/doc/lfs-mirror-create.1
index 5d18c3b..3ccb839 100644 (file)
--- a/lustre/doc/lfs-mirror-create.1
+++ b/lustre/doc/lfs-mirror-create.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-CREATE 1 2017-07-25 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror create \- create a mirrored file or directory
+lfs-mirror-create \- create a mirrored file or directory
 .SH SYNOPSIS
 .B lfs mirror create
 <\fB\-\-mirror\-count\fR|\fB\-N\fR[\fImirror_count\fR]>

diff --git a/lustre/doc/lfs-mirror-delete.1 b/lustre/doc/lfs-mirror-delete.1
index 00d4982..b03043a 100644 (file)
--- a/lustre/doc/lfs-mirror-delete.1
+++ b/lustre/doc/lfs-mirror-delete.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-DELETE 1 2019-09-15 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror delete \- delete a specified mirror from an existing mirrored file
+lfs-mirror-delete \- delete a specified mirror from an existing mirrored file
 .SH SYNOPSIS
 .B lfs mirror delete
 {\fB\-\-mirror\-id\fR <\fImirror_id\fR> | \fB\-\-component\-id\fR|\

diff --git a/lustre/doc/lfs-mirror-extend.1 b/lustre/doc/lfs-mirror-extend.1
index 3063d00..1e00df4 100644 (file)
--- a/lustre/doc/lfs-mirror-extend.1
+++ b/lustre/doc/lfs-mirror-extend.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-EXTEND 1 2017-07-25 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror extend \- add mirror(s) to an existing file
+lfs-mirror-extend \- add mirror(s) to an existing file
 .SH SYNOPSIS
 .B lfs mirror extend
 [\fB\-\-no\-verify\fR]

diff --git a/lustre/doc/lfs-mirror-read.1 b/lustre/doc/lfs-mirror-read.1
index bde75cc..b71b72b 100644 (file)
--- a/lustre/doc/lfs-mirror-read.1
+++ b/lustre/doc/lfs-mirror-read.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-READ 1 2018-08-16 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror read \- read a mirror's content of a mirrored file
+lfs-mirror-read \- read a mirror's content of a mirrored file
 .SH SYNOPSIS
 .B lfs mirror read
 {\fB\-\-mirror-id|\-N\fR <\fImirror_id\fR>}

diff --git a/lustre/doc/lfs-mirror-resync.1 b/lustre/doc/lfs-mirror-resync.1
index 23d4849..34f4cac 100644 (file)
--- a/lustre/doc/lfs-mirror-resync.1
+++ b/lustre/doc/lfs-mirror-resync.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-RESYNC 1 2017-07-25 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror resync \- resynchronize an out-of-sync mirrored file
+lfs-mirror-resync \- resynchronize an out-of-sync mirrored file
 .SH SYNOPSIS
 .B lfs mirror resync
 [\fB\-\-only\fR <\fImirror_id\fR[,...]>]

diff --git a/lustre/doc/lfs-mirror-split.1 b/lustre/doc/lfs-mirror-split.1
index 9dd5daa..eaeb196 100644 (file)
--- a/lustre/doc/lfs-mirror-split.1
+++ b/lustre/doc/lfs-mirror-split.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-SPLIT 1 2017-07-25 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror split \- split a specified mirror from an existing mirrored file
+lfs-mirror-split \- split a specified mirror from an existing mirrored file
 .SH SYNOPSIS
 .B lfs mirror split
 {\fB\-\-mirror\-id\fR <\fImirror_id\fR> | \fB\-\-component\-id\fR|\

diff --git a/lustre/doc/lfs-mirror-verify.1 b/lustre/doc/lfs-mirror-verify.1
index a73edc4..d9da8c7 100644 (file)
--- a/lustre/doc/lfs-mirror-verify.1
+++ b/lustre/doc/lfs-mirror-verify.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-VERIFY 1 2017-07-25 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror verify \- verify mirrored file(s)
+lfs-mirror-verify \- verify mirrored file(s)
 .SH SYNOPSIS
 .B lfs mirror verify
 [\fB\-\-only\fR <\fImirror_id\fR,\fImirror_id2\fR[,...]>]

diff --git a/lustre/doc/lfs-mirror-write.1 b/lustre/doc/lfs-mirror-write.1
index 2faa402..979b99c 100644 (file)
--- a/lustre/doc/lfs-mirror-write.1
+++ b/lustre/doc/lfs-mirror-write.1
@@ -1,6 +1,6 @@
 .TH LFS-MIRROR-WRITE 1 2018-09-23 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs mirror write \- write a mirror's content of a mirrored file
+lfs-mirror-write \- write a mirror's content of a mirrored file
 .SH SYNOPSIS
 .B lfs mirror write
 {\fB\-\-mirror-id|\-N\fR <\fImirror_id\fR>}

diff --git a/lustre/doc/lfs-path2fid.1 b/lustre/doc/lfs-path2fid.1
index 22e4b65..5aa1d17 100644 (file)
--- a/lustre/doc/lfs-path2fid.1
+++ b/lustre/doc/lfs-path2fid.1
@@ -1,6 +1,6 @@
 .TH lfs-path2fid 1 "2018-11-24" Lustre "user utilities"
 .SH NAME
-lfs path2fid \- print the file identifier for a given pathname
+lfs-path2fid \- print the file identifier for a given pathname
 .SH SYNOPSIS
 .BR "lfs path2fid " [ --parents ]
 .RI < directory | file > ...

diff --git a/lustre/doc/lfs-pcc-detach.1 b/lustre/doc/lfs-pcc-detach.1
index 7ac48c9..fca82a5 100644 (file)
--- a/lustre/doc/lfs-pcc-detach.1
+++ b/lustre/doc/lfs-pcc-detach.1
@@ -1,6 +1,6 @@
 .TH LFS-PCC-DETACH 1 2019-04-15 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs pcc detach|detach_fid \- Detach given files from PCC
+lfs-pcc-detach, lfs-pcc-detach_fid \- Detach given files from PCC
 .SH SYNOPSIS
 .B lfs pcc detach [\fB--keep\fR|\fB-k\fR] <\fIfile \fR...>
 .br

diff --git a/lustre/doc/lfs-pcc-state.1 b/lustre/doc/lfs-pcc-state.1
new file mode 100644 (file)
index 0000000..99dc3b2
--- /dev/null
+++ b/lustre/doc/lfs-pcc-state.1
@@ -0,0 +1 @@
+.so man1/lfs-pcc.1

diff --git a/lustre/doc/lfs-pcc.1 b/lustre/doc/lfs-pcc.1
index 886a96d..bf679ed 100644 (file)
--- a/lustre/doc/lfs-pcc.1
+++ b/lustre/doc/lfs-pcc.1
@@ -1,6 +1,6 @@
 .TH LFS-PCC 1 2019-04-15 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs pcc commands used to interact with the Persistent Client Cache (PCC).
+lfs-pcc \- commands used to interact with the Persistent Client Cache (PCC).
 .SH SYNOPSIS
 .B lfs pcc attach <\fB--id\fR|\fB-i\fR \fINUM\fR>  <\fIfile \fR...>
 .br

diff --git a/lustre/doc/lfs-project.1 b/lustre/doc/lfs-project.1
index 9b2c4ed..ec2fe89 100644 (file)
--- a/lustre/doc/lfs-project.1
+++ b/lustre/doc/lfs-project.1
@@ -1,6 +1,6 @@
 .TH LFS-PROJECT 1 2017-10-26 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs project \- Change or list project attribute for specified file or directory.
+lfs-project \- Change or list project attribute for specified file or directory.
 .SH SYNOPSIS
 .BR "lfs project" " [" -d | -r ] " "< \fI file | directory...\fR>
 .br

diff --git a/lustre/doc/lfs-quota.1 b/lustre/doc/lfs-quota.1
index 18d8761..05ba99f 100644 (file)
--- a/lustre/doc/lfs-quota.1
+++ b/lustre/doc/lfs-quota.1
@@ -1,6 +1,6 @@
 .TH LFS-QUOTA 1 2020-04-06 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs quota \- display quota limits and status for users, groups, or projects.
+lfs-quota \- display quota limits and status for users, groups, or projects.
 .SH SYNOPSIS
 .B lfs quota \fR[\fB-hqv\fR]
        [\fB-o <\fIobd_uuid\fR>|\fB-I <\fIost_idx\fR>|\fB-i <\fImdt_idx\fR>]

diff --git a/lustre/doc/lfs-rmfid.1 b/lustre/doc/lfs-rmfid.1
index 38b5b62..cd30928 100644 (file)
--- a/lustre/doc/lfs-rmfid.1
+++ b/lustre/doc/lfs-rmfid.1
@@ -1,6 +1,6 @@
 .TH LFS-RMFID 1 2017-07-25 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs rmfid \- remove file by FID
+lfs-rmfid \- remove file by FID
 .SH SYNOPSIS
 .B lfs rmfid
 <\fIdirectory\fR> <\fIFID1\fR> [<\fIFID2\fR>...]

diff --git a/lustre/doc/lfs-setquota.1 b/lustre/doc/lfs-setquota.1
index ff3dbd9..71349d2 100644 (file)
--- a/lustre/doc/lfs-setquota.1
+++ b/lustre/doc/lfs-setquota.1
@@ -1,6 +1,6 @@
 .TH LFS-SETQUOTA 1 2017-07-21 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs setquota \- set quota limits or grace time for users, groups or projects.
+lfs-setquota \- set quota limits or grace time for users, groups or projects.
 .SH SYNOPSIS
 .BR "lfs setquota " { -u | --user | -g | --group | -p | --projid "} " \fIUID | \fIGID | \fIPROJID
        [\fB--pool \fIPOOLNAME ]

diff --git a/lustre/doc/lfs-setstripe.1 b/lustre/doc/lfs-setstripe.1
index 4212d1a..fa5ba29 100644 (file)
--- a/lustre/doc/lfs-setstripe.1
+++ b/lustre/doc/lfs-setstripe.1
@@ -1,6 +1,6 @@
 .TH LFS-SETSTRIPE 1 2017-08-23 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs setstripe \- set striping pattern of a file or directory default
+lfs-setstripe \- set striping pattern of a file or directory default
 .SH SYNOPSIS
 .B lfs setstripe \fR[\fISTRIPE_OPTIONS\fR] <\fIdirectory\fR|\fIfile\fR>
 .br