vnode.9: Document vnode_if.awk and vnode_if_src

[0mp]

Summary

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

MFC: 2 weeks

[bjk]

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

share/man/man9/vnode.9

162

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.

[kib]

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]

share/man/man9/vnode.9

167

BTW, .El is missing here.

[imp]

share/man/man9/vnode.9

162

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]

share/man/man9/vnode.9

162

Looks great! I'll post an update soon.

[0mp]

Incorporate feedback

[kib]

share/man/man9/vnode.9

110

In this line VOP_* are called macros. They are really functions, and this arguably should be fixed in the same commit.

115

165

[0mp]

Incorporate kib's feedback.

[0mp]

Thanks! I've updated the patch with the suggestions.