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

From: Jonathan Corbet
Date: Tue Jun 15 2021 - 10:22:56 EST


Oleksandr Mazur <oleksandr.mazur@xxxxxxxxxxx> writes:

> Fixes: a5aee17deb88 ("documentation: networking: devlink: add prestera switched driver Documentation")
>
> Signed-off-by: Oleksandr Mazur <oleksandr.mazur@xxxxxxxxxxx>
> ---
> 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