1. Patchew
  2. linux
  3. View series

[PATCH v2] 9p: document missing enum values in kernel-doc comments

Kit Dallege posted 1 patch 3 weeks, 1 day ago
There is a newer version of this series
include/net/9p/9p.h | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
[PATCH v2] 9p: document missing enum values in kernel-doc comments
Posted by Kit Dallege 3 weeks, 1 day ago 
Add kernel-doc entries for all undocumented enum values:
- p9_debug_flags: P9_DEBUG_CACHE, P9_DEBUG_MMAP
- p9_msg_t: all 9P2000.L message types (TLOPEN/RLOPEN through
  TUNLINKAT/RUNLINKAT)
- p9_open_mode_t: P9L_MODE_MASK, P9L_DIRECT, P9L_NOWRITECACHE,
  P9L_LOOSE

Assisted-by: Claude:claude-opus-4-6
Signed-off-by: Kit Dallege <xaum.io@gmail.com>
---
 include/net/9p/9p.h | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/include/net/9p/9p.h b/include/net/9p/9p.h
index 60cad0d200a4..6b645a0d3487 100644
--- a/include/net/9p/9p.h
+++ b/include/net/9p/9p.h
@@ -24,6 +24,8 @@
  * @P9_DEBUG_PKT: packet marshalling/unmarshalling
  * @P9_DEBUG_FSC: FS-cache tracing
  * @P9_DEBUG_VPKT: Verbose packet debugging (full packet dump)
+ * @P9_DEBUG_CACHE: cache operations tracing
+ * @P9_DEBUG_MMAP: memory-mapped I/O tracing
  *
  * These flags are passed at mount time to turn on various levels of
  * verbosity and tracing which will be output to the system logs.
@@ -68,10 +70,36 @@ void _p9_debug(enum p9_debug_flags level, const char *func,
  * @P9_RSYMLINK: make symlink response
  * @P9_TMKNOD: create a special file object request
  * @P9_RMKNOD: create a special file object response
+ * @P9_TLOPEN: open a file for I/O (9P2000.L)
+ * @P9_RLOPEN: response with file access information (9P2000.L)
  * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L
  * @P9_RLCREATE: response with file access information for 9P2000.L
  * @P9_TRENAME: rename request
  * @P9_RRENAME: rename response
+ * @P9_TREADLINK: read symbolic link request
+ * @P9_RREADLINK: read symbolic link response
+ * @P9_TGETATTR: get file attributes request (9P2000.L)
+ * @P9_RGETATTR: get file attributes response (9P2000.L)
+ * @P9_TSETATTR: set file attributes request (9P2000.L)
+ * @P9_RSETATTR: set file attributes response (9P2000.L)
+ * @P9_TXATTRWALK: walk to an extended attribute
+ * @P9_RXATTRWALK: response with extended attribute handle
+ * @P9_TXATTRCREATE: create an extended attribute
+ * @P9_RXATTRCREATE: response for extended attribute creation
+ * @P9_TREADDIR: read directory entries request
+ * @P9_RREADDIR: read directory entries response
+ * @P9_TFSYNC: flush file data to storage request
+ * @P9_RFSYNC: flush file data to storage response
+ * @P9_TLOCK: acquire or test a POSIX lock
+ * @P9_RLOCK: lock acquisition response
+ * @P9_TGETLOCK: get lock information
+ * @P9_RGETLOCK: lock information response
+ * @P9_TLINK: create a hard link
+ * @P9_RLINK: hard link response
+ * @P9_TRENAMEAT: rename using directory fids
+ * @P9_RRENAMEAT: rename response
+ * @P9_TUNLINKAT: unlink using directory fid
+ * @P9_RUNLINKAT: unlink response
  * @P9_TMKDIR: create a directory request
  * @P9_RMKDIR: create a directory response
  * @P9_TVERSION: version handshake request
@@ -194,6 +222,10 @@ enum p9_msg_t {
  * @P9_ORCLOSE: remove the file when the file is closed
  * @P9_OAPPEND: open the file and seek to the end
  * @P9_OEXCL: only create a file, do not open it
+ * @P9L_MODE_MASK: mask for protocol mode bits (client-side only)
+ * @P9L_DIRECT: disable client-side caching for this file
+ * @P9L_NOWRITECACHE: disable write caching for this file
+ * @P9L_LOOSE: enable loose cache consistency
  *
  * 9P open modes differ slightly from Posix standard modes.
  * In particular, there are extra modes which specify different
-- 
2.53.0
Re: [PATCH v2] 9p: document missing enum values in kernel-doc comments
Posted by Christian Schoenebeck 3 weeks, 1 day ago 
On Sunday, 15 March 2026 18:07:02 CET Kit Dallege wrote:
> Add kernel-doc entries for all undocumented enum values:
> - p9_debug_flags: P9_DEBUG_CACHE, P9_DEBUG_MMAP
> - p9_msg_t: all 9P2000.L message types (TLOPEN/RLOPEN through
>   TUNLINKAT/RUNLINKAT)
> - p9_open_mode_t: P9L_MODE_MASK, P9L_DIRECT, P9L_NOWRITECACHE,
>   P9L_LOOSE
> 
> Assisted-by: Claude:claude-opus-4-6

Of course. :)

> Signed-off-by: Kit Dallege <xaum.io@gmail.com>
> ---
>  include/net/9p/9p.h | 32 ++++++++++++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
> 
> diff --git a/include/net/9p/9p.h b/include/net/9p/9p.h
> index 60cad0d200a4..6b645a0d3487 100644
> --- a/include/net/9p/9p.h
> +++ b/include/net/9p/9p.h
> @@ -24,6 +24,8 @@
>   * @P9_DEBUG_PKT: packet marshalling/unmarshalling
>   * @P9_DEBUG_FSC: FS-cache tracing
>   * @P9_DEBUG_VPKT: Verbose packet debugging (full packet dump)
> + * @P9_DEBUG_CACHE: cache operations tracing
> + * @P9_DEBUG_MMAP: memory-mapped I/O tracing
>   *
>   * These flags are passed at mount time to turn on various levels of
>   * verbosity and tracing which will be output to the system logs.
> @@ -68,10 +70,36 @@ void _p9_debug(enum p9_debug_flags level, const char
> *func, * @P9_RSYMLINK: make symlink response
>   * @P9_TMKNOD: create a special file object request
>   * @P9_RMKNOD: create a special file object response
> + * @P9_TLOPEN: open a file for I/O (9P2000.L)
> + * @P9_RLOPEN: response with file access information (9P2000.L)

not really, it returns the QID and the iounit, that's it

>   * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L
>   * @P9_RLCREATE: response with file access information for 9P2000.L
>   * @P9_TRENAME: rename request
>   * @P9_RRENAME: rename response
> + * @P9_TREADLINK: read symbolic link request
> + * @P9_RREADLINK: read symbolic link response

9P2000.L

link *target* ?

> + * @P9_TGETATTR: get file attributes request (9P2000.L)
> + * @P9_RGETATTR: get file attributes response (9P2000.L)
> + * @P9_TSETATTR: set file attributes request (9P2000.L)
> + * @P9_RSETATTR: set file attributes response (9P2000.L)
> + * @P9_TXATTRWALK: walk to an extended attribute
> + * @P9_RXATTRWALK: response with extended attribute handle

9P2000.L

prepare to read/list extended attributes

> + * @P9_TXATTRCREATE: create an extended attribute
> + * @P9_RXATTRCREATE: response for extended attribute creation

*prepare* to set extended attribute.

9P2000.L

> + * @P9_TREADDIR: read directory entries request
> + * @P9_RREADDIR: read directory entries response

9P2000.L

> + * @P9_TFSYNC: flush file data to storage request
> + * @P9_RFSYNC: flush file data to storage response

flush *cached* file data ...

9P2000.L

> + * @P9_TLOCK: acquire or test a POSIX lock
> + * @P9_RLOCK: lock acquisition response

acquire or *release* ...

9P2000.L

> + * @P9_TGETLOCK: get lock information
> + * @P9_RGETLOCK: lock information response

test for existence of POSIX record lock

9P2000.L

> + * @P9_TLINK: create a hard link
> + * @P9_RLINK: hard link response

9P2000.L

> + * @P9_TRENAMEAT: rename using directory fids
> + * @P9_RRENAMEAT: rename response

9P2000.L

legacy TRENAME does also use fids. This is a safer variant of TRENAME.

> + * @P9_TUNLINKAT: unlink using directory fid
> + * @P9_RUNLINKAT: unlink response

9P2000.L

unlink a file or directory

>   * @P9_TMKDIR: create a directory request
>   * @P9_RMKDIR: create a directory response

9P2000.L

>   * @P9_TVERSION: version handshake request

negotiate 9p protocol version

9p2000.L: https://github.com/chaos/diod/blob/master/protocol.md
9p2000.u: http://ericvh.github.io/9p-rfc/rfc9p2000.u.html
9p2000:   http://ericvh.github.io/9p-rfc/rfc9p2000.html

Claude, RTFM!

> @@ -194,6 +222,10 @@ enum p9_msg_t {
>   * @P9_ORCLOSE: remove the file when the file is closed
>   * @P9_OAPPEND: open the file and seek to the end
>   * @P9_OEXCL: only create a file, do not open it
> + * @P9L_MODE_MASK: mask for protocol mode bits (client-side only)
> + * @P9L_DIRECT: disable client-side caching for this file
> + * @P9L_NOWRITECACHE: disable write caching for this file
> + * @P9L_LOOSE: enable loose cache consistency
>   *
>   * 9P open modes differ slightly from Posix standard modes.
>   * In particular, there are extra modes which specify different
[PATCH v3] 9p: document missing enum values in kernel-doc comments
Posted by Kit Dallege 3 weeks, 1 day ago 
Add kernel-doc entries for all undocumented enum values:
- p9_debug_flags: P9_DEBUG_CACHE, P9_DEBUG_MMAP
- p9_msg_t: all 9P2000.L message types (TLOPEN/RLOPEN through
  TUNLINKAT/RUNLINKAT)
- p9_open_mode_t: P9L_MODE_MASK, P9L_DIRECT, P9L_NOWRITECACHE,
  P9L_LOOSE

Assisted-by: Claude:claude-opus-4-6
Signed-off-by: Kit Dallege <xaum.io@gmail.com>
---
V2 -> V3: Address review from Christian Schoenebeck:
 - Fix descriptions to match 9P2000.L protocol spec
 - RLOPEN: returns qid and iounit, not generic "file access information"
 - TREADLINK/RREADLINK: read/return symbolic link target
 - TXATTRWALK: prepare to read/list, not "walk to"
 - TXATTRCREATE: prepare to set, not "create"
 - TFSYNC: flush *cached* file data
 - TLOCK: acquire or *release*, not "test"
 - TGETLOCK: test for existence of POSIX record lock
 - TRENAMEAT: safer variant of TRENAME, not "using directory fids"
 - TUNLINKAT: unlink a file or directory
 - TVERSION: negotiate protocol version and message size
 - Add missing (9P2000.L) tags to all 9P2000.L-specific entries
 - Add (9P2000.L) to pre-existing TMKDIR/RMKDIR entries

 include/net/9p/9p.h | 38 +++++++++++++++++++++++++++++++++++---
 1 file changed, 35 insertions(+), 3 deletions(-)

diff --git a/include/net/9p/9p.h b/include/net/9p/9p.h
index 60cad0d200a4..fd7a034b8278 100644
--- a/include/net/9p/9p.h
+++ b/include/net/9p/9p.h
@@ -24,6 +24,8 @@
  * @P9_DEBUG_PKT: packet marshalling/unmarshalling
  * @P9_DEBUG_FSC: FS-cache tracing
  * @P9_DEBUG_VPKT: Verbose packet debugging (full packet dump)
+ * @P9_DEBUG_CACHE: cache operations tracing
+ * @P9_DEBUG_MMAP: memory-mapped I/O tracing
  *
  * These flags are passed at mount time to turn on various levels of
  * verbosity and tracing which will be output to the system logs.
@@ -68,13 +70,39 @@ void _p9_debug(enum p9_debug_flags level, const char *func,
  * @P9_RSYMLINK: make symlink response
  * @P9_TMKNOD: create a special file object request
  * @P9_RMKNOD: create a special file object response
+ * @P9_TLOPEN: open a file for I/O (9P2000.L)
+ * @P9_RLOPEN: response with qid and iounit (9P2000.L)
  * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L
  * @P9_RLCREATE: response with file access information for 9P2000.L
  * @P9_TRENAME: rename request
  * @P9_RRENAME: rename response
- * @P9_TMKDIR: create a directory request
- * @P9_RMKDIR: create a directory response
- * @P9_TVERSION: version handshake request
+ * @P9_TREADLINK: read symbolic link target (9P2000.L)
+ * @P9_RREADLINK: response with symbolic link target (9P2000.L)
+ * @P9_TGETATTR: get file attributes request (9P2000.L)
+ * @P9_RGETATTR: get file attributes response (9P2000.L)
+ * @P9_TSETATTR: set file attributes request (9P2000.L)
+ * @P9_RSETATTR: set file attributes response (9P2000.L)
+ * @P9_TXATTRWALK: prepare to read/list extended attributes (9P2000.L)
+ * @P9_RXATTRWALK: response with extended attribute size (9P2000.L)
+ * @P9_TXATTRCREATE: prepare to set extended attribute (9P2000.L)
+ * @P9_RXATTRCREATE: set extended attribute response (9P2000.L)
+ * @P9_TREADDIR: read directory entries request (9P2000.L)
+ * @P9_RREADDIR: read directory entries response (9P2000.L)
+ * @P9_TFSYNC: flush cached file data to storage request (9P2000.L)
+ * @P9_RFSYNC: flush cached file data to storage response (9P2000.L)
+ * @P9_TLOCK: acquire or release a POSIX record lock (9P2000.L)
+ * @P9_RLOCK: POSIX record lock response (9P2000.L)
+ * @P9_TGETLOCK: test for existence of POSIX record lock (9P2000.L)
+ * @P9_RGETLOCK: POSIX record lock test response (9P2000.L)
+ * @P9_TLINK: create a hard link (9P2000.L)
+ * @P9_RLINK: hard link response (9P2000.L)
+ * @P9_TRENAMEAT: safely rename across directories (9P2000.L)
+ * @P9_RRENAMEAT: rename response (9P2000.L)
+ * @P9_TUNLINKAT: unlink a file or directory (9P2000.L)
+ * @P9_RUNLINKAT: unlink response (9P2000.L)
+ * @P9_TMKDIR: create a directory request (9P2000.L)
+ * @P9_RMKDIR: create a directory response (9P2000.L)
+ * @P9_TVERSION: negotiate protocol version and message size
  * @P9_RVERSION: version handshake response
  * @P9_TAUTH: request to establish authentication channel
  * @P9_RAUTH: response with authentication information
@@ -194,6 +222,10 @@ enum p9_msg_t {
  * @P9_ORCLOSE: remove the file when the file is closed
  * @P9_OAPPEND: open the file and seek to the end
  * @P9_OEXCL: only create a file, do not open it
+ * @P9L_MODE_MASK: mask for protocol mode bits (client-side only)
+ * @P9L_DIRECT: disable client-side caching for this file
+ * @P9L_NOWRITECACHE: disable write caching for this file
+ * @P9L_LOOSE: enable loose cache consistency
  *
  * 9P open modes differ slightly from Posix standard modes.
  * In particular, there are extra modes which specify different
-- 
2.53.0
Re: [PATCH v3] 9p: document missing enum values in kernel-doc comments
Posted by Christian Schoenebeck 2 weeks, 3 days ago 
On Sunday, 15 March 2026 20:06:33 CET Kit Dallege wrote:
> Add kernel-doc entries for all undocumented enum values:
> - p9_debug_flags: P9_DEBUG_CACHE, P9_DEBUG_MMAP
> - p9_msg_t: all 9P2000.L message types (TLOPEN/RLOPEN through
>   TUNLINKAT/RUNLINKAT)
> - p9_open_mode_t: P9L_MODE_MASK, P9L_DIRECT, P9L_NOWRITECACHE,
>   P9L_LOOSE
> 
> Assisted-by: Claude:claude-opus-4-6
> Signed-off-by: Kit Dallege <xaum.io@gmail.com>
> ---

Reviewed-by: Christian Schoenebeck <linux_oss@crudebyte.com>

Patchew 2.1-devel-ea86937

© 2016 - 2026 Red Hat, Inc.