All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	"David S. Miller" <davem@davemloft.net>,
	Alexandru Elisei <alexandru.elisei@arm.com>,
	Andrew Jones <drjones@redhat.com>, Andrew Lunn <andrew@lunn.ch>,
	Anton Ivanov <anton.ivanov@cambridgegreys.com>,
	Balbir Singh <sblbir@amazon.com>,
	Bartosz Golaszewski <bgolaszewski@baylibre.com>,
	Eugeniu Rosca <erosca@de.adit-jv.com>,
	Geert Uytterhoeven <geert+renesas@glider.be>,
	Jakub Kicinski <kuba@kernel.org>, Jeff Dike <jdike@addtoit.com>,
	Linus Walleij <linus.walleij@linaro.org>,
	Marc Zyngier <maz@kernel.org>,
	Mathieu Poirier <mathieu.poirier@linaro.org>,
	Paolo Bonzini <pbonzini@redhat.com>,
	Richard Weinberger <richard@nod.at>,
	Taehee Yoo <ap420073@gmail.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	Ulrich Hecht <uli+renesas@fpond.eu>,
	Wolfram Sang <wsa@kernel.org>,
	kvm@vger.kernel.org, linux-gpio@vger.kernel.org,
	linux-i2c@vger.kernel.org, linux-um@lists.infradead.org,
	netdev@vger.kernel.org
Subject: [PATCH 0/6] Fix new html build warnings from next-20201001
Date: Fri,  2 Oct 2020 07:49:44 +0200	[thread overview]
Message-ID: <cover.1601616399.git.mchehab+huawei@kernel.org> (raw)

There are some new warnings when building the documentation from
yesterday's linux next. This small series fix them.

- patch 1 documents two new kernel-doc parameters on a net core file.
  I used the commit log in order to help documenting them;
- patch 2 fixes some tags at UMLv2 howto;
- patches 3 and 5 add some new documents at the corresponding
  index file.
- patch 4 changes kernel-doc script for it to recognize typedef enums.

Patch 4 should probably be merged via docs tree, but the others
are against stuff recently added at linux-next. So, the better is to
merge them directly at the trees which introduced the issue.

-

As a reference, the patches fixing all html build warnings are at:

	https://git.linuxtv.org/mchehab/experimental.git/log/?h=sphinx3-fixes-v3

Such series also adds support for Sphinx versions 3.1 and above.

It should be noticed that, with Sphinx version 3 and above, there
are a few new warnings, because currently Sphinx assumes a
that names are unique for all C symbols. There are a few cases
where we have the same name for a function and for a struct at
the Kernel. Upstream is already working on a solution for that.

So, for now, I recomend doing html builds with version < 3.


Mauro Carvalho Chehab (6):
  net: core: document two new elements of struct net_device
  docs: vcpu.rst: fix some build warnings
  docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markup
  docs: i2c: index.rst: add slave-testunit-backend.rst
  scripts: kernel-doc: add support for typedef enum
  docs: gpio: add a new document to its index.rst

 Documentation/admin-guide/gpio/index.rst      |  1 +
 .../admin-guide/hw-vuln/l1d_flush.rst         |  3 +--
 Documentation/i2c/index.rst                   |  1 +
 Documentation/virt/kvm/devices/vcpu.rst       | 26 +++++++++----------
 .../virt/uml/user_mode_linux_howto_v2.rst     |  1 +
 include/linux/netdevice.h                     |  5 ++++
 scripts/kernel-doc                            | 15 ++++++++---
 7 files changed, 33 insertions(+), 19 deletions(-)

-- 
2.26.2



             reply	other threads:[~2020-10-02  5:50 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-02  5:49 Mauro Carvalho Chehab [this message]
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  5:49   ` 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
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
2020-10-02  8:19   ` Marc Zyngier
2020-10-02  8:19   ` 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=cover.1601616399.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=alexandru.elisei@arm.com \
    --cc=andrew@lunn.ch \
    --cc=anton.ivanov@cambridgegreys.com \
    --cc=ap420073@gmail.com \
    --cc=bgolaszewski@baylibre.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=drjones@redhat.com \
    --cc=erosca@de.adit-jv.com \
    --cc=geert+renesas@glider.be \
    --cc=jdike@addtoit.com \
    --cc=kuba@kernel.org \
    --cc=kvm@vger.kernel.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-um@lists.infradead.org \
    --cc=mathieu.poirier@linaro.org \
    --cc=maz@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pbonzini@redhat.com \
    --cc=richard@nod.at \
    --cc=sblbir@amazon.com \
    --cc=tglx@linutronix.de \
    --cc=uli+renesas@fpond.eu \
    --cc=wsa@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.