Skip to content

Commit d211a28

Browse files
rddunlapaxboe
authored andcommitted
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>
1 parent 4d0e1f2 commit d211a28

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

drivers/block/rnbd/rnbd-proto.h

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
#define RTRS_PORT 1234
2525

2626
/**
27-
* enum rnbd_msg_types - RNBD message types
27+
* enum rnbd_msg_type - RNBD message types
2828
* @RNBD_MSG_SESS_INFO: initial session info from client to server
2929
* @RNBD_MSG_SESS_INFO_RSP: initial session info from server to client
3030
* @RNBD_MSG_OPEN: open (map) device request
@@ -47,10 +47,11 @@ enum rnbd_msg_type {
4747
*/
4848
struct rnbd_msg_hdr {
4949
__le16 type;
50+
/* private: */
5051
__le16 __padding;
5152
};
5253

53-
/**
54+
/*
5455
* We allow to map RO many times and RW only once. We allow to map yet another
5556
* time RW, if MIGRATION is provided (second RW export can be required for
5657
* example for VM migration)
@@ -78,6 +79,7 @@ static const __maybe_unused struct {
7879
struct rnbd_msg_sess_info {
7980
struct rnbd_msg_hdr hdr;
8081
u8 ver;
82+
/* private: */
8183
u8 reserved[31];
8284
};
8385

@@ -89,6 +91,7 @@ struct rnbd_msg_sess_info {
8991
struct rnbd_msg_sess_info_rsp {
9092
struct rnbd_msg_hdr hdr;
9193
u8 ver;
94+
/* private: */
9295
u8 reserved[31];
9396
};
9497

@@ -97,13 +100,16 @@ struct rnbd_msg_sess_info_rsp {
97100
* @hdr: message header
98101
* @access_mode: the mode to open remote device, valid values see:
99102
* enum rnbd_access_mode
100-
* @device_name: device path on remote side
103+
* @dev_name: device path on remote side
101104
*/
102105
struct rnbd_msg_open {
103106
struct rnbd_msg_hdr hdr;
104107
u8 access_mode;
108+
/* private: */
105109
u8 resv1;
110+
/* public: */
106111
s8 dev_name[NAME_MAX];
112+
/* private: */
107113
u8 reserved[3];
108114
};
109115

@@ -155,6 +161,7 @@ struct rnbd_msg_open_rsp {
155161
__le16 secure_discard;
156162
u8 obsolete_rotational;
157163
u8 cache_policy;
164+
/* private: */
158165
u8 reserved[10];
159166
};
160167

@@ -187,7 +194,7 @@ struct rnbd_msg_io {
187194
* @RNBD_OP_DISCARD: discard sectors
188195
* @RNBD_OP_SECURE_ERASE: securely erase sectors
189196
* @RNBD_OP_WRITE_ZEROES: write zeroes sectors
190-
197+
*
191198
* @RNBD_F_SYNC: request is sync (sync write or read)
192199
* @RNBD_F_FUA: forced unit access
193200
*/

0 commit comments

Comments
 (0)