[PATCH 0/1] A small fix for parse-headers.rst

[PATCH 0/1] A small fix for parse-headers.rst

[Mauro Carvalho Chehab]

Hi Jon,

This was supposed to be part of v4 of
https://lore.kernel.org/linux-doc/87ms4ty8ni.fsf@trenco.lwn.net/,
but it ended I didn't merge it, as I forgot to use "-a" on git commit...

Mauro Carvalho Chehab (1):
  docs: parse-headers.rst: remove uneeded parenthesis

 Documentation/doc-guide/parse-headers.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.51.1

[PATCH 1/1] docs: parse-headers.rst: remove uneeded parenthesis

[Mauro Carvalho Chehab]

As pointed by Randy, the parenthesis there is not needed and it
violates the document coding style.

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Closes: https://lore.kernel.org/linux-doc/9d709020-03fe-467c-be7f-d5ee251bb79a@infradead.org/
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/doc-guide/parse-headers.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/doc-guide/parse-headers.rst b/Documentation/doc-guide/parse-headers.rst
index 954f3285ddf6..bd34a6d00ca9 100644
--- a/Documentation/doc-guide/parse-headers.rst
+++ b/Documentation/doc-guide/parse-headers.rst
@@ -89,7 +89,7 @@ defines the C namespace to be used.
 It is meant to allow having more comprehensive documentation, where
 uAPI headers will create cross-reference links to the code.
 
-The output is written at the (``FILE_OUT``).
+The output is written at the ``FILE_OUT``.
 
 The ``FILE_RULES`` may contain contain three types of statements:
 **ignore**, **replace** and **namespace**.
-- 
2.51.1

Re: [PATCH 1/1] docs: parse-headers.rst: remove uneeded parenthesis

[Jonathan Corbet]

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> As pointed by Randy, the parenthesis there is not needed and it
> violates the document coding style.
>
> Reported-by: Randy Dunlap <rdunlap@infradead.org>
> Closes: https://lore.kernel.org/linux-doc/9d709020-03fe-467c-be7f-d5ee251bb79a@infradead.org/
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  Documentation/doc-guide/parse-headers.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/doc-guide/parse-headers.rst b/Documentation/doc-guide/parse-headers.rst
> index 954f3285ddf6..bd34a6d00ca9 100644
> --- a/Documentation/doc-guide/parse-headers.rst
> +++ b/Documentation/doc-guide/parse-headers.rst
> @@ -89,7 +89,7 @@ defines the C namespace to be used.
>  It is meant to allow having more comprehensive documentation, where
>  uAPI headers will create cross-reference links to the code.
>  
> -The output is written at the (``FILE_OUT``).
> +The output is written at the ``FILE_OUT``.

Applied, thanks.

jon