Bug 253894 - Missing man pages for recently added VOPs
Summary: Missing man pages for recently added VOPs
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL:
Keywords: needs-patch
Depends on:
Blocks:
 
Reported: 2021-02-27 15:20 UTC by Robert Watson
Modified: 2021-03-03 03:49 UTC (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Robert Watson freebsd_committer 2021-02-27 15:20:56 UTC
Historically, there was a man page for [pretty much] each vnode operation in section 9 -- e.g., VOP_READ(9), VOP_GETATTR(9), etc. However, some more recently added operations appear to be without them:

  VOP_FPLOOKUP_VEXEC
  VOP_FPLOOKUP_SYMLINK
  VOP_MMAPPED
  VOP_NEED_INACTIVE
  VOP_READ_PGCACHE

A few older VOPs also lack man pages:

  VOP_CACHEDLOOKUP
  VOP_POLL
  VOP_SETLABEL          (Arguably my fault, and I'll aim to fix that.)

It would also be nice if VOP_PANIC had a man page.
Comment 1 Robert Watson freebsd_committer 2021-02-27 17:04:22 UTC
I've now added one for VOP_SETLABEL(9) in 7bfd84444e6f.  The others are probably in someone else's jurisdiction.
Comment 2 Konstantin Belousov freebsd_committer 2021-02-28 01:14:17 UTC
The whole VFS pages in section 9 are so out of date that I am not sure if it is
worth the efforts.

Anyway, I added https://reviews.freebsd.org/D28980
Comment 3 commit-hook freebsd_committer 2021-02-28 23:39:05 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=55eb51ab6649c3c10bf201f82a4ec410fe4da4a2

commit 55eb51ab6649c3c10bf201f82a4ec410fe4da4a2
Author:     Konstantin Belousov <kib@FreeBSD.org>
AuthorDate: 2021-02-28 01:08:37 +0000
Commit:     Konstantin Belousov <kib@FreeBSD.org>
CommitDate: 2021-02-28 23:38:33 +0000

    Add VOP_READ_PGCACHE(9)

    PR:     253894
    Reviewed by:    gbe, rwatson
    Sponsored by:   The FreeBSD Foundation
    MFC after:      3 days
    Differential Revision:  https://reviews.freebsd.org/D28980

 share/man/man9/Makefile                 |   1 +
 share/man/man9/VOP_RDWR.9               |   1 +
 share/man/man9/VOP_READ_PGCACHE.9 (new) | 134 ++++++++++++++++++++++++++++++++
 share/man/man9/vnode.9                  |   1 +
 4 files changed, 137 insertions(+)
Comment 4 commit-hook freebsd_committer 2021-03-03 03:49:30 UTC
A commit in branch stable/13 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=c79e239ceedae35b63334cc2879fb7a771224d0f

commit c79e239ceedae35b63334cc2879fb7a771224d0f
Author:     Konstantin Belousov <kib@FreeBSD.org>
AuthorDate: 2021-02-28 01:08:37 +0000
Commit:     Konstantin Belousov <kib@FreeBSD.org>
CommitDate: 2021-03-03 03:07:59 +0000

    Add VOP_READ_PGCACHE(9)

    PR:     253894

    (cherry picked from commit 55eb51ab6649c3c10bf201f82a4ec410fe4da4a2)

 share/man/man9/Makefile                 |   1 +
 share/man/man9/VOP_RDWR.9               |   1 +
 share/man/man9/VOP_READ_PGCACHE.9 (new) | 134 ++++++++++++++++++++++++++++++++
 share/man/man9/vnode.9                  |   1 +
 4 files changed, 137 insertions(+)