Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
nilfs2: correct return value kernel-doc descriptions for bmap functions
Similar to the previous patch to fix the ioctl return value descriptions,
this fixes the format of the return value descriptions for bmap (and
btree)-related functions, which was causing the kernel-doc script to emit
a number of warnings.
Link: https://lkml.kernel.org/r/20250110010530.21872-3-konishi.ryusuke@gmail.com
Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Cc: "Brian G ." <gissf1@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
authored by
Ryusuke Konishi
and committed by
Andrew Morton
e4a99d48
17c46a45
+54
-73
+51
-69
fs/nilfs2/bmap.c
+51
-69
fs/nilfs2/bmap.c
···
47
47
* @ptrp: place to store the value associated to @key
48
48
*
49
49
* Description: nilfs_bmap_lookup_at_level() finds a record whose key
50
-
* matches @key in the block at @level of the bmap.
50
+
* matches @key in the block at @level of the bmap. The record associated
51
+
* with @key is stored in the place pointed to by @ptrp.
51
52
*
52
-
* Return Value: On success, 0 is returned and the record associated with @key
53
-
* is stored in the place pointed by @ptrp. On error, one of the following
54
-
* negative error codes is returned.
55
-
*
56
-
* %-EIO - I/O error.
57
-
*
58
-
* %-ENOMEM - Insufficient amount of memory available.
59
-
*
60
-
* %-ENOENT - A record associated with @key does not exist.
53
+
* Return: 0 on success, or one of the following negative error codes on
54
+
* failure:
55
+
* * %-EIO - I/O error (including metadata corruption).
56
+
* * %-ENOENT - A record associated with @key does not exist.
57
+
* * %-ENOMEM - Insufficient memory available.
61
58
*/
62
59
int nilfs_bmap_lookup_at_level(struct nilfs_bmap *bmap, __u64 key, int level,
63
60
__u64 *ptrp)
···
135
138
* Description: nilfs_bmap_insert() inserts the new key-record pair specified
136
139
* by @key and @rec into @bmap.
137
140
*
138
-
* Return Value: On success, 0 is returned. On error, one of the following
139
-
* negative error codes is returned.
140
-
*
141
-
* %-EIO - I/O error.
142
-
*
143
-
* %-ENOMEM - Insufficient amount of memory available.
144
-
*
145
-
* %-EEXIST - A record associated with @key already exist.
141
+
* Return: 0 on success, or one of the following negative error codes on
142
+
* failure:
143
+
* * %-EEXIST - A record associated with @key already exists.
144
+
* * %-EIO - I/O error (including metadata corruption).
145
+
* * %-ENOMEM - Insufficient memory available.
146
146
*/
147
147
int nilfs_bmap_insert(struct nilfs_bmap *bmap, __u64 key, unsigned long rec)
148
148
{
···
187
193
* Description: nilfs_bmap_seek_key() seeks a valid key on @bmap
188
194
* starting from @start, and stores it to @keyp if found.
189
195
*
190
-
* Return Value: On success, 0 is returned. On error, one of the following
191
-
* negative error codes is returned.
192
-
*
193
-
* %-EIO - I/O error.
194
-
*
195
-
* %-ENOMEM - Insufficient amount of memory available.
196
-
*
197
-
* %-ENOENT - No valid entry was found
196
+
* Return: 0 on success, or one of the following negative error codes on
197
+
* failure:
198
+
* * %-EIO - I/O error (including metadata corruption).
199
+
* * %-ENOENT - No valid entry was found.
200
+
* * %-ENOMEM - Insufficient memory available.
198
201
*/
199
202
int nilfs_bmap_seek_key(struct nilfs_bmap *bmap, __u64 start, __u64 *keyp)
200
203
{
···
227
236
* Description: nilfs_bmap_delete() deletes the key-record pair specified by
228
237
* @key from @bmap.
229
238
*
230
-
* Return Value: On success, 0 is returned. On error, one of the following
231
-
* negative error codes is returned.
232
-
*
233
-
* %-EIO - I/O error.
234
-
*
235
-
* %-ENOMEM - Insufficient amount of memory available.
236
-
*
237
-
* %-ENOENT - A record associated with @key does not exist.
239
+
* Return: 0 on success, or one of the following negative error codes on
240
+
* failure:
241
+
* * %-EIO - I/O error (including metadata corruption).
242
+
* * %-ENOENT - A record associated with @key does not exist.
243
+
* * %-ENOMEM - Insufficient memory available.
238
244
*/
239
245
int nilfs_bmap_delete(struct nilfs_bmap *bmap, __u64 key)
240
246
{
···
278
290
* Description: nilfs_bmap_truncate() removes key-record pairs whose keys are
279
291
* greater than or equal to @key from @bmap.
280
292
*
281
-
* Return Value: On success, 0 is returned. On error, one of the following
282
-
* negative error codes is returned.
283
-
*
284
-
* %-EIO - I/O error.
285
-
*
286
-
* %-ENOMEM - Insufficient amount of memory available.
293
+
* Return: 0 on success, or one of the following negative error codes on
294
+
* failure:
295
+
* * %-EIO - I/O error (including metadata corruption).
296
+
* * %-ENOMEM - Insufficient memory available.
287
297
*/
288
298
int nilfs_bmap_truncate(struct nilfs_bmap *bmap, __u64 key)
289
299
{
···
316
330
* Description: nilfs_bmap_propagate() marks the buffers that directly or
317
331
* indirectly refer to the block specified by @bh dirty.
318
332
*
319
-
* Return Value: On success, 0 is returned. On error, one of the following
320
-
* negative error codes is returned.
321
-
*
322
-
* %-EIO - I/O error.
323
-
*
324
-
* %-ENOMEM - Insufficient amount of memory available.
333
+
* Return: 0 on success, or one of the following negative error codes on
334
+
* failure:
335
+
* * %-EIO - I/O error (including metadata corruption).
336
+
* * %-ENOMEM - Insufficient memory available.
325
337
*/
326
338
int nilfs_bmap_propagate(struct nilfs_bmap *bmap, struct buffer_head *bh)
327
339
{
···
346
362
347
363
/**
348
364
* nilfs_bmap_assign - assign a new block number to a block
349
-
* @bmap: bmap
350
-
* @bh: pointer to buffer head
365
+
* @bmap: bmap
366
+
* @bh: place to store a pointer to the buffer head to which a block
367
+
* address is assigned (in/out)
351
368
* @blocknr: block number
352
-
* @binfo: block information
369
+
* @binfo: block information
353
370
*
354
371
* Description: nilfs_bmap_assign() assigns the block number @blocknr to the
355
-
* buffer specified by @bh.
372
+
* buffer specified by @bh. The block information is stored in the memory
373
+
* pointed to by @binfo, and the buffer head may be replaced as a block
374
+
* address is assigned, in which case a pointer to the new buffer head is
375
+
* stored in the memory pointed to by @bh.
356
376
*
357
-
* Return Value: On success, 0 is returned and the buffer head of a newly
358
-
* create buffer and the block information associated with the buffer are
359
-
* stored in the place pointed by @bh and @binfo, respectively. On error, one
360
-
* of the following negative error codes is returned.
361
-
*
362
-
* %-EIO - I/O error.
363
-
*
364
-
* %-ENOMEM - Insufficient amount of memory available.
377
+
* Return: 0 on success, or one of the following negative error codes on
378
+
* failure:
379
+
* * %-EIO - I/O error (including metadata corruption).
380
+
* * %-ENOMEM - Insufficient memory available.
365
381
*/
366
382
int nilfs_bmap_assign(struct nilfs_bmap *bmap,
367
383
struct buffer_head **bh,
···
386
402
* Description: nilfs_bmap_mark() marks the block specified by @key and @level
387
403
* as dirty.
388
404
*
389
-
* Return Value: On success, 0 is returned. On error, one of the following
390
-
* negative error codes is returned.
391
-
*
392
-
* %-EIO - I/O error.
393
-
*
394
-
* %-ENOMEM - Insufficient amount of memory available.
405
+
* Return: 0 on success, or one of the following negative error codes on
406
+
* failure:
407
+
* * %-EIO - I/O error (including metadata corruption).
408
+
* * %-ENOMEM - Insufficient memory available.
395
409
*/
396
410
int nilfs_bmap_mark(struct nilfs_bmap *bmap, __u64 key, int level)
397
411
{
···
412
430
* Description: nilfs_test_and_clear() is the atomic operation to test and
413
431
* clear the dirty state of @bmap.
414
432
*
415
-
* Return Value: 1 is returned if @bmap is dirty, or 0 if clear.
433
+
* Return: 1 if @bmap is dirty, or 0 if clear.
416
434
*/
417
435
int nilfs_bmap_test_and_clear_dirty(struct nilfs_bmap *bmap)
418
436
{
···
472
490
*
473
491
* Description: nilfs_bmap_read() initializes the bmap @bmap.
474
492
*
475
-
* Return Value: On success, 0 is returned. On error, the following negative
476
-
* error code is returned.
477
-
*
478
-
* %-ENOMEM - Insufficient amount of memory available.
493
+
* Return: 0 on success, or one of the following negative error codes on
494
+
* failure:
495
+
* * %-EIO - I/O error (corrupted bmap).
496
+
* * %-ENOMEM - Insufficient memory available.
479
497
*/
480
498
int nilfs_bmap_read(struct nilfs_bmap *bmap, struct nilfs_inode *raw_inode)
481
499
{
+3
-4
fs/nilfs2/btree.c
+3
-4
fs/nilfs2/btree.c
···
334
334
* @inode: host inode of btree
335
335
* @blocknr: block number
336
336
*
337
-
* Return Value: If node is broken, 1 is returned. Otherwise, 0 is returned.
337
+
* Return: 0 if normal, 1 if the node is broken.
338
338
*/
339
339
static int nilfs_btree_node_broken(const struct nilfs_btree_node *node,
340
340
size_t size, struct inode *inode,
···
366
366
* @node: btree root node to be examined
367
367
* @inode: host inode of btree
368
368
*
369
-
* Return Value: If node is broken, 1 is returned. Otherwise, 0 is returned.
369
+
* Return: 0 if normal, 1 if the root node is broken.
370
370
*/
371
371
static int nilfs_btree_root_broken(const struct nilfs_btree_node *node,
372
372
struct inode *inode)
···
652
652
* @minlevel: start level
653
653
* @nextkey: place to store the next valid key
654
654
*
655
-
* Return Value: If a next key was found, 0 is returned. Otherwise,
656
-
* -ENOENT is returned.
655
+
* Return: 0 if the next key was found, %-ENOENT if not found.
657
656
*/
658
657
static int nilfs_btree_get_next_key(const struct nilfs_bmap *btree,
659
658
const struct nilfs_btree_path *path,