diff mbox series

[v1] doc: Add section for C API documentation

Message ID 20240415091806.18556-1-andrea.cervesato@suse.de
State Accepted
Headers show
Series [v1] doc: Add section for C API documentation | expand

Commit Message

Andrea Cervesato April 15, 2024, 9:18 a.m. UTC 
From: Andrea Cervesato <andrea.cervesato@suse.com>

Added information about the C API documentation format and the way
it's supported in Sphinx.

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
 doc/developers/documentation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Cyril Hrubis April 16, 2024, 12:53 p.m. UTC | #1 
Hi!
> +The C API documentation is written using

Maybe to be a bit more clear:

"The C API documentation is generated from headers using" ?

> +`kernel-doc <https://return42.github.io/linuxdoc/linuxdoc-howto/kernel-doc-syntax.html>`_
> +syntax which is supported by Sphinx via
> +`linuxdoc <https://pypi.org/project/linuxdoc/>`_ extension.
> -- 
> 2.35.3
> 
> 
> -- 
> Mailing list info: https://lists.linux.it/listinfo/ltp
Petr Vorel April 17, 2024, 9:19 a.m. UTC | #2 
Hi,

> Hi!
> > +The C API documentation is written using

> Maybe to be a bit more clear:

> "The C API documentation is generated from headers using" ?

+1

with that change:
Reviewed-by: Petr Vorel <pvorel@suse.cz>

If you both agree, I'll merge it with this change.

Kind regards,
Petr

> > +`kernel-doc <https://return42.github.io/linuxdoc/linuxdoc-howto/kernel-doc-syntax.html>`_
> > +syntax which is supported by Sphinx via
> > +`linuxdoc <https://pypi.org/project/linuxdoc/>`_ extension.
> > -- 
> > 2.35.3


> > -- 
> > Mailing list info: https://lists.linux.it/listinfo/ltp
Andrea Cervesato April 17, 2024, 9:20 a.m. UTC | #3 
Hi!

On 4/17/24 11:19, Petr Vorel wrote:
> Hi,
>
>> Hi!
>>> +The C API documentation is written using
>> Maybe to be a bit more clear:
>> "The C API documentation is generated from headers using" ?
> +1
>
> with that change:
> Reviewed-by: Petr Vorel <pvorel@suse.cz>
>
> If you both agree, I'll merge it with this change.

Sure.

Acked-by: Andrea Cervesato <andrea.cervesato@suse.com>

>
> Kind regards,
> Petr
>
>>> +`kernel-doc <https://return42.github.io/linuxdoc/linuxdoc-howto/kernel-doc-syntax.html>`_
>>> +syntax which is supported by Sphinx via
>>> +`linuxdoc <https://pypi.org/project/linuxdoc/>`_ extension.
>>> -- 
>>> 2.35.3
>
>>> -- 
>>> Mailing list info: https://lists.linux.it/listinfo/ltp

Andrea
Petr Vorel April 17, 2024, 10:07 a.m. UTC | #4 
Hi Andrea, Cyril,

> Hi!

> On 4/17/24 11:19, Petr Vorel wrote:
> > Hi,

> > > Hi!
> > > > +The C API documentation is written using
> > > Maybe to be a bit more clear:
> > > "The C API documentation is generated from headers using" ?
> > +1

> > with that change:
> > Reviewed-by: Petr Vorel <pvorel@suse.cz>

> > If you both agree, I'll merge it with this change.

> Sure.

Good, merged with this change (and Cyril's RBT).

> Acked-by: Andrea Cervesato <andrea.cervesato@suse.com>

FYI not added this, as you are the patch author (there is your SOB).

Kind regards,
Petr
diff mbox series

Patch

diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst
index 5b112bcaf..30dacd384 100644
--- a/doc/developers/documentation.rst
+++ b/doc/developers/documentation.rst
@@ -47,3 +47,11 @@  To check documentation words spelling, we provide support for
 documentation can be tested via ``make spelling`` command. Output will be
 visible in the ``doc/build`` folder and, if any error will be found, a warning
 message will be shown.
+
+C API documentation
+~~~~~~~~~~~~~~~~~~~
+
+The C API documentation is written using
+`kernel-doc <https://return42.github.io/linuxdoc/linuxdoc-howto/kernel-doc-syntax.html>`_
+syntax which is supported by Sphinx via
+`linuxdoc <https://pypi.org/project/linuxdoc/>`_ extension.