linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Luca Ceresoli <luca.ceresoli@bootlin.com>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation
Date: Sun, 3 Dec 2023 13:04:53 +0700	[thread overview]
Message-ID: <ZWwahc1PSY6Uj6_J@archie.me> (raw)
In-Reply-To: <20231201-nvmem-docs-kerneldoc-v1-1-3e8f2b706ce6@bootlin.com>

[-- Attachment #1: Type: text/plain, Size: 1114 bytes --]

On Fri, Dec 01, 2023 at 02:10:42PM +0100, Luca Ceresoli wrote:
> This is useful on its own, and it also enables hyperlink generation for
> functions mentioned in ReST documentation.
> 
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
>  Documentation/driver-api/nvmem.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
> index de221e91c8e3..d5655b95c0f4 100644
> --- a/Documentation/driver-api/nvmem.rst
> +++ b/Documentation/driver-api/nvmem.rst
> @@ -200,3 +200,9 @@ and let you add cells dynamically.
>  Another use case for layouts is the post processing of cells. With layouts,
>  it is possible to associate a custom post processing hook to a cell. It
>  even possible to add this hook to cells not created by the layout itself.
> +
> +9. Internal kernel API
> +======================
> +
> +.. kernel-doc:: drivers/nvmem/core.c
> +   :export:
> 

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2023-12-03  6:04 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-01 13:10 [PATCH 0/2] docs: nvmem: minor improvements Luca Ceresoli
2023-12-01 13:10 ` [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation Luca Ceresoli
2023-12-03  6:04   ` Bagas Sanjaya [this message]
2023-12-01 13:10 ` [PATCH 2/2] docs: nvmem: remove function parameters (fixes hyperlink generation) Luca Ceresoli
2023-12-08 22:44 ` [PATCH 0/2] docs: nvmem: minor improvements Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZWwahc1PSY6Uj6_J@archie.me \
    --to=bagasdotme@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luca.ceresoli@bootlin.com \
    --cc=thomas.petazzoni@bootlin.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).