linux-kernel - Re: [PATCH] documentation: networking: devlink: fix prestera.rst formatting that causes build errors

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 15 Jun 2021 17:22:24 +0300
From:   Vadym Kochan <vadym.kochan@...ision.eu>
To:     Jonathan Corbet <corbet@....net>
Cc:     Oleksandr Mazur <oleksandr.mazur@...ision.eu>, jiri@...dia.com,
        davem@...emloft.net, kuba@...nel.org, netdev@...r.kernel.org,
        linux-kernel@...r.kernel.org, andrew@...n.ch, nikolay@...dia.com,
        idosch@...sch.org, sfr@...b.auug.org.au, linux-doc@...r.kernel.org
Subject: Re: [PATCH] documentation: networking: devlink: fix prestera.rst
 formatting that causes build errors

Hi Jonathan,

On Tue, Jun 15, 2021 at 08:16:09AM -0600, Jonathan Corbet wrote:
> Oleksandr Mazur <oleksandr.mazur@...ision.eu> writes:
> 
> > Fixes: a5aee17deb88 ("documentation: networking: devlink: add prestera switched driver Documentation")
> >
> > Signed-off-by: Oleksandr Mazur <oleksandr.mazur@...ision.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