Hi all,
After merging the ext3 tree, today's linux-next build (htmldocs) produced
this warning:
Documentation/admin-guide/filesystem-monitoring.rst:60: WARNING: Definition list ends without a blank line; unexpected unindent.
Introduced by commit
c0baf9ac0b05 ("docs: Document the FAN_FS_ERROR event")
--
Cheers,
Stephen Rothwell
Stephen Rothwell <[email protected]> writes:
> Hi all,
>
> After merging the ext3 tree, today's linux-next build (htmldocs) produced
> this warning:
>
> Documentation/admin-guide/filesystem-monitoring.rst:60: WARNING: Definition list ends without a blank line; unexpected unindent.
>
> Introduced by commit
>
> c0baf9ac0b05 ("docs: Document the FAN_FS_ERROR event")
Hi Stephen, Jan,
I'd suggest the patch below.
Thank you,
-- >8 --
From: Gabriel Krisman Bertazi <[email protected]>
Date: Thu, 28 Oct 2021 17:17:47 -0300
Subject: [PATCH] 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.
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Gabriel Krisman Bertazi <[email protected]>
---
.../admin-guide/filesystem-monitoring.rst | 20 +++++++++++--------
1 file 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
--
2.33.0
On Thu 28-10-21 18:05:49, Gabriel Krisman Bertazi wrote:
> Stephen Rothwell <[email protected]> writes:
>
> > Hi all,
> >
> > After merging the ext3 tree, today's linux-next build (htmldocs) produced
> > this warning:
> >
> > Documentation/admin-guide/filesystem-monitoring.rst:60: WARNING: Definition list ends without a blank line; unexpected unindent.
> >
> > Introduced by commit
> >
> > c0baf9ac0b05 ("docs: Document the FAN_FS_ERROR event")
>
> Hi Stephen, Jan,
>
> I'd suggest the patch below.
Thanks. I've added the patch to my tree.
Honza
>
> Thank you,
>
> -- >8 --
> From: Gabriel Krisman Bertazi <[email protected]>
> Date: Thu, 28 Oct 2021 17:17:47 -0300
> Subject: [PATCH] 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.
>
> Reported-by: Stephen Rothwell <[email protected]>
> Signed-off-by: Gabriel Krisman Bertazi <[email protected]>
> ---
> .../admin-guide/filesystem-monitoring.rst | 20 +++++++++++--------
> 1 file 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
> --
> 2.33.0
>
--
Jan Kara <[email protected]>
SUSE Labs, CR