From: Vadym Kochan <vadym.kochan@plvision.eu>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Oleksandr Mazur <oleksandr.mazur@plvision.eu>,
jiri@nvidia.com, davem@davemloft.net, kuba@kernel.org,
netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
andrew@lunn.ch, nikolay@nvidia.com, idosch@idosch.org,
sfr@canb.auug.org.au, linux-doc@vger.kernel.org
Subject: Re: [PATCH] documentation: networking: devlink: fix prestera.rst formatting that causes build errors
Date: Tue, 15 Jun 2021 17:22:24 +0300 [thread overview]
Message-ID: <20210615142224.GA18219@plvision.eu> (raw)
In-Reply-To: <87sg1jz00m.fsf@meer.lwn.net>
Hi Jonathan,
On Tue, Jun 15, 2021 at 08:16:09AM -0600, Jonathan Corbet wrote:
> Oleksandr Mazur <oleksandr.mazur@plvision.eu> writes:
>
> > Fixes: a5aee17deb88 ("documentation: networking: devlink: add prestera switched driver Documentation")
> >
> > Signed-off-by: Oleksandr Mazur <oleksandr.mazur@plvision.eu>
> > ---
> > Documentation/networking/devlink/devlink-trap.rst | 1 +
> > Documentation/networking/devlink/index.rst | 1 +
> > Documentation/networking/devlink/prestera.rst | 4 ++--
> > 3 files changed, 4 insertions(+), 2 deletions(-)
> >
> > diff --git a/Documentation/networking/devlink/devlink-trap.rst b/Documentation/networking/devlink/devlink-trap.rst
> > index 935b6397e8cf..ef8928c355df 100644
> > --- a/Documentation/networking/devlink/devlink-trap.rst
> > +++ b/Documentation/networking/devlink/devlink-trap.rst
> > @@ -497,6 +497,7 @@ drivers:
> >
> > * :doc:`netdevsim`
> > * :doc:`mlxsw`
> > + * :doc:`prestera`
>
> Please, rather than using :doc: tags, just give the file name:
>
> * Documentation/networking/dev-link/prestera
>
> (and fix the others while you're in the neighborhood). Our automarkup
> magic will make the links work in the HTML docs, and the result is more
> readable for people reading the plain text.
>
> Thanks,
>
> jon
In case if it is OK to do this what you proposed, would not it be better
to do this in separate patch ? (the reason is just to do
not mix the warnings fix and the better plain text navigation support).
Regards,
Vadym Kochan
next prev parent reply other threads:[~2021-06-15 14:24 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-15 13:48 [PATCH] documentation: networking: devlink: fix prestera.rst formatting that causes build errors Oleksandr Mazur
2021-06-15 14:16 ` Jonathan Corbet
2021-06-15 14:22 ` Vadym Kochan [this message]
2021-06-15 14:44 ` Oleksandr Mazur
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=20210615142224.GA18219@plvision.eu \
--to=vadym.kochan@plvision.eu \
--cc=andrew@lunn.ch \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=idosch@idosch.org \
--cc=jiri@nvidia.com \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=nikolay@nvidia.com \
--cc=oleksandr.mazur@plvision.eu \
--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).