[PATCH 0/2] docs: nvmem: minor improvements

[PATCH 0/2] docs: nvmem: minor improvements

[Luca Ceresoli]

This series contains two small improvements to the NVMEM subsystem
documentation.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
Luca Ceresoli (2):
      docs: nvmem: generate kernel-doc API documentation
      docs: nvmem: remove function parameters (fixes hyperlink generation)

 Documentation/driver-api/nvmem.rst | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
---
base-commit: 8608dc8b55496087e82db3c955289b71a22735c6
change-id: 20231201-nvmem-docs-kerneldoc-cbe8f9a454c3

Best regards,
-- 
Luca Ceresoli <luca.ceresoli@bootlin.com>

[PATCH 1/2] docs: nvmem: generate kernel-doc API documentation

[Luca Ceresoli]

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:

-- 
2.34.1

Re: [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation

[Bagas Sanjaya]

[-- 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 --]

[PATCH 2/2] docs: nvmem: remove function parameters (fixes hyperlink generation)

[Luca Ceresoli]

Adding a parameter is not particularly useful here, and it is definitely
not done elsewhere. It also prevents the generation of a hyperlink to the
kernel-doc documentation. Removing the parameter to enable hyperlinks and
make the style coherent.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 Documentation/driver-api/nvmem.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
index d5655b95c0f4..5d9500d21ecc 100644
--- a/Documentation/driver-api/nvmem.rst
+++ b/Documentation/driver-api/nvmem.rst
@@ -41,7 +41,7 @@ A NVMEM provider can register with NVMEM core by supplying relevant
 nvmem configuration to nvmem_register(), on success core would return a valid
 nvmem_device pointer.
 
-nvmem_unregister(nvmem) is used to unregister a previously registered provider.
+nvmem_unregister() is used to unregister a previously registered provider.
 
 For example, a simple nvram case::
 

-- 
2.34.1

Re: [PATCH 0/2] docs: nvmem: minor improvements

[Jonathan Corbet]

Luca Ceresoli <luca.ceresoli@bootlin.com> writes:

> This series contains two small improvements to the NVMEM subsystem
> documentation.
>
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
> Luca Ceresoli (2):
>       docs: nvmem: generate kernel-doc API documentation
>       docs: nvmem: remove function parameters (fixes hyperlink generation)
>
>  Documentation/driver-api/nvmem.rst | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)

Applied, thanks.

jon