Skip to content

Commit fc76b59

Browse files
andrealmeidbrauner
authored andcommitted
exportfs: Mark struct export_operations functions at kernel-doc
Adding a `@` before the function names make then recognizable as kernel-docs, so they get correctly rendered in the documentation. Even if they are already marked with `@` in the short one-line summary, the kernel-docs will correctly favor the more detailed definition here. Signed-off-by: André Almeida <andrealmeid@igalia.com> Link: https://patch.msgid.link/20260112-tonyk-fs_uuid-v1-2-acc1889de772@igalia.com Reviewed-by: Chuck Lever <chuck.lever@oracle.com> Signed-off-by: Christian Brauner <brauner@kernel.org>
1 parent 5e7fa6b commit fc76b59

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

include/linux/exportfs.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ struct handle_to_path_ctx {
203203
* See Documentation/filesystems/nfs/exporting.rst for details on how to use
204204
* this interface correctly.
205205
*
206-
* encode_fh:
206+
* @encode_fh:
207207
* @encode_fh should store in the file handle fragment @fh (using at most
208208
* @max_len bytes) information that can be used by @decode_fh to recover the
209209
* file referred to by the &struct dentry @de. If @flag has CONNECTABLE bit
@@ -215,7 +215,7 @@ struct handle_to_path_ctx {
215215
* greater than @max_len*4 bytes). On error @max_len contains the minimum
216216
* size(in 4 byte unit) needed to encode the file handle.
217217
*
218-
* fh_to_dentry:
218+
* @fh_to_dentry:
219219
* @fh_to_dentry is given a &struct super_block (@sb) and a file handle
220220
* fragment (@fh, @fh_len). It should return a &struct dentry which refers
221221
* to the same file that the file handle fragment refers to. If it cannot,
@@ -227,29 +227,29 @@ struct handle_to_path_ctx {
227227
* created with d_alloc_root. The caller can then find any other extant
228228
* dentries by following the d_alias links.
229229
*
230-
* fh_to_parent:
230+
* @fh_to_parent:
231231
* Same as @fh_to_dentry, except that it returns a pointer to the parent
232232
* dentry if it was encoded into the filehandle fragment by @encode_fh.
233233
*
234-
* get_name:
234+
* @get_name:
235235
* @get_name should find a name for the given @child in the given @parent
236236
* directory. The name should be stored in the @name (with the
237237
* understanding that it is already pointing to a %NAME_MAX + 1 sized
238238
* buffer. get_name() should return %0 on success, a negative error code
239239
* or error. @get_name will be called without @parent->i_rwsem held.
240240
*
241-
* get_parent:
241+
* @get_parent:
242242
* @get_parent should find the parent directory for the given @child which
243243
* is also a directory. In the event that it cannot be found, or storage
244244
* space cannot be allocated, a %ERR_PTR should be returned.
245245
*
246-
* permission:
246+
* @permission:
247247
* Allow filesystems to specify a custom permission function.
248248
*
249-
* open:
249+
* @open:
250250
* Allow filesystems to specify a custom open function.
251251
*
252-
* commit_metadata:
252+
* @commit_metadata:
253253
* @commit_metadata should commit metadata changes to stable storage.
254254
*
255255
* Locking rules:

0 commit comments

Comments
 (0)