gpio: sim: add doc file to index file

[PATCH ?next?] gpio: sim: add doc file to index file

Posted by Randy Dunlap 4 years, 5 months ago

Include the gpio-sim.rst file in the GPIO index (toc/table of contents).

Quietens this doc build warning:

Documentation/admin-guide/gpio/gpio-sim.rst: WARNING: document isn't included in any toctree

Fixes: b48f6b466e44 ("gpio: sim: new testing module")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
---
 Documentation/admin-guide/gpio/index.rst |    1 +
 1 file changed, 1 insertion(+)

--- linux-next-20220121.orig/Documentation/admin-guide/gpio/index.rst
+++ linux-next-20220121/Documentation/admin-guide/gpio/index.rst
@@ -10,6 +10,7 @@ gpio
     gpio-aggregator
     sysfs
     gpio-mockup
+    gpio-sim
 
 .. only::  subproject and html

Re: [PATCH ?next?] gpio: sim: add doc file to index file

Posted by Randy Dunlap 4 years, 5 months ago

Oops. Yes, the subject should say: [PATCH -next].
Sorry about that.


On 1/22/22 23:35, Randy Dunlap wrote:
> Include the gpio-sim.rst file in the GPIO index (toc/table of contents).
> 
> Quietens this doc build warning:
> 
> Documentation/admin-guide/gpio/gpio-sim.rst: WARNING: document isn't included in any toctree
> 
> Fixes: b48f6b466e44 ("gpio: sim: new testing module")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> ---
>  Documentation/admin-guide/gpio/index.rst |    1 +
>  1 file changed, 1 insertion(+)
> 
> --- linux-next-20220121.orig/Documentation/admin-guide/gpio/index.rst
> +++ linux-next-20220121/Documentation/admin-guide/gpio/index.rst
> @@ -10,6 +10,7 @@ gpio
>      gpio-aggregator
>      sysfs
>      gpio-mockup
> +    gpio-sim
>  
>  .. only::  subproject and html
>  

-- 
~Randy

Re: [PATCH ?next?] gpio: sim: add doc file to index file

Posted by Bartosz Golaszewski 4 years, 5 months ago

On Sun, Jan 23, 2022 at 8:35 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Include the gpio-sim.rst file in the GPIO index (toc/table of contents).
>
> Quietens this doc build warning:
>
> Documentation/admin-guide/gpio/gpio-sim.rst: WARNING: document isn't included in any toctree
>
> Fixes: b48f6b466e44 ("gpio: sim: new testing module")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> ---
>  Documentation/admin-guide/gpio/index.rst |    1 +
>  1 file changed, 1 insertion(+)
>
> --- linux-next-20220121.orig/Documentation/admin-guide/gpio/index.rst
> +++ linux-next-20220121/Documentation/admin-guide/gpio/index.rst
> @@ -10,6 +10,7 @@ gpio
>      gpio-aggregator
>      sysfs
>      gpio-mockup
> +    gpio-sim
>
>  .. only::  subproject and html
>

Applied, thanks!

Bart