* [PATCH] doc-guide:kernel-doc.rst: Reference to foobar
@ 2018-10-28 19:28 Joris Gutjahr
2018-11-07 22:32 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Joris Gutjahr @ 2018-10-28 19:28 UTC (permalink / raw)
To: corbet, linux-doc, linux-kernel; +Cc: 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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] doc-guide:kernel-doc.rst: Reference to foobar
2018-10-28 19:28 [PATCH] doc-guide:kernel-doc.rst: Reference to foobar Joris Gutjahr
@ 2018-11-07 22:32 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2018-11-07 22:32 UTC (permalink / raw)
To: Joris Gutjahr; +Cc: linux-doc, linux-kernel
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-11-07 22:32 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-10-28 19:28 [PATCH] doc-guide:kernel-doc.rst: Reference to foobar Joris Gutjahr
2018-11-07 22:32 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).