Skip to content

Commit 4c431a7

Browse files
rddunlapaxboe
authored andcommitted
block: fix enum descriptions kernel-doc
Fix all kernel-doc warnings in blk_types.h: Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_READ' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_WRITE' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_FLUSH' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_DISCARD' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_SECURE_ERASE' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_ZONE_APPEND' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_WRITE_ZEROES' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_ZONE_OPEN' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_ZONE_CLOSE' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_ZONE_FINISH' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_ZONE_RESET' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_ZONE_RESET_ALL' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_DRV_IN' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_DRV_OUT' not described in enum 'req_op' Warning: include/linux/blk_types.h:371 Enum value 'REQ_OP_LAST' not described in enum 'req_op' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jens Axboe <axboe@kernel.dk>
1 parent 11506b3 commit 4c431a7

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

include/linux/blk_types.h

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -345,32 +345,33 @@ typedef __u32 __bitwise blk_mq_req_flags_t;
345345
* meaning.
346346
*/
347347
enum req_op {
348-
/* read sectors from the device */
348+
/** @REQ_OP_READ: read sectors from the device */
349349
REQ_OP_READ = (__force blk_opf_t)0,
350-
/* write sectors to the device */
350+
/** @REQ_OP_WRITE: write sectors to the device */
351351
REQ_OP_WRITE = (__force blk_opf_t)1,
352-
/* flush the volatile write cache */
352+
/** @REQ_OP_FLUSH: flush the volatile write cache */
353353
REQ_OP_FLUSH = (__force blk_opf_t)2,
354-
/* discard sectors */
354+
/** @REQ_OP_DISCARD: discard sectors */
355355
REQ_OP_DISCARD = (__force blk_opf_t)3,
356-
/* securely erase sectors */
356+
/** @REQ_OP_SECURE_ERASE: securely erase sectors */
357357
REQ_OP_SECURE_ERASE = (__force blk_opf_t)5,
358-
/* write data at the current zone write pointer */
358+
/** @REQ_OP_ZONE_APPEND: write data at the current zone write pointer */
359359
REQ_OP_ZONE_APPEND = (__force blk_opf_t)7,
360-
/* write the zero filled sector many times */
360+
/** @REQ_OP_WRITE_ZEROES: write the zero filled sector many times */
361361
REQ_OP_WRITE_ZEROES = (__force blk_opf_t)9,
362-
/* Open a zone */
362+
/** @REQ_OP_ZONE_OPEN: Open a zone */
363363
REQ_OP_ZONE_OPEN = (__force blk_opf_t)11,
364-
/* Close a zone */
364+
/** @REQ_OP_ZONE_CLOSE: Close a zone */
365365
REQ_OP_ZONE_CLOSE = (__force blk_opf_t)13,
366-
/* Transition a zone to full */
366+
/** @REQ_OP_ZONE_FINISH: Transition a zone to full */
367367
REQ_OP_ZONE_FINISH = (__force blk_opf_t)15,
368-
/* reset a zone write pointer */
368+
/** @REQ_OP_ZONE_RESET: reset a zone write pointer */
369369
REQ_OP_ZONE_RESET = (__force blk_opf_t)17,
370-
/* reset all the zone present on the device */
370+
/** @REQ_OP_ZONE_RESET_ALL: reset all the zone present on the device */
371371
REQ_OP_ZONE_RESET_ALL = (__force blk_opf_t)19,
372372

373373
/* Driver private requests */
374+
/* private: */
374375
REQ_OP_DRV_IN = (__force blk_opf_t)34,
375376
REQ_OP_DRV_OUT = (__force blk_opf_t)35,
376377

0 commit comments

Comments
 (0)