Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
nilfs2: convert nilfs_super_block to kernel-doc
Eliminate 40+ kernel-doc warnings in nilfs2_ondisk.h by converting
all of the struct member comments to kernel-doc comments.
Fix one misnamed struct member in nilfs_direct_node.
Object files before and after are the same size and content.
Examples of warnings:
Warning: include/uapi/linux/nilfs2_ondisk.h:202 struct member 's_rev_level'
not described in 'nilfs_super_block'
Warning: include/uapi/linux/nilfs2_ondisk.h:202 struct member
's_minor_rev_level' not described in 'nilfs_super_block'
Warning: include/uapi/linux/nilfs2_ondisk.h:202 struct member 's_magic'
not described in 'nilfs_super_block'
Warning: include/uapi/linux/nilfs2_ondisk.h:202 struct member 's_bytes'
not described in 'nilfs_super_block'
Warning: include/uapi/linux/nilfs2_ondisk.h:202 struct member 's_flags'
not described in 'nilfs_super_block'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Signed-off-by: Viacheslav Dubeyko <slava@dubeyko.com>
authored by
Randy Dunlap
and committed by
Viacheslav Dubeyko
cb8fe62f
ed527ef0
+89
-58
+89
-58
include/uapi/linux/nilfs2_ondisk.h
+89
-58
include/uapi/linux/nilfs2_ondisk.h
···
133
133
134
134
/**
135
135
* struct nilfs_super_block - structure of super block on disk
136
+
* @s_rev_level: Revision level
137
+
* @s_minor_rev_level: minor revision level
138
+
* @s_magic: Magic signature
139
+
* @s_bytes: Bytes count of CRC calculation for
140
+
* this structure. s_reserved is excluded.
141
+
* @s_flags: flags
142
+
* @s_crc_seed: Seed value of CRC calculation
143
+
* @s_sum: Check sum of super block
144
+
* @s_log_block_size: Block size represented as follows:
145
+
* blocksize = 1 << (s_log_block_size + 10)
146
+
* @s_nsegments: Number of segments in filesystem
147
+
* @s_dev_size: block device size in bytes
148
+
* @s_first_data_block: 1st seg disk block number
149
+
* @s_blocks_per_segment: number of blocks per full segment
150
+
* @s_r_segments_percentage: Reserved segments percentage
151
+
* @s_last_cno: Last checkpoint number
152
+
* @s_last_pseg: disk block addr pseg written last
153
+
* @s_last_seq: seq. number of seg written last
154
+
* @s_free_blocks_count: Free blocks count
155
+
* @s_ctime: Creation time (execution time of newfs)
156
+
* @s_mtime: Mount time
157
+
* @s_wtime: Write time
158
+
* @s_mnt_count: Mount count
159
+
* @s_max_mnt_count: Maximal mount count
160
+
* @s_state: File system state
161
+
* @s_errors: Behaviour when detecting errors
162
+
* @s_lastcheck: time of last check
163
+
* @s_checkinterval: max. time between checks
164
+
* @s_creator_os: OS
165
+
* @s_def_resuid: Default uid for reserved blocks
166
+
* @s_def_resgid: Default gid for reserved blocks
167
+
* @s_first_ino: First non-reserved inode
168
+
* @s_inode_size: Size of an inode
169
+
* @s_dat_entry_size: Size of a dat entry
170
+
* @s_checkpoint_size: Size of a checkpoint
171
+
* @s_segment_usage_size: Size of a segment usage
172
+
* @s_uuid: 128-bit uuid for volume
173
+
* @s_volume_name: volume name
174
+
* @s_c_interval: Commit interval of segment
175
+
* @s_c_block_max: Threshold of data amount for the
176
+
* segment construction
177
+
* @s_feature_compat: Compatible feature set
178
+
* @s_feature_compat_ro: Read-only compatible feature set
179
+
* @s_feature_incompat: Incompatible feature set
180
+
* @s_reserved: padding to the end of the block
136
181
*/
137
182
struct nilfs_super_block {
138
-
/*00*/ __le32 s_rev_level; /* Revision level */
139
-
__le16 s_minor_rev_level; /* minor revision level */
140
-
__le16 s_magic; /* Magic signature */
183
+
/*00*/ __le32 s_rev_level;
184
+
__le16 s_minor_rev_level;
185
+
__le16 s_magic;
141
186
142
-
__le16 s_bytes; /*
143
-
* Bytes count of CRC calculation
144
-
* for this structure. s_reserved
145
-
* is excluded.
146
-
*/
147
-
__le16 s_flags; /* flags */
148
-
__le32 s_crc_seed; /* Seed value of CRC calculation */
149
-
/*10*/ __le32 s_sum; /* Check sum of super block */
187
+
__le16 s_bytes;
188
+
__le16 s_flags;
189
+
__le32 s_crc_seed;
190
+
/*10*/ __le32 s_sum;
150
191
151
-
__le32 s_log_block_size; /*
152
-
* Block size represented as follows
153
-
* blocksize =
154
-
* 1 << (s_log_block_size + 10)
155
-
*/
156
-
__le64 s_nsegments; /* Number of segments in filesystem */
157
-
/*20*/ __le64 s_dev_size; /* block device size in bytes */
158
-
__le64 s_first_data_block; /* 1st seg disk block number */
159
-
/*30*/ __le32 s_blocks_per_segment; /* number of blocks per full segment */
160
-
__le32 s_r_segments_percentage; /* Reserved segments percentage */
192
+
__le32 s_log_block_size;
193
+
__le64 s_nsegments;
194
+
/*20*/ __le64 s_dev_size;
195
+
__le64 s_first_data_block;
196
+
/*30*/ __le32 s_blocks_per_segment;
197
+
__le32 s_r_segments_percentage;
161
198
162
-
__le64 s_last_cno; /* Last checkpoint number */
163
-
/*40*/ __le64 s_last_pseg; /* disk block addr pseg written last */
164
-
__le64 s_last_seq; /* seq. number of seg written last */
165
-
/*50*/ __le64 s_free_blocks_count; /* Free blocks count */
199
+
__le64 s_last_cno;
200
+
/*40*/ __le64 s_last_pseg;
201
+
__le64 s_last_seq;
202
+
/*50*/ __le64 s_free_blocks_count;
166
203
167
-
__le64 s_ctime; /*
168
-
* Creation time (execution time of
169
-
* newfs)
170
-
*/
171
-
/*60*/ __le64 s_mtime; /* Mount time */
172
-
__le64 s_wtime; /* Write time */
173
-
/*70*/ __le16 s_mnt_count; /* Mount count */
174
-
__le16 s_max_mnt_count; /* Maximal mount count */
175
-
__le16 s_state; /* File system state */
176
-
__le16 s_errors; /* Behaviour when detecting errors */
177
-
__le64 s_lastcheck; /* time of last check */
204
+
__le64 s_ctime;
205
+
/*60*/ __le64 s_mtime;
206
+
__le64 s_wtime;
207
+
/*70*/ __le16 s_mnt_count;
208
+
__le16 s_max_mnt_count;
209
+
__le16 s_state;
210
+
__le16 s_errors;
211
+
__le64 s_lastcheck;
178
212
179
-
/*80*/ __le32 s_checkinterval; /* max. time between checks */
180
-
__le32 s_creator_os; /* OS */
181
-
__le16 s_def_resuid; /* Default uid for reserved blocks */
182
-
__le16 s_def_resgid; /* Default gid for reserved blocks */
183
-
__le32 s_first_ino; /* First non-reserved inode */
213
+
/*80*/ __le32 s_checkinterval;
214
+
__le32 s_creator_os;
215
+
__le16 s_def_resuid;
216
+
__le16 s_def_resgid;
217
+
__le32 s_first_ino;
184
218
185
-
/*90*/ __le16 s_inode_size; /* Size of an inode */
186
-
__le16 s_dat_entry_size; /* Size of a dat entry */
187
-
__le16 s_checkpoint_size; /* Size of a checkpoint */
188
-
__le16 s_segment_usage_size; /* Size of a segment usage */
219
+
/*90*/ __le16 s_inode_size;
220
+
__le16 s_dat_entry_size;
221
+
__le16 s_checkpoint_size;
222
+
__le16 s_segment_usage_size;
189
223
190
-
/*98*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
191
-
/*A8*/ char s_volume_name[80] /* volume name */
192
-
__kernel_nonstring;
224
+
/*98*/ __u8 s_uuid[16];
225
+
/*A8*/ char s_volume_name[80] __kernel_nonstring;
193
226
194
-
/*F8*/ __le32 s_c_interval; /* Commit interval of segment */
195
-
__le32 s_c_block_max; /*
196
-
* Threshold of data amount for
197
-
* the segment construction
198
-
*/
199
-
/*100*/ __le64 s_feature_compat; /* Compatible feature set */
200
-
__le64 s_feature_compat_ro; /* Read-only compatible feature set */
201
-
__le64 s_feature_incompat; /* Incompatible feature set */
202
-
__u32 s_reserved[186]; /* padding to the end of the block */
227
+
/*F8*/ __le32 s_c_interval;
228
+
__le32 s_c_block_max;
229
+
230
+
/*100*/ __le64 s_feature_compat;
231
+
__le64 s_feature_compat_ro;
232
+
__le64 s_feature_incompat;
233
+
__u32 s_reserved[186];
203
234
};
204
235
205
236
/*
···
480
449
/**
481
450
* struct nilfs_direct_node - header of built-in bmap array
482
451
* @dn_flags: flags
483
-
* @dn_pad: padding
452
+
* @pad: padding
484
453
*/
485
454
struct nilfs_direct_node {
486
455
__u8 dn_flags;