Skip to content

Commit 9abeae5

Browse files
krisman-at-collaborajankara
authored andcommitted
docs: Fix formatting of literal sections in fanotify docs
Stephen Rothwell reported the following warning was introduced by commit c0baf9a ("docs: Document the FAN_FS_ERROR event"). Documentation/admin-guide/filesystem-monitoring.rst:60: WARNING: Definition list ends without a blank line; unexpected unindent. Link: https://lore.kernel.org/r/[email protected] Reported-by: Stephen Rothwell <[email protected]> Signed-off-by: Gabriel Krisman Bertazi <[email protected]> Signed-off-by: Jan Kara <[email protected]>
1 parent 8fc70b3 commit 9abeae5

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

Documentation/admin-guide/filesystem-monitoring.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,11 @@ notifications is Ext4.
3535

3636
A FAN_FS_ERROR Notification has the following format::
3737

38-
[ Notification Metadata (Mandatory) ]
39-
[ Generic Error Record (Mandatory) ]
40-
[ FID record (Mandatory) ]
38+
::
39+
40+
[ Notification Metadata (Mandatory) ]
41+
[ Generic Error Record (Mandatory) ]
42+
[ FID record (Mandatory) ]
4143

4244
The order of records is not guaranteed, and new records might be added
4345
in the future. Therefore, applications must not rely on the order and
@@ -53,11 +55,13 @@ providing any additional details about the problem. This record is
5355
identified by ``struct fanotify_event_info_header.info_type`` being set
5456
to FAN_EVENT_INFO_TYPE_ERROR.
5557

56-
struct fanotify_event_info_error {
57-
struct fanotify_event_info_header hdr;
58-
__s32 error;
59-
__u32 error_count;
60-
};
58+
::
59+
60+
struct fanotify_event_info_error {
61+
struct fanotify_event_info_header hdr;
62+
__s32 error;
63+
__u32 error_count;
64+
};
6165

6266
The `error` field identifies the type of error using errno values.
6367
`error_count` tracks the number of errors that occurred and were

0 commit comments

Comments
 (0)