vnode.9: Document vnode_if.awk and vnode_if_src
ClosedPublic
Actions

Authored by 0mp on Nov 12 2020, 5:36 PM.

Details

Reviewers

kib
mjg

Group Reviewers

manpages
Contributor Reviews (src)

Commits

rGa94328b63c20: vnode.9: Document vnode_if.awk and vnode_if.src
rG7bdde516fc2b: vnode.9: Document vnode_if.awk and vnode_if.src
rGe01826567938: vnode.9: Document vnode_if.awk and vnode_if.src

Summary

Point developers to vnode_if.awk when they look for functions like VOP_READ

MFC: 2 weeks

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 59871
Build 56756: arc lint + arc unit

Event Timeline

0mp created this revision.Nov 12 2020, 5:36 PM

Herald added a reviewer: manpages. · View Herald TranscriptNov 12 2020, 5:36 PM

Herald added a subscriber: imp. · View Herald Transcript

0mp requested review of this revision.Nov 12 2020, 5:36 PM

Harbormaster completed remote builds in B34765: Diff 79476.Nov 12 2020, 5:36 PM

0mp edited the summary of this revision. (Show Details)Nov 12 2020, 5:42 PM

0mp added a reviewer: Contributor Reviews (src).

0mp added reviewers: kib, mjg.Nov 12 2020, 6:58 PM

The mdoc is fine, so okay from manpages, but see inline comment.

share/man/man9/vnode.9
172	It's generally better if we can provide explicit definition rather than definition by analogy to examples. So maybe something like "generates the vnode operation wrapper function implementations, e.g.," is better.

I think it is even more confusing that the vnode_if.c and vnode_if.h files are generated in the kernel build directory, which makes grep in kernel sources confusing.
It would be useful to point out where to look for generated code.

0mp added inline comments.Oct 8 2024, 12:42 PM

share/man/man9/vnode.9
177	BTW, .El is missing here.

imp added inline comments.Oct 8 2024, 3:31 PM

share/man/man9/vnode.9

172

Agreed. Maybe something like the following would be better?

The
.Fn VOP_*
functions are generated from
.Pa sys/kern/vnode_if.src
by the
.Pa sys/kern/vndoe_if.awk
script.
The interfaces are documented in their respective manual pages like
.Xr VOP_READ 9
and
.Xr VOP_WRITE 9 .

0mp added inline comments.Oct 9 2024, 10:04 AM

share/man/man9/vnode.9
172	Looks great! I'll post an update soon.

0mp retitled this revision from Point developers to vnode_if.awk when they look for functions like VOP_READ to vnode.9: Document vnode_if.awk and vnode_if_src.Oct 9 2024, 10:08 AM