diff mbox series

[6/8] docs/gpu: fix a documentation build break in i915.rst

Message ID 20190522205034.25724-7-corbet@lwn.net
State New
Headers show
Series docs: Fixes for recent versions of Sphinx | expand

Commit Message

Jonathan Corbet May 22, 2019, 8:50 p.m. UTC
Documentation/gpu/i915.rst is not included in the TOC tree, but newer
versions of sphinx parse it anyway.  That leads to this hard build failure:

> Global GTT Fence Handling

> ~~~~~~~~~~~~~~~~~~~~~~~~~

>

> reST markup error:

> /stuff/k/git/kernel/Documentation/gpu/i915.rst:403: (SEVERE/4) Title level inconsistent:


Make the underlining consistent and restore a working docs build.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>

---
 Documentation/gpu/i915.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.21.0

Comments

Daniel Vetter May 29, 2019, 6:54 a.m. UTC | #1
On Wed, May 22, 2019 at 10:51 PM Jonathan Corbet <corbet@lwn.net> wrote:
>

> Documentation/gpu/i915.rst is not included in the TOC tree, but newer

> versions of sphinx parse it anyway.  That leads to this hard build failure:


It is included I think: Documentation/gpu/index.rst -> drivers.rst ->
i915.rst. With that corrected A-b: me.

btw this patch didn't go to intel-gfx and all i915 maintainers, I
think per get_maintainers.pl it should have. Just asking since I had a
few patches of my own where get_maintainers.pl didn't seem to do the
right thing somehow.
-Daniel

>

> > Global GTT Fence Handling

> > ~~~~~~~~~~~~~~~~~~~~~~~~~

> >

> > reST markup error:

> > /stuff/k/git/kernel/Documentation/gpu/i915.rst:403: (SEVERE/4) Title level inconsistent:

>

> Make the underlining consistent and restore a working docs build.

>

> Signed-off-by: Jonathan Corbet <corbet@lwn.net>

> ---

>  Documentation/gpu/i915.rst | 4 ++--

>  1 file changed, 2 insertions(+), 2 deletions(-)

>

> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst

> index 055df45596c1..cf9ff64753cc 100644

> --- a/Documentation/gpu/i915.rst

> +++ b/Documentation/gpu/i915.rst

> @@ -401,13 +401,13 @@ GTT Fences and Swizzling

>     :internal:

>

>  Global GTT Fence Handling

> -~~~~~~~~~~~~~~~~~~~~~~~~~

> +-------------------------

>

>  .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c

>     :doc: fence register handling

>

>  Hardware Tiling and Swizzling Details

> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

> +-------------------------------------

>

>  .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c

>     :doc: tiling swizzling details

> --

> 2.21.0

>



-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
Jonathan Corbet May 29, 2019, 1:50 p.m. UTC | #2
On Wed, 29 May 2019 08:54:16 +0200
Daniel Vetter <daniel.vetter@ffwll.ch> wrote:

> > Documentation/gpu/i915.rst is not included in the TOC tree, but newer

> > versions of sphinx parse it anyway.  That leads to this hard build failure:  

> 

> It is included I think: Documentation/gpu/index.rst -> drivers.rst ->

> i915.rst. With that corrected A-b: me.

> 

> btw this patch didn't go to intel-gfx and all i915 maintainers, I

> think per get_maintainers.pl it should have. Just asking since I had a

> few patches of my own where get_maintainers.pl didn't seem to do the

> right thing somehow.


It is included, just a level down and I wasn't paying attention.

In any case, this patch needs to be dropped; the kerneldoc comment
changes I sent (and Jani acked) are the better fix for this problem.

Thanks,

jon
diff mbox series

Patch

diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 055df45596c1..cf9ff64753cc 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -401,13 +401,13 @@  GTT Fences and Swizzling
    :internal:
 
 Global GTT Fence Handling
-~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------
 
 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
    :doc: fence register handling
 
 Hardware Tiling and Swizzling Details
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------
 
 .. kernel-doc:: drivers/gpu/drm/i915/i915_gem_fence_reg.c
    :doc: tiling swizzling details