[LU-14118] man reports "unknown subject" for many lustre manpages Created: 05/Nov/20 Updated: 05/May/22 Resolved: 13/Apr/22 |
|
| Status: | Resolved |
| Project: | Lustre |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Bug | Priority: | Minor |
| Reporter: | John Hammond | Assignee: | WC Triage |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Issue Links: |
|
||||||||
| Severity: | 3 | ||||||||
| Rank (Obsolete): | 9223372036854775807 | ||||||||
| Description |
$ man -k lfs lfs (1) - client utility for Lustre-specific file layout and other attributes lfs-df (1) - (unknown subject) lfs-find (1) - Lustre client utility to list files with specific attributes lfs-getdirstripe (1) - (unknown subject) lfs-getstripe (1) - (unknown subject) lfs-hsm (1) - (unknown subject) lfs-ladvise (1) - (unknown subject) lfs-migrate (1) - (unknown subject) lfs-mirror-create (1) - (unknown subject) lfs-mirror-extend (1) - (unknown subject) lfs-mirror-resync (1) - (unknown subject) lfs-mirror-split (1) - (unknown subject) lfs-mirror-verify (1) - (unknown subject) lfs-mkdir (1) - set striping pattern of a directory. lfs-project (1) - (unknown subject) lfs-setdirstripe (1) - set striping pattern of a directory. lfs-setquota (1) - (unknown subject) lfs-setstripe (1) - (unknown subject) lfs_migrate (1) - migrate files between Lustre OSTs According to https://redmine.auroville.org.in/issues/824 the text before the - in the NAME section must be a single word (double quoting did not work). Changing 'lfs df' to 'lfs-df' in the NAME section has the desired effect. |
| Comments |
| Comment by Andreas Dilger [ 28/Apr/21 ] |
|
Running mandb on my RHEL8.3 server + Lustre 2.14.0 reports: mandb: warning: /usr/share/man/man8/lctl-barrier.8.gz: whatis parse for lctl-barrier(8) failed mandb: warning: /usr/share/man/man8/lctl-lcfg.8.gz: whatis parse for lctl-lcfg(8) failed mandb: warning: /usr/share/man/man8/lctl-lfsck-query.8.gz: whatis parse for lctl-lfsck-query(8) failed mandb: warning: /usr/share/man/man8/lctl-lfsck-start.8.gz: whatis parse for lctl-lfsck-start(8) failed mandb: warning: /usr/share/man/man8/lctl-lfsck-stop.8.gz: whatis parse for lctl-lfsck-stop(8) failed mandb: warning: /usr/share/man/man8/lctl-snapshot-create.8.gz: whatis parse for lctl-snapshot-create(8) failed mandb: warning: /usr/share/man/man8/lctl-snapshot-destroy.8.gz: whatis parse for lctl-snapshot-destroy(8) failed mandb: warning: /usr/share/man/man8/lctl-snapshot-list.8.gz: whatis parse for lctl-snapshot-list(8) failed mandb: warning: /usr/share/man/man8/lctl-snapshot-modify.8.gz: whatis parse for lctl-snapshot-modify(8) failed mandb: warning: /usr/share/man/man8/lctl-snapshot-mount.8.gz: whatis parse for lctl-snapshot-mount(8) failed mandb: warning: /usr/share/man/man8/lctl-snapshot-umount.8.gz: whatis parse for lctl-snapshot-umount(8) failed mandb: warning: /usr/share/man/man8/lnetctl.8.gz: whatis parse for lnetctl(8) failed Interestingly, on RHEL6.10 clients, "man -k lfs" works as expected, so the "(unknown subject)" issue must be a newer change (I see this same problem on RHEL8): man -k lfs Devel::SelfStubber (3pm) - generate stubs for a SelfLoading module lfs (1) - client utility for Lustre-specific file layout and other attributes lfsck (8) - check a Lustre distributed filesystem lfs df [lfs-df] (1) - report Lustre filesystem disk usage lfs-find (1) - Lustre client utility to list files with specific attributes lfs flushctx [lfs-flushctx] (1) - flush security context of current user lfs getdirstripe [lfs-getdirstripe] (1) - list the layout pattern of a given directory : |
| Comment by Andreas Dilger [ 13/Apr/22 ] |
|
Fixed by patch https://review.whamcloud.com/41075 "LU-930 doc: fix format man page sections for lctl". |