Skip to content

Commit

Permalink
docs: Fix formatting of literal sections in fanotify docs
Browse files Browse the repository at this point in the history
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/87y26camhe.fsf@collabora.com
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com>
Signed-off-by: Jan Kara <jack@suse.cz>
  • Loading branch information
Gabriel Krisman Bertazi authored and Jan Kara committed Nov 1, 2021
1 parent 8fc70b3 commit 9abeae5
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions Documentation/admin-guide/filesystem-monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,11 @@ notifications is Ext4.

A FAN_FS_ERROR Notification has the following format::

[ Notification Metadata (Mandatory) ]
[ Generic Error Record (Mandatory) ]
[ FID record (Mandatory) ]
::

[ Notification Metadata (Mandatory) ]
[ Generic Error Record (Mandatory) ]
[ FID record (Mandatory) ]

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

struct fanotify_event_info_error {
struct fanotify_event_info_header hdr;
__s32 error;
__u32 error_count;
};
::

struct fanotify_event_info_error {
struct fanotify_event_info_header hdr;
__s32 error;
__u32 error_count;
};

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

0 comments on commit 9abeae5

Please sign in to comment.