[PATCH] doc-guide:kernel-doc.rst: Reference to foobar

[PATCH] doc-guide:kernel-doc.rst: Reference to foobar

[Joris Gutjahr]

In the Function documentation Section of kernel-doc.rst
there is a function_name() function as an example for
how to make a comment about a function.

But at the end of that example there is a reference to foobar 
instead of function_name.

I think that should rather be function_name, because that
was the placeholder the whole example was using.

Signed-off-by: Joris Gutjahr <joris.gutjahr@gmail.com>
---
 Documentation/doc-guide/kernel-doc.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 8db53cdc225f..51be62aa4385 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -77,7 +77,7 @@ The general format of a function and function-like macro kernel-doc comment is::
    * Context: Describes whether the function can sleep, what locks it takes,
    *          releases, or expects to be held. It can extend over multiple
    *          lines.
-   * Return: Describe the return value of foobar.
+   * Return: Describe the return value of function_name.
    *
    * The return value description can also have multiple paragraphs, and should
    * be placed at the end of the comment block.
-- 
2.19.1

Re: [PATCH] doc-guide:kernel-doc.rst: Reference to foobar

[Jonathan Corbet]

On Sun, 28 Oct 2018 20:28:28 +0100
Joris Gutjahr <joris.gutjahr@gmail.com> wrote:

> In the Function documentation Section of kernel-doc.rst
> there is a function_name() function as an example for
> how to make a comment about a function.
> 
> But at the end of that example there is a reference to foobar 
> instead of function_name.
> 
> I think that should rather be function_name, because that
> was the placeholder the whole example was using.
> 
> Signed-off-by: Joris Gutjahr <joris.gutjahr@gmail.com>

Sure, make sense.  Applied, thanks.

jon