linux-kernel - Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1)

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 28 Jan 2020 22:50:21 +1100
From:   Michael Ellerman <mpe@...erman.id.au>
To:     Vinod Koul <vkoul@...nel.org>, peter.ujfalusi@...com
Cc:     dma <dmaengine@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>, corbet@....net,
        linux-doc@...r.kernel.org,
        Linus Torvalds <torvalds@...ux-foundation.org>
Subject: Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1)

Hi Vinod,

Vinod Koul <vkoul@...nel.org> writes:
> Hello Linus,
>
> Please pull to receive the dmaengine updates for v5.6-rc1. This time we
> have a bunch of core changes to support dynamic channels, hotplug of
> controllers, new apis for metadata ops etc along with new drivers for
> Intel data accelerators, TI K3 UDMA, PLX DMA engine and hisilicon
> Kunpeng DMA engine. Also usual assorted updates to drivers.
>
> The following changes since commit e42617b825f8073569da76dc4510bfa019b1c35a:
>
>   Linux 5.5-rc1 (2019-12-08 14:57:55 -0800)
>
> are available in the Git repository at:
>
>   git://git.infradead.org/users/vkoul/slave-dma.git tags/dmaengine-5.6-rc1
>
> for you to fetch changes up to 71723a96b8b1367fefc18f60025dae792477d602:
>
>   dmaengine: Create symlinks between DMA channels and slaves (2020-01-24 11:41:32 +0530)
>
> ----------------------------------------------------------------
> dmaengine updates for v5.6-rc1
...
>
> Peter Ujfalusi (9):
>       dmaengine: doc: Add sections for per descriptor metadata support

This broke the docs build for me with:

  Sphinx parallel build error:
  docutils.utils.SystemMessage: /linux/Documentation/driver-api/dmaengine/client.rst:155: (SEVERE/4) Unexpected section title.
  
  Optional: per descriptor metadata
  ---------------------------------


The patch below fixes the build. It may not produce the output you
intended, it just makes it bold rather than a heading, but it doesn't
really make sense to have a heading inside a numbered list.

diff --git a/Documentation/driver-api/dmaengine/client.rst b/Documentation/driver-api/dmaengine/client.rst
index a9a7a3c84c63..343df26e73e8 100644
--- a/Documentation/driver-api/dmaengine/client.rst
+++ b/Documentation/driver-api/dmaengine/client.rst
@@ -151,8 +151,8 @@ DMA usage
      Note that callbacks will always be invoked from the DMA
      engines tasklet, never from interrupt context.
 
-  Optional: per descriptor metadata
-  ---------------------------------
+  **Optional: per descriptor metadata**
+
   DMAengine provides two ways for metadata support.
 
   DESC_METADATA_CLIENT



cheers