[PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[Mauro Carvalho Chehab]

This series is against next-20220701. It fixes several warnings
that are currently produced while building html docs.

Each patch in this series is independent from the others, as
each one touches a different file.

Mauro Carvalho Chehab (12):
  docs: ext4: blockmap.rst: fix a broken table
  docs: tegra194-hte.rst: don't include gpiolib.c twice
  docs: device-mapper: add a blank line at writecache.rst
  docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
  docs: PCI: pci-vntb-howto.rst: fix a title markup
  docs: virt: kvm: fix a title markup at api.rst
  docs: ABI: sysfs-bus-nvdimm
  kunit: test.h: fix a kernel-doc markup
  net: mac80211: fix a kernel-doc markup
  docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
  docs: arm: index.rst: add google/chromebook-boot-flow
  docs: leds: index.rst: add leds-qcom-lpg to it

 Documentation/ABI/testing/sysfs-bus-nvdimm             | 2 ++
 Documentation/PCI/endpoint/pci-vntb-function.rst       | 2 +-
 Documentation/PCI/endpoint/pci-vntb-howto.rst          | 2 +-
 Documentation/admin-guide/device-mapper/writecache.rst | 1 +
 Documentation/arm/index.rst                            | 2 ++
 Documentation/driver-api/hte/tegra194-hte.rst          | 3 +--
 Documentation/filesystems/ext4/blockmap.rst            | 2 +-
 Documentation/leds/index.rst                           | 1 +
 Documentation/sound/kernel-api/alsa-driver-api.rst     | 1 -
 Documentation/virt/kvm/api.rst                         | 6 +++---
 include/kunit/test.h                                   | 2 +-
 include/net/mac80211.h                                 | 2 +-
 12 files changed, 15 insertions(+), 11 deletions(-)

-- 
2.36.1

[PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Mauro Carvalho Chehab]

All extern functions of drivers/gpio/gpiolib.c are already
inside the Kernel documentation, as driver-api/gpio/index.rst
already includes it.

Placing a kernel-doc here will only cause mess, as the same symbol
will be placed on two parts of the document, causing breakages
in cross-references.

So, instead, add a cross-reference there.

This solves those Sphinx 3.1+ warnings:
    .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
    .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
    .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
    .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
    .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
    .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
    .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
    .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/

 Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentation/driver-api/hte/tegra194-hte.rst
index d29b7fe86f31..f2d617265546 100644
--- a/Documentation/driver-api/hte/tegra194-hte.rst
+++ b/Documentation/driver-api/hte/tegra194-hte.rst
@@ -25,8 +25,7 @@ and userspace consumers. The kernel space consumers can directly talk to HTE
 subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV
 framework to HTE subsystem.
 
-.. kernel-doc:: drivers/gpio/gpiolib.c
-   :functions: gpiod_enable_hw_timestamp_ns gpiod_disable_hw_timestamp_ns
+See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns().
 
 For userspace consumers, GPIO_V2_LINE_FLAG_EVENT_CLOCK_HTE flag must be
 specified during IOCTL calls. Refer to ``tools/gpio/gpio-event-mon.c``, which
-- 
2.36.1

Re: [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[Bagas Sanjaya]

On Sat, Jul 02, 2022 at 12:07:32PM +0100, Mauro Carvalho Chehab wrote:
> This series is against next-20220701. It fixes several warnings
> that are currently produced while building html docs.
> 
> Each patch in this series is independent from the others, as
> each one touches a different file.
> 
> Mauro Carvalho Chehab (12):
>   docs: ext4: blockmap.rst: fix a broken table
>   docs: tegra194-hte.rst: don't include gpiolib.c twice
>   docs: device-mapper: add a blank line at writecache.rst
>   docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
>   docs: PCI: pci-vntb-howto.rst: fix a title markup
>   docs: virt: kvm: fix a title markup at api.rst
>   docs: ABI: sysfs-bus-nvdimm
>   kunit: test.h: fix a kernel-doc markup
>   net: mac80211: fix a kernel-doc markup
>   docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
>   docs: arm: index.rst: add google/chromebook-boot-flow
>   docs: leds: index.rst: add leds-qcom-lpg to it
> 

Hi Mauro,

Thanks for cleaning up these warning above. However, I have already
submitted some of these cleanups (pending reviews or integration):

[1]: https://lore.kernel.org/linux-doc/20220702042350.23187-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/20220612000125.9777-1-bagasdotme@gmail.com/
[3]: https://lore.kernel.org/linux-doc/20220627095151.19339-1-bagasdotme@gmail.com/
[4]: https://lore.kernel.org/linux-doc/20220627082928.11239-1-bagasdotme@gmail.com/

There's still a warning left:

Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.

But I think the Date: field that triggered the warning above looks OK.

Regardless of that, the build successed.

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

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

Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Dipen Patel]

On 7/2/22 4:07 AM, Mauro Carvalho Chehab wrote:
> All extern functions of drivers/gpio/gpiolib.c are already
> inside the Kernel documentation, as driver-api/gpio/index.rst
> already includes it.
>
> Placing a kernel-doc here will only cause mess, as the same symbol
> will be placed on two parts of the document, causing breakages
> in cross-references.
>
> So, instead, add a cross-reference there.
>
> This solves those Sphinx 3.1+ warnings:
>     .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
>     .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
>     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
>     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
>     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
>     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
>     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
>     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
>
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/
>
>  Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentation/driver-api/hte/tegra194-hte.rst
> index d29b7fe86f31..f2d617265546 100644
> --- a/Documentation/driver-api/hte/tegra194-hte.rst
> +++ b/Documentation/driver-api/hte/tegra194-hte.rst
> @@ -25,8 +25,7 @@ and userspace consumers. The kernel space consumers can directly talk to HTE
>  subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV
>  framework to HTE subsystem.
>  
> -.. kernel-doc:: drivers/gpio/gpiolib.c
> -   :functions: gpiod_enable_hw_timestamp_ns gpiod_disable_hw_timestamp_ns
> +See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns().
>  
>  For userspace consumers, GPIO_V2_LINE_FLAG_EVENT_CLOCK_HTE flag must be
>  specified during IOCTL calls. Refer to ``tools/gpio/gpio-event-mon.c``, which

Acked-by: Dipen Patel <dipenp@nvidia.com>

Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Thierry Reding]

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

On Wed, Jul 06, 2022 at 01:48:58PM -0700, Dipen Patel wrote:
> On 7/2/22 4:07 AM, Mauro Carvalho Chehab wrote:
> > All extern functions of drivers/gpio/gpiolib.c are already
> > inside the Kernel documentation, as driver-api/gpio/index.rst
> > already includes it.
> >
> > Placing a kernel-doc here will only cause mess, as the same symbol
> > will be placed on two parts of the document, causing breakages
> > in cross-references.
> >
> > So, instead, add a cross-reference there.
> >
> > This solves those Sphinx 3.1+ warnings:
> >     .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> > ---
> >
> > To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> > See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/
> >
> >  Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
> >  1 file changed, 1 insertion(+), 2 deletions(-)
> >
> > diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentation/driver-api/hte/tegra194-hte.rst
> > index d29b7fe86f31..f2d617265546 100644
> > --- a/Documentation/driver-api/hte/tegra194-hte.rst
> > +++ b/Documentation/driver-api/hte/tegra194-hte.rst
> > @@ -25,8 +25,7 @@ and userspace consumers. The kernel space consumers can directly talk to HTE
> >  subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV
> >  framework to HTE subsystem.
> >  
> > -.. kernel-doc:: drivers/gpio/gpiolib.c
> > -   :functions: gpiod_enable_hw_timestamp_ns gpiod_disable_hw_timestamp_ns
> > +See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns().
> >  
> >  For userspace consumers, GPIO_V2_LINE_FLAG_EVENT_CLOCK_HTE flag must be
> >  specified during IOCTL calls. Refer to ``tools/gpio/gpio-event-mon.c``, which
> 
> Acked-by: Dipen Patel <dipenp@nvidia.com>

Hi Jonathan,

here's another one that applies on top of that earlier patch. Can you
apply this to your tree?

Thanks,
Thierry

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

Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Jonathan Corbet]

Thierry Reding <thierry.reding@gmail.com> writes:

> here's another one that applies on top of that earlier patch. Can you
> apply this to your tree?

Done.

Thanks,

jon