* Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1) [not found] <20200127145835.GI2841@vkoul-mobl> @ 2020-01-28 11:50 ` Michael Ellerman 2020-01-28 12:24 ` Vinod Koul 0 siblings, 1 reply; 5+ messages in thread From: Michael Ellerman @ 2020-01-28 11:50 UTC (permalink / raw) To: Vinod Koul, peter.ujfalusi; +Cc: dma, LKML, corbet, linux-doc, Linus Torvalds Hi Vinod, Vinod Koul <vkoul@kernel.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 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1) 2020-01-28 11:50 ` Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1) Michael Ellerman @ 2020-01-28 12:24 ` Vinod Koul 2020-01-28 12:35 ` Peter Ujfalusi 2020-01-29 5:29 ` Michael Ellerman 0 siblings, 2 replies; 5+ messages in thread From: Vinod Koul @ 2020-01-28 12:24 UTC (permalink / raw) To: Michael Ellerman Cc: peter.ujfalusi, dma, LKML, corbet, linux-doc, Linus Torvalds Hi Michael, On 28-01-20, 22:50, Michael Ellerman wrote: > Hi Vinod, > > Vinod Koul <vkoul@kernel.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. Thanks for the report. > 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** > + I have modified this to below as this: --- a/Documentation/driver-api/dmaengine/client.rst +++ b/Documentation/driver-api/dmaengine/client.rst @@ -151,8 +151,8 @@ The details of these operations are: 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 And I will add this as fixes and it should be in linux-next tomorrow Thanks -- ~Vinod ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1) 2020-01-28 12:24 ` Vinod Koul @ 2020-01-28 12:35 ` Peter Ujfalusi 2020-01-29 7:47 ` Matthew Wilcox 2020-01-29 5:29 ` Michael Ellerman 1 sibling, 1 reply; 5+ messages in thread From: Peter Ujfalusi @ 2020-01-28 12:35 UTC (permalink / raw) To: Vinod Koul, Michael Ellerman; +Cc: dma, LKML, corbet, linux-doc, Linus Torvalds Hi Michael, Vinod, On 28/01/2020 14.24, Vinod Koul wrote: > Hi Michael, > > On 28-01-20, 22:50, Michael Ellerman wrote: >> Hi Vinod, >> >> Vinod Koul <vkoul@kernel.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. > > Thanks for the report. > >> 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** >> + > > I have modified this to below as this: > > --- a/Documentation/driver-api/dmaengine/client.rst > +++ b/Documentation/driver-api/dmaengine/client.rst > @@ -151,8 +151,8 @@ The details of these operations are: > 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 > > And I will add this as fixes and it should be in linux-next tomorrow Sorry for breaking the build and thanks Vinod for the quick fix! > > Thanks > - Péter Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1) 2020-01-28 12:35 ` Peter Ujfalusi @ 2020-01-29 7:47 ` Matthew Wilcox 0 siblings, 0 replies; 5+ messages in thread From: Matthew Wilcox @ 2020-01-29 7:47 UTC (permalink / raw) To: Peter Ujfalusi Cc: Vinod Koul, Michael Ellerman, dma, LKML, corbet, linux-doc, Linus Torvalds On Tue, Jan 28, 2020 at 02:35:17PM +0200, Peter Ujfalusi wrote: > Hi Michael, Vinod, > > On 28/01/2020 14.24, Vinod Koul wrote: > > Hi Michael, > > > > On 28-01-20, 22:50, Michael Ellerman wrote: > >> Hi Vinod, > >> > >> Vinod Koul <vkoul@kernel.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. > > > > Thanks for the report. > > > >> 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** > >> + > > > > I have modified this to below as this: > > > > --- a/Documentation/driver-api/dmaengine/client.rst > > +++ b/Documentation/driver-api/dmaengine/client.rst > > @@ -151,8 +151,8 @@ The details of these operations are: > > 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 > > > > And I will add this as fixes and it should be in linux-next tomorrow > > Sorry for breaking the build and thanks Vinod for the quick fix! Can I suggest, in future, 'make W=1'. That will run the kernel-doc script which would presumably have caught this problem. If we get all the existing doc errors cleaned up, we can promote that to be run as part of the standard build, but until then we don't want to dump 700 new errors on everybody. ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1) 2020-01-28 12:24 ` Vinod Koul 2020-01-28 12:35 ` Peter Ujfalusi @ 2020-01-29 5:29 ` Michael Ellerman 1 sibling, 0 replies; 5+ messages in thread From: Michael Ellerman @ 2020-01-29 5:29 UTC (permalink / raw) To: Vinod Koul; +Cc: peter.ujfalusi, dma, LKML, corbet, linux-doc, Linus Torvalds Vinod Koul <vkoul@kernel.org> writes: > On 28-01-20, 22:50, Michael Ellerman wrote: ... > > I have modified this to below as this: > > --- a/Documentation/driver-api/dmaengine/client.rst > +++ b/Documentation/driver-api/dmaengine/client.rst > @@ -151,8 +151,8 @@ The details of these operations are: > 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 > > And I will add this as fixes and it should be in linux-next tomorrow Thanks! cheers ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-01-29 7:47 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20200127145835.GI2841@vkoul-mobl>
2020-01-28 11:50 ` Docs build broken by driver-api/dmaengine/client.rst ? (was Re: [GIT PULL]: dmaengine updates for v5.6-rc1) Michael Ellerman
2020-01-28 12:24 ` Vinod Koul
2020-01-28 12:35 ` Peter Ujfalusi
2020-01-29 7:47 ` Matthew Wilcox
2020-01-29 5:29 ` Michael Ellerman
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).