summaryrefslogtreecommitdiffstats
path: root/Documentation/admin-guide
diff options
context:
space:
mode:
authorGabriel Krisman Bertazi <krisman@collabora.com>2021-10-28 18:05:49 -0300
committerJan Kara <jack@suse.cz>2021-11-01 12:45:06 +0100
commit9abeae5d4458326e16df7ea237104b58c27dfd77 (patch)
treefc59731024f0bb3f20fd15ec272a83e9d82d41bc /Documentation/admin-guide
parent8fc70b3a142f97f7859bf052151df896933d2586 (diff)
downloadlinux-9abeae5d4458326e16df7ea237104b58c27dfd77.tar.bz2
docs: Fix formatting of literal sections in fanotify docs
Stephen Rothwell reported the following warning was introduced by commit c0baf9ac0b05 ("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>
Diffstat (limited to 'Documentation/admin-guide')
-rw-r--r--Documentation/admin-guide/filesystem-monitoring.rst20
1 files changed, 12 insertions, 8 deletions
diff --git a/Documentation/admin-guide/filesystem-monitoring.rst b/Documentation/admin-guide/filesystem-monitoring.rst
index 5a3c84e60095..ab8dba76283c 100644
--- a/Documentation/admin-guide/filesystem-monitoring.rst
+++ b/Documentation/admin-guide/filesystem-monitoring.rst
@@ -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
@@ -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