linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Andrew Lunn <andrew@lunn.ch>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 5/6] scripts: kernel-doc: add support for typedef enum
Date: Sat, 3 Oct 2020 09:24:23 +0200	[thread overview]
Message-ID: <20201003092423.58e25910@coco.lan> (raw)
In-Reply-To: <20201002120728.GH4067422@lunn.ch>

Hi Andrew,

Em Fri, 2 Oct 2020 14:07:28 +0200
Andrew Lunn <andrew@lunn.ch> escreveu:

> On Fri, Oct 02, 2020 at 07:49:49AM +0200, Mauro Carvalho Chehab wrote:
> > The PHY kernel-doc markup has gained support for documenting
> > a typedef enum.
> > 
> > However, right now the parser was not prepared for it.  
> 
> Hi Mauro
> 
> Thanks for this. I'm using Sphinx 3.2.1, since that is what my Debian
> box has. So it can be hard to see the new warnings amongst the old.

Yeah, there were simply too much warnings with docs, and 3.2.1 is
even worse.

Things will improve a lot after merging my set of patches fixing
the issues for it. Yet, there are some warnings that can't currently
be fixed on Sphinx 3.2 (~10 warnings). Fixing those will require
some internal changes in Sphinx itself.

So, except if you need Sphinx 3 for some reason, I would suggest you
to uninstall it, and then use venv with Sphinx 2.4.4. The Kernel build
system should be able to provide you the commands for installing it,
once you remove the one from your PATH.

> Will this patch get merged via Jonathan Corbet's tree?

Yes, that's the plan.

Thanks,
Mauro

  reply	other threads:[~2020-10-03  7:24 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-02  5:49 [PATCH 0/6] Fix new html build warnings from next-20201001 Mauro Carvalho Chehab
2020-10-02  5:49 ` [PATCH 1/6] net: core: document two new elements of struct net_device Mauro Carvalho Chehab
2020-10-02 22:16   ` David Miller
2020-10-02  5:49 ` [PATCH 2/6] docs: vcpu.rst: fix some build warnings Mauro Carvalho Chehab
2020-10-02  7:58   ` Paolo Bonzini
2020-10-02  5:49 ` [PATCH 3/6] docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markup Mauro Carvalho Chehab
2020-10-02  7:38   ` Anton Ivanov
2020-10-02  5:49 ` [PATCH 4/6] docs: i2c: index.rst: add slave-testunit-backend.rst Mauro Carvalho Chehab
2020-10-02  7:54   ` Wolfram Sang
2020-10-02  9:02     ` Mauro Carvalho Chehab
2020-10-02  5:49 ` [PATCH 5/6] scripts: kernel-doc: add support for typedef enum Mauro Carvalho Chehab
2020-10-02 12:07   ` Andrew Lunn
2020-10-03  7:24     ` Mauro Carvalho Chehab [this message]
2020-10-02  5:49 ` [PATCH 6/6] docs: gpio: add a new document to its index.rst Mauro Carvalho Chehab
2020-10-02 15:28   ` Bartosz Golaszewski
2020-10-03  0:02   ` Kent Gibson
2020-10-07  8:41   ` Linus Walleij
2020-10-02  8:19 ` [PATCH 0/6] Fix new html build warnings from next-20201001 Marc Zyngier

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=20201003092423.58e25910@coco.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=andrew@lunn.ch \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.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).