History

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:

Randy Dunlap committed 11 months ago

Commit d211a281 parent 4d0e1f21 file · +11 −4Browse files

Unified · Split

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

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t