linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Linus Torvalds <torvalds@linux-foundation.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: Re: Linux 5.10-rc2 (docs build)
Date: Mon, 2 Nov 2020 17:59:22 +0100	[thread overview]
Message-ID: <20201102175922.4ed74e7a@coco.lan> (raw)
In-Reply-To: <d9b5a400-0dbb-3be8-66f2-f629ffe4a6b8@infradead.org>

Em Mon, 2 Nov 2020 08:02:34 -0800
Randy Dunlap <rdunlap@infradead.org> escreveu:

> On 11/2/20 12:33 AM, Mauro Carvalho Chehab wrote:
> > Em Mon, 2 Nov 2020 08:58:41 +0100
> > Mauro Carvalho Chehab <mchehab@kernel.org> escreveu:
> >   
> >> Hi Randy,
> >>
> >> Em Sun, 1 Nov 2020 16:01:54 -0800
> >> Randy Dunlap <rdunlap@infradead.org> escreveu:
> >>  
> >>> Something broke the docs build (SEVERE):
> >>>
> >>>
> >>> Sphinx parallel build error:
> >>> docutils.utils.SystemMessage: /home/rdunlap/lnx/lnx-510-rc2/Documentation/ABI/testing/sysfs-bus-rapidio:2: (SEVERE/4) Title level inconsistent:
> >>>
> >>> Attributes Common for All RapidIO Devices
> >>> -----------------------------------------
> >>>
> >>>  
> >>
> >> On what tree did you notice this? Linux-next or upstream?  
> 
> See $Subject:  5.10-rc2
> 
> 
> > Also: on what Sphinx version are you getting it? I'm not
> > able to reproduce the issue here, neither with Sphinx 2.4.4
> > nor with Sphinx 3.2.1.  
> 
> That could be one source of the problem:  ;)
> 
> from my docs build:
> 
> Sphinx version: 1.7.6
> Warning: It is recommended at least Sphinx version 1.7.9.
>          If you want pdf, you need at least 2.4.4.

Could be... From 1.7.6 to 1.7.9, there were bug fixes ;-)

Also, on Sphinx, they stop maintaining old versions once newer
stable ones are launched. So, any bug on 1.7.x (up to 3.2.x) will
remain unfixed[1].

In any case, could you please check if this patch solves the
issue?

	https://lore.kernel.org/lkml/6c62ef5c01d39dee8d891f8390c816d2a889670a.1604312590.git.mchehab+huawei@kernel.org/
	

> Note: It is recommended at least Sphinx version 2.4.4 if you need PDF support.
> 
> 
> > (building against next-20201102 and against 5.10-rc2)  
> 
> 
> Someone might want to update Documentation/process/changes.rst:
> Sphinx\ [#f1]_	       1.3		sphinx-build --version
> 
> Documentation/doc-guide/sphinx.rst also says minimal version is 1.3
> but then goes on to discuss other versions. It's a bit of a mess.

I don't test versions below 2.4 for a while, but I believe that
version 1.3 is still the minimal one for the documentation to be
built (earlier versions don't support some keywords used on a few
documents - and the Sphinx extensions can also break). 

Anyway, Jon is planning to raise the minimal version on Kernel
5.11, dropping some logic inside Documentation/sphinx/*.py that
are there to preserve backward compatibility with Python2 and with
too old versions of the toolchain.

After such changes, we should update changes.rst and sphinx.rst.

-

[1] On a side note, according with:
    https://www.sphinx-doc.org/en/master/changes.html
    Sphinx v3.3.0 was released today. Didn't test building with it yet.


Thanks,
Mauro

  reply	other threads:[~2020-11-02 16:59 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-01 23:04 Linux 5.10-rc2 Linus Torvalds
2020-11-02  0:01 ` Linux 5.10-rc2 (docs build) Randy Dunlap
2020-11-02  7:58   ` Mauro Carvalho Chehab
2020-11-02  8:33     ` Mauro Carvalho Chehab
2020-11-02 16:02       ` Randy Dunlap
2020-11-02 16:59         ` Mauro Carvalho Chehab [this message]
2020-11-02 19:23           ` Randy Dunlap
2020-11-02 20:35             ` Mauro Carvalho Chehab
2020-11-02 20:41               ` Randy Dunlap
2020-11-02 21:59                 ` Mauro Carvalho Chehab
2020-11-02 10:32   ` [PATCH 0/5] Some fixes for ABI documentation Mauro Carvalho Chehab
2020-11-02 10:32     ` [PATCH 1/5] docs: ABI: sysfs-driver-dma-ioatdma: what starts with /sys Mauro Carvalho Chehab
2020-11-02 10:32     ` [PATCH 2/5] docs: ABI: sysfs-class-net: fix a typo Mauro Carvalho Chehab
2020-11-02 10:32     ` [PATCH 3/5] docs: leds: index.rst: add a missing file Mauro Carvalho Chehab
2020-11-02 10:32     ` [PATCH 4/5] scripts: get_abi.pl: Don't let ABI files to create subtitles Mauro Carvalho Chehab
2020-11-02 10:32     ` [PATCH 5/5] scripts: get_api.pl: Add sub-titles to ABI output Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201102175922.4ed74e7a@coco.lan \
    --to=mchehab@kernel.org \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=torvalds@linux-foundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).