* [PATCH] doc: Document the new inline struct member kernel-doc style
@ 2016-11-17 9:43 Daniel Vetter
2016-11-17 9:56 ` Jani Nikula
2016-11-17 10:19 ` Daniel Vetter
0 siblings, 2 replies; 6+ messages in thread
From: Daniel Vetter @ 2016-11-17 9:43 UTC (permalink / raw)
To: LKML
Cc: Daniel Vetter, Daniel Vetter, Jani Nikula, Jonathan Corbet,
linux-doc, Daniel Vetter
We don't just need better doc toolchains, we also need better docs for
our doc toolchain!
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
Documentation/kernel-documentation.rst | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
index 10cc7ddb6235..a5bd12d8bd4e 100644
--- a/Documentation/kernel-documentation.rst
+++ b/Documentation/kernel-documentation.rst
@@ -484,7 +484,10 @@ span multiple lines. The continuation lines may contain indentation.
In-line member documentation comments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The structure members may also be documented in-line within the definition::
+The structure members may also be documented in-line within the definition.
+There are two styles, single-line comments where both the opening ``/**`` and
+closing ``*/`` are on the same line, and multi-line comments where they are each
+on a line of their own, like all other kernel-doc comments::
/**
* struct foo - Brief description.
@@ -502,6 +505,8 @@ The structure members may also be documented in-line within the definition::
* Here, the member description may contain several paragraphs.
*/
int baz;
+ /** @foo: Single line description. */
+ int foo;
}
Private members
--
2.10.2
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: Document the new inline struct member kernel-doc style
2016-11-17 9:43 [PATCH] doc: Document the new inline struct member kernel-doc style Daniel Vetter
@ 2016-11-17 9:56 ` Jani Nikula
2016-11-17 10:05 ` Jani Nikula
2016-11-17 10:19 ` Daniel Vetter
1 sibling, 1 reply; 6+ messages in thread
From: Jani Nikula @ 2016-11-17 9:56 UTC (permalink / raw)
To: Daniel Vetter, LKML
Cc: Daniel Vetter, Daniel Vetter, Jonathan Corbet, linux-doc, Daniel Vetter
On Thu, 17 Nov 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> We don't just need better doc toolchains, we also need better docs for
> our doc toolchain!
Mea culpa. Thanks, LGTM.
BR,
Jani.
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: Jani Nikula <jani.nikula@intel.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
> Documentation/kernel-documentation.rst | 7 ++++++-
> 1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
> index 10cc7ddb6235..a5bd12d8bd4e 100644
> --- a/Documentation/kernel-documentation.rst
> +++ b/Documentation/kernel-documentation.rst
> @@ -484,7 +484,10 @@ span multiple lines. The continuation lines may contain indentation.
> In-line member documentation comments
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> -The structure members may also be documented in-line within the definition::
> +The structure members may also be documented in-line within the definition.
> +There are two styles, single-line comments where both the opening ``/**`` and
> +closing ``*/`` are on the same line, and multi-line comments where they are each
> +on a line of their own, like all other kernel-doc comments::
>
> /**
> * struct foo - Brief description.
> @@ -502,6 +505,8 @@ The structure members may also be documented in-line within the definition::
> * Here, the member description may contain several paragraphs.
> */
> int baz;
> + /** @foo: Single line description. */
> + int foo;
> }
>
> Private members
--
Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: Document the new inline struct member kernel-doc style
2016-11-17 9:56 ` Jani Nikula
@ 2016-11-17 10:05 ` Jani Nikula
0 siblings, 0 replies; 6+ messages in thread
From: Jani Nikula @ 2016-11-17 10:05 UTC (permalink / raw)
To: Daniel Vetter, LKML
Cc: Daniel Vetter, Daniel Vetter, Jonathan Corbet, linux-doc, Daniel Vetter
On Thu, 17 Nov 2016, Jani Nikula <jani.nikula@intel.com> wrote:
> On Thu, 17 Nov 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>> We don't just need better doc toolchains, we also need better docs for
>> our doc toolchain!
>
> Mea culpa. Thanks, LGTM.
Oh, the example struct now has too "foo" fields, documented
twice. That's not good.
BR,
Jani.
>
> BR,
> Jani.
>
>
>> Cc: Daniel Vetter <daniel@ffwll.ch>
>> Cc: Jani Nikula <jani.nikula@intel.com>
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: linux-doc@vger.kernel.org
>> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
>> ---
>> Documentation/kernel-documentation.rst | 7 ++++++-
>> 1 file changed, 6 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
>> index 10cc7ddb6235..a5bd12d8bd4e 100644
>> --- a/Documentation/kernel-documentation.rst
>> +++ b/Documentation/kernel-documentation.rst
>> @@ -484,7 +484,10 @@ span multiple lines. The continuation lines may contain indentation.
>> In-line member documentation comments
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> -The structure members may also be documented in-line within the definition::
>> +The structure members may also be documented in-line within the definition.
>> +There are two styles, single-line comments where both the opening ``/**`` and
>> +closing ``*/`` are on the same line, and multi-line comments where they are each
>> +on a line of their own, like all other kernel-doc comments::
>>
>> /**
>> * struct foo - Brief description.
>> @@ -502,6 +505,8 @@ The structure members may also be documented in-line within the definition::
>> * Here, the member description may contain several paragraphs.
>> */
>> int baz;
>> + /** @foo: Single line description. */
>> + int foo;
>> }
>>
>> Private members
--
Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH] doc: Document the new inline struct member kernel-doc style
2016-11-17 9:43 [PATCH] doc: Document the new inline struct member kernel-doc style Daniel Vetter
2016-11-17 9:56 ` Jani Nikula
@ 2016-11-17 10:19 ` Daniel Vetter
2016-11-17 10:23 ` Jani Nikula
2016-11-19 17:32 ` Jonathan Corbet
1 sibling, 2 replies; 6+ messages in thread
From: Daniel Vetter @ 2016-11-17 10:19 UTC (permalink / raw)
To: LKML
Cc: Daniel Vetter, Daniel Vetter, Jani Nikula, Jonathan Corbet,
linux-doc, Daniel Vetter
We don't just need better doc toolchains, we also need better docs for
our doc toolchain!
v2: Make sure we don't have foo twice (Jani).
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
Documentation/kernel-documentation.rst | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
index 10cc7ddb6235..0dd17069bc0b 100644
--- a/Documentation/kernel-documentation.rst
+++ b/Documentation/kernel-documentation.rst
@@ -484,7 +484,10 @@ span multiple lines. The continuation lines may contain indentation.
In-line member documentation comments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The structure members may also be documented in-line within the definition::
+The structure members may also be documented in-line within the definition.
+There are two styles, single-line comments where both the opening ``/**`` and
+closing ``*/`` are on the same line, and multi-line comments where they are each
+on a line of their own, like all other kernel-doc comments::
/**
* struct foo - Brief description.
@@ -502,6 +505,8 @@ The structure members may also be documented in-line within the definition::
* Here, the member description may contain several paragraphs.
*/
int baz;
+ /** @foobar: Single line description. */
+ int foobar;
}
Private members
--
2.10.2
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: Document the new inline struct member kernel-doc style
2016-11-17 10:19 ` Daniel Vetter
@ 2016-11-17 10:23 ` Jani Nikula
2016-11-19 17:32 ` Jonathan Corbet
1 sibling, 0 replies; 6+ messages in thread
From: Jani Nikula @ 2016-11-17 10:23 UTC (permalink / raw)
To: Daniel Vetter, LKML
Cc: Daniel Vetter, Daniel Vetter, Jonathan Corbet, linux-doc, Daniel Vetter
On Thu, 17 Nov 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> We don't just need better doc toolchains, we also need better docs for
> our doc toolchain!
>
> v2: Make sure we don't have foo twice (Jani).
Thanks, *now* LGTM. :)
>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: Jani Nikula <jani.nikula@intel.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
> Documentation/kernel-documentation.rst | 7 ++++++-
> 1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
> index 10cc7ddb6235..0dd17069bc0b 100644
> --- a/Documentation/kernel-documentation.rst
> +++ b/Documentation/kernel-documentation.rst
> @@ -484,7 +484,10 @@ span multiple lines. The continuation lines may contain indentation.
> In-line member documentation comments
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> -The structure members may also be documented in-line within the definition::
> +The structure members may also be documented in-line within the definition.
> +There are two styles, single-line comments where both the opening ``/**`` and
> +closing ``*/`` are on the same line, and multi-line comments where they are each
> +on a line of their own, like all other kernel-doc comments::
>
> /**
> * struct foo - Brief description.
> @@ -502,6 +505,8 @@ The structure members may also be documented in-line within the definition::
> * Here, the member description may contain several paragraphs.
> */
> int baz;
> + /** @foobar: Single line description. */
> + int foobar;
> }
>
> Private members
--
Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: Document the new inline struct member kernel-doc style
2016-11-17 10:19 ` Daniel Vetter
2016-11-17 10:23 ` Jani Nikula
@ 2016-11-19 17:32 ` Jonathan Corbet
1 sibling, 0 replies; 6+ messages in thread
From: Jonathan Corbet @ 2016-11-19 17:32 UTC (permalink / raw)
To: Daniel Vetter; +Cc: LKML, Daniel Vetter, Jani Nikula, linux-doc, Daniel Vetter
On Thu, 17 Nov 2016 11:19:43 +0100
Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> We don't just need better doc toolchains, we also need better docs for
> our doc toolchain!
Indeed. Applied, thanks.
jon
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2016-11-19 17:32 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-11-17 9:43 [PATCH] doc: Document the new inline struct member kernel-doc style Daniel Vetter
2016-11-17 9:56 ` Jani Nikula
2016-11-17 10:05 ` Jani Nikula
2016-11-17 10:19 ` Daniel Vetter
2016-11-17 10:23 ` Jani Nikula
2016-11-19 17: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).