Skip to content

Commit 890d569

Browse files
kovanmartinetd
authored andcommitted
9p: document missing enum values in kernel-doc comments
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> Message-ID: <20260315190633.73536-1-xaum.io@gmail.com> Signed-off-by: Dominique Martinet <asmadeus@codewreck.org>
1 parent da2346a commit 890d569

1 file changed

Lines changed: 35 additions & 3 deletions

File tree

include/net/9p/9p.h

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
* @P9_DEBUG_PKT: packet marshalling/unmarshalling
2525
* @P9_DEBUG_FSC: FS-cache tracing
2626
* @P9_DEBUG_VPKT: Verbose packet debugging (full packet dump)
27+
* @P9_DEBUG_CACHE: cache operations tracing
28+
* @P9_DEBUG_MMAP: memory-mapped I/O tracing
2729
*
2830
* These flags are passed at mount time to turn on various levels of
2931
* 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,
6870
* @P9_RSYMLINK: make symlink response
6971
* @P9_TMKNOD: create a special file object request
7072
* @P9_RMKNOD: create a special file object response
73+
* @P9_TLOPEN: open a file for I/O (9P2000.L)
74+
* @P9_RLOPEN: response with qid and iounit (9P2000.L)
7175
* @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L
7276
* @P9_RLCREATE: response with file access information for 9P2000.L
7377
* @P9_TRENAME: rename request
7478
* @P9_RRENAME: rename response
75-
* @P9_TMKDIR: create a directory request
76-
* @P9_RMKDIR: create a directory response
77-
* @P9_TVERSION: version handshake request
79+
* @P9_TREADLINK: read symbolic link target (9P2000.L)
80+
* @P9_RREADLINK: response with symbolic link target (9P2000.L)
81+
* @P9_TGETATTR: get file attributes request (9P2000.L)
82+
* @P9_RGETATTR: get file attributes response (9P2000.L)
83+
* @P9_TSETATTR: set file attributes request (9P2000.L)
84+
* @P9_RSETATTR: set file attributes response (9P2000.L)
85+
* @P9_TXATTRWALK: prepare to read/list extended attributes (9P2000.L)
86+
* @P9_RXATTRWALK: response with extended attribute size (9P2000.L)
87+
* @P9_TXATTRCREATE: prepare to set extended attribute (9P2000.L)
88+
* @P9_RXATTRCREATE: set extended attribute response (9P2000.L)
89+
* @P9_TREADDIR: read directory entries request (9P2000.L)
90+
* @P9_RREADDIR: read directory entries response (9P2000.L)
91+
* @P9_TFSYNC: flush cached file data to storage request (9P2000.L)
92+
* @P9_RFSYNC: flush cached file data to storage response (9P2000.L)
93+
* @P9_TLOCK: acquire or release a POSIX record lock (9P2000.L)
94+
* @P9_RLOCK: POSIX record lock response (9P2000.L)
95+
* @P9_TGETLOCK: test for existence of POSIX record lock (9P2000.L)
96+
* @P9_RGETLOCK: POSIX record lock test response (9P2000.L)
97+
* @P9_TLINK: create a hard link (9P2000.L)
98+
* @P9_RLINK: hard link response (9P2000.L)
99+
* @P9_TRENAMEAT: safely rename across directories (9P2000.L)
100+
* @P9_RRENAMEAT: rename response (9P2000.L)
101+
* @P9_TUNLINKAT: unlink a file or directory (9P2000.L)
102+
* @P9_RUNLINKAT: unlink response (9P2000.L)
103+
* @P9_TMKDIR: create a directory request (9P2000.L)
104+
* @P9_RMKDIR: create a directory response (9P2000.L)
105+
* @P9_TVERSION: negotiate protocol version and message size
78106
* @P9_RVERSION: version handshake response
79107
* @P9_TAUTH: request to establish authentication channel
80108
* @P9_RAUTH: response with authentication information
@@ -194,6 +222,10 @@ enum p9_msg_t {
194222
* @P9_ORCLOSE: remove the file when the file is closed
195223
* @P9_OAPPEND: open the file and seek to the end
196224
* @P9_OEXCL: only create a file, do not open it
225+
* @P9L_MODE_MASK: mask for protocol mode bits (client-side only)
226+
* @P9L_DIRECT: disable client-side caching for this file
227+
* @P9L_NOWRITECACHE: disable write caching for this file
228+
* @P9L_LOOSE: enable loose cache consistency
197229
*
198230
* 9P open modes differ slightly from Posix standard modes.
199231
* In particular, there are extra modes which specify different

0 commit comments

Comments
 (0)