From: Jan Kara <jack@suse.cz>
To: Gabriel Krisman Bertazi <krisman@collabora.com>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>, Jan Kara <jack@suse.cz>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: Re: linux-next: build warning after merge of the ext3 tree
Date: Mon, 1 Nov 2021 12:45:45 +0100 [thread overview]
Message-ID: <20211101114545.GB21679@quack2.suse.cz> (raw)
In-Reply-To: <87y26camhe.fsf@collabora.com>
On Thu 28-10-21 18:05:49, Gabriel Krisman Bertazi wrote:
> Stephen Rothwell <sfr@canb.auug.org.au> 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 <krisman@collabora.com>
> 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 <sfr@canb.auug.org.au>
> Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com>
> ---
> .../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 <jack@suse.com>
SUSE Labs, CR
next prev parent reply other threads:[~2021-11-01 11:45 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-28 12:21 linux-next: build warning after merge of the ext3 tree Stephen Rothwell
2021-10-28 21:05 ` Gabriel Krisman Bertazi
2021-11-01 11:45 ` Jan Kara [this message]
-- strict thread matches above, loose matches on Subject: below --
2021-10-28 10:10 Stephen Rothwell
2021-11-01 11:50 ` Jan Kara
2010-02-24 8:05 Stephen Rothwell
2010-02-24 10:58 ` Jan Kara
2010-02-24 11:15 ` Jan Kara
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211101114545.GB21679@quack2.suse.cz \
--to=jack@suse.cz \
--cc=krisman@collabora.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).