Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

block/rnbd: correct all kernel-doc complaints

Fix all kernel-doc warnings in rnbd-proto.h:
- use correct enum name in kdoc comment
- mark several struct members as "/* private: */" so that no kdoc is
required for them
- don't use "/**" for a non-kernel-doc comment
- use the correct struct member name for "dev_name"
- use " *" for a blank kernel-doc line

Fixes these warnings:
Warning: drivers/block/rnbd/rnbd-proto.h:41 expecting prototype for
enum rnbd_msg_types. Prototype was for enum rnbd_msg_type instead
Warning: drivers/block/rnbd/rnbd-proto.h:50 struct member '__padding'
not described in 'rnbd_msg_hdr'
Warning: drivers/block/rnbd/rnbd-proto.h:53 This comment starts with
'/**', but isn't a kernel-doc comment.
* We allow to map RO many times and RW only once. We allow to map yet another
Warning: drivers/block/rnbd/rnbd-proto.h:81 struct member 'reserved'
not described in 'rnbd_msg_sess_info'
Warning: drivers/block/rnbd/rnbd-proto.h:92 struct member 'reserved'
not described in 'rnbd_msg_sess_info_rsp'
Warning: drivers/block/rnbd/rnbd-proto.h:107 struct member 'resv1'
not described in 'rnbd_msg_open'
Warning: drivers/block/rnbd/rnbd-proto.h:107 struct member 'dev_name'
not described in 'rnbd_msg_open'
Warning: drivers/block/rnbd/rnbd-proto.h:107 struct member 'reserved'
not described in 'rnbd_msg_open'
Warning: drivers/block/rnbd/rnbd-proto.h:158 struct member 'reserved'
not described in 'rnbd_msg_open_rsp'
Warning: drivers/block/rnbd/rnbd-proto.h:189 bad line:

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Jack Wang <jinpu.wang@ionos.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Randy Dunlap and committed by
Jens Axboe
d211a280 4d0e1f21

+11 -4
+11 -4
drivers/block/rnbd/rnbd-proto.h
··· 24 24 #define RTRS_PORT 1234 25 25 26 26 /** 27 - * enum rnbd_msg_types - RNBD message types 27 + * enum rnbd_msg_type - RNBD message types 28 28 * @RNBD_MSG_SESS_INFO: initial session info from client to server 29 29 * @RNBD_MSG_SESS_INFO_RSP: initial session info from server to client 30 30 * @RNBD_MSG_OPEN: open (map) device request ··· 47 47 */ 48 48 struct rnbd_msg_hdr { 49 49 __le16 type; 50 + /* private: */ 50 51 __le16 __padding; 51 52 }; 52 53 53 - /** 54 + /* 54 55 * We allow to map RO many times and RW only once. We allow to map yet another 55 56 * time RW, if MIGRATION is provided (second RW export can be required for 56 57 * example for VM migration) ··· 79 78 struct rnbd_msg_sess_info { 80 79 struct rnbd_msg_hdr hdr; 81 80 u8 ver; 81 + /* private: */ 82 82 u8 reserved[31]; 83 83 }; 84 84 ··· 91 89 struct rnbd_msg_sess_info_rsp { 92 90 struct rnbd_msg_hdr hdr; 93 91 u8 ver; 92 + /* private: */ 94 93 u8 reserved[31]; 95 94 }; 96 95 ··· 100 97 * @hdr: message header 101 98 * @access_mode: the mode to open remote device, valid values see: 102 99 * enum rnbd_access_mode 103 - * @device_name: device path on remote side 100 + * @dev_name: device path on remote side 104 101 */ 105 102 struct rnbd_msg_open { 106 103 struct rnbd_msg_hdr hdr; 107 104 u8 access_mode; 105 + /* private: */ 108 106 u8 resv1; 107 + /* public: */ 109 108 s8 dev_name[NAME_MAX]; 109 + /* private: */ 110 110 u8 reserved[3]; 111 111 }; 112 112 ··· 161 155 __le16 secure_discard; 162 156 u8 obsolete_rotational; 163 157 u8 cache_policy; 158 + /* private: */ 164 159 u8 reserved[10]; 165 160 }; 166 161 ··· 194 187 * @RNBD_OP_DISCARD: discard sectors 195 188 * @RNBD_OP_SECURE_ERASE: securely erase sectors 196 189 * @RNBD_OP_WRITE_ZEROES: write zeroes sectors 197 - 190 + * 198 191 * @RNBD_F_SYNC: request is sync (sync write or read) 199 192 * @RNBD_F_FUA: forced unit access 200 193 */