[src/trunk]: src/sys/kern vn_open(9): Clarify that this returns a locked vnode.

[riastradh <riastradh%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/c7a0affab378
branches:  trunk
changeset: 373873:c7a0affab378
user:      riastradh <riastradh%NetBSD.org@localhost>
date:      Mon Mar 13 18:12:52 2023 +0000

description:
vn_open(9): Clarify that this returns a locked vnode.

Comment only, no functional change intended.

diffstat:

 sys/kern/vfs_vnops.c |  8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diffs (29 lines):

diff -r ce3aa648d9bd -r c7a0affab378 sys/kern/vfs_vnops.c
--- a/sys/kern/vfs_vnops.c      Mon Mar 13 11:52:29 2023 +0000
+++ b/sys/kern/vfs_vnops.c      Mon Mar 13 18:12:52 2023 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: vfs_vnops.c,v 1.235 2022/08/06 21:21:10 riastradh Exp $        */
+/*     $NetBSD: vfs_vnops.c,v 1.236 2023/03/13 18:12:52 riastradh Exp $        */
 
 /*-
  * Copyright (c) 2009 The NetBSD Foundation, Inc.
@@ -66,7 +66,7 @@
  */
 
 #include <sys/cdefs.h>
-__KERNEL_RCSID(0, "$NetBSD: vfs_vnops.c,v 1.235 2022/08/06 21:21:10 riastradh Exp $");
+__KERNEL_RCSID(0, "$NetBSD: vfs_vnops.c,v 1.236 2023/03/13 18:12:52 riastradh Exp $");
 
 #include "veriexec.h"
 
@@ -150,8 +150,8 @@
  *
  * XXX shouldn't cmode be mode_t?
  *
- * On success produces either a vnode in *ret_vp, or if that is NULL,
- * a file descriptor number in ret_fd.
+ * On success produces either a locked vnode in *ret_vp, or NULL in
+ * *ret_vp and a file descriptor number in *ret_fd.
  *
  * The caller may pass NULL for ret_fd (and ret_domove), in which case
  * EOPNOTSUPP will be produced in the cases that would otherwise return