git: 7bdde516fc2b - stable/13 - vnode.9: Document vnode_if.awk and vnode_if.src

The branch stable/13 has been updated by 0mp:

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

commit 7bdde516fc2b1ab828e2c4a9c473ba30018b30c7
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2024-10-09 10:04:36 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2024-10-28 12:46:05 +0000

    vnode.9: Document vnode_if.awk and vnode_if.src
    
    Discussed with: bjk, imp
    Reviewed by:    kib
    MFC after:      2 weeks
    Differential Revision:  https://reviews.freebsd.org/D27196
    
    (cherry picked from commit e018265679389cfcebe172d4bf61aa4fe4f58b0a)
---
 share/man/man9/vnode.9 | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

diff --git a/share/man/man9/vnode.9 b/share/man/man9/vnode.9
index 6befe7337b94..c4bfab5f849f 100644
--- a/share/man/man9/vnode.9
+++ b/share/man/man9/vnode.9
@@ -24,7 +24,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd February 12, 2014
+.Dd October 9, 2024
 .Dt VNODE 9
 .Os
 .Sh NAME
@@ -104,9 +104,21 @@ the vnode.
 The
 .Va v_op
 field is used by the
-.Dv VOP_*
-macros to call functions in the file system which implement the vnode's
+.Fn VOP_*
+functions to call functions in the file system which implement the vnode's
 functionality.
+.Pp
+The
+.Fn VOP_*
+function declarations and definitions are generated from
+.Pa sys/kern/vnode_if.src
+by the
+.Pa sys/tools/vndoe_if.awk
+script.
+The interfaces are documented in their respective manual pages like
+.Xr VOP_READ 9
+and
+.Xr VOP_WRITE 9 .
 .Sh VNODE TYPES
 .Bl -tag -width VSOCK
 .It Dv VNON
@@ -154,6 +166,16 @@ when holding a
 .Nm
 interlock, will cause a LOR (Lock Order Reversal) due to the
 intertwining of VM Objects and Vnodes.
+.Sh FILES
+.Bl -tag -width "sys/tools/vnode_if.awk" -compact
+.It Pa sys/kern/vnode_if.src
+The input file for
+.Pa sys/tools/vnode_if.awk .
+.It Pa sys/tools/vnode_if.awk
+The script generating the source code of the
+.Fn VOP_*
+functions.
+.El
 .Sh SEE ALSO
 .Xr malloc 9 ,
 .Xr VFS 9 ,