diff mbox series

documentation: networking: devlink: fix prestera.rst formatting that causes build errors

Message ID 20210615134847.22107-1-oleksandr.mazur@plvision.eu
State Superseded
Headers show
Series documentation: networking: devlink: fix prestera.rst formatting that causes build errors | expand

Commit Message

Oleksandr Mazur June 15, 2021, 1:48 p.m. UTC
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(-)

Comments

Jonathan Corbet June 15, 2021, 2:16 p.m. UTC | #1
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
Oleksandr Mazur June 15, 2021, 2:44 p.m. UTC | #2
> 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(-)

Sorry, i've missed the 'net-next' tag in the patch subject. Should i re-send the patch with 'net-next' tag?
E.g. form a V2 patch with proper subject/tag: [PATCH net-next v2] documentation: networking: devlink: fix prestera.rst formatting that causes build errors?
diff mbox series

Patch

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`
 
 .. _Generic-Packet-Trap-Groups:
 
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index 8428a1220723..b3b9e0692088 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -46,3 +46,4 @@  parameters, info versions, and other features it supports.
    qed
    ti-cpsw-switch
    am65-nuss-cpsw-switch
+   prestera
diff --git a/Documentation/networking/devlink/prestera.rst b/Documentation/networking/devlink/prestera.rst
index e8b52ffd4707..49409d1d3081 100644
--- a/Documentation/networking/devlink/prestera.rst
+++ b/Documentation/networking/devlink/prestera.rst
@@ -1,8 +1,8 @@ 
 .. SPDX-License-Identifier: GPL-2.0
 
-=====================
+========================
 prestera devlink support
-=====================
+========================
 
 This document describes the devlink features implemented by the ``prestera``
 device driver.