From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
linux-wireless@vger.kernel.org, linux-mtd@lists.infradead.org,
linux-fbdev@vger.kernel.org, linux-can@vger.kernel.org,
"Luis R. Rodriguez" <mcgrof@kernel.org>,
linux-iio@vger.kernel.org, dri-devel@lists.freedesktop.org,
linux-crypto@vger.kernel.org,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-pm@vger.kernel.org
Subject: [PATCH 00/18] Fix some build warnings/errors with Sphinx
Date: Mon, 7 May 2018 06:35:36 -0300 [thread overview]
Message-ID: <cover.1525684985.git.mchehab+samsung@kernel.org> (raw)
I decided to give a try with Sphinx last stable version
(1.17.4), and noticed several issues. The worse one was
with the networking book: a non-standard footnote there
with [*] instead of a number causes it to break PDF building.
So, I took some spare time to address some warnings all over
the tree, and moved a few text documents to a book. I with
I had more time to move the other ones and to solve other
warnings.
Mauro Carvalho Chehab (18):
docs: can.rst: fix a footnote reference
docs: fix location of request_firmware & friends
docs: */index.rst: Add newer documents to their respective index.rst
docs: admin-guide: add bcache documentation
docs: core-api: add cachetlb documentation
docs: core-api: add cgroup-v2 documentation
docs: core-api: add circular-buffers documentation
docs: driver-api: add clk documentation
net: mac80211.h: fix a bad comment line
rcu: rcupdate.h: get rid of Sphinx warnings at rcu_pointer_handoff()
docs: crypto_engine.rst: Fix two parse warnings
time: timer.c: adjust a kernel-doc comment
wait: wait.h: Get rid of a kernel-doc/Sphinx warnings
fbdev: modedb.c: fix a kernel-doc markup
iio: iio.h: use nested struct support on kernel-doc markup
mtd: rawnand.h: use nested union kernel-doc markups
docs: uio-howto.rst: use a code block to solve a warning
w1: w1_io.c: fix a kernel-doc warning
Documentation/00-INDEX | 10 -------
.../{bcache.txt => admin-guide/bcache.rst} | 0
.../cgroup-v2.rst} | 0
Documentation/admin-guide/index.rst | 2 ++
.../admin-guide/kernel-parameters.txt | 2 +-
.../{cachetlb.txt => core-api/cachetlb.rst} | 0
.../circular-buffers.rst} | 0
Documentation/core-api/index.rst | 2 ++
Documentation/crypto/crypto_engine.rst | 8 +++---
Documentation/crypto/index.rst | 1 +
Documentation/dell_rbu.txt | 4 +--
Documentation/{clk.txt => driver-api/clk.rst} | 0
.../firmware/fallback-mechanisms.rst | 2 +-
.../driver-api/firmware/request_firmware.rst | 17 +++++++-----
Documentation/driver-api/index.rst | 2 ++
Documentation/driver-api/infrastructure.rst | 2 +-
Documentation/driver-api/uio-howto.rst | 3 ++-
Documentation/memory-barriers.txt | 4 +--
Documentation/networking/can.rst | 4 +--
.../power/suspend-and-cpuhotplug.txt | 2 +-
Documentation/process/index.rst | 1 +
Documentation/security/index.rst | 2 ++
.../translations/ko_KR/memory-barriers.txt | 4 +--
drivers/video/fbdev/core/modedb.c | 22 ++++++++--------
drivers/w1/w1_io.c | 1 +
include/linux/iio/iio.h | 24 ++++++++---------
include/linux/mtd/rawnand.h | 26 +++++++++++++------
include/linux/rcupdate.h | 5 ++--
include/linux/wait.h | 2 +-
include/net/mac80211.h | 2 +-
kernel/time/timer.c | 14 +++++-----
31 files changed, 93 insertions(+), 75 deletions(-)
rename Documentation/{bcache.txt => admin-guide/bcache.rst} (100%)
rename Documentation/{cgroup-v2.txt => admin-guide/cgroup-v2.rst} (100%)
rename Documentation/{cachetlb.txt => core-api/cachetlb.rst} (100%)
rename Documentation/{circular-buffers.txt => core-api/circular-buffers.rst} (100%)
rename Documentation/{clk.txt => driver-api/clk.rst} (100%)
--
2.17.0
next reply other threads:[~2018-05-07 9:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-07 9:35 Mauro Carvalho Chehab [this message]
2018-05-07 9:35 ` [PATCH 15/18] iio: iio.h: use nested struct support on kernel-doc markup Mauro Carvalho Chehab
2018-05-07 17:08 ` Jonathan Cameron
2018-05-09 12:00 ` Mauro Carvalho Chehab
2018-05-08 16:13 ` [PATCH 00/18] Fix some build warnings/errors with Sphinx Jonathan Corbet
2018-05-08 17:36 ` Luis R. Rodriguez
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.1525684985.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=dri-devel@lists.freedesktop.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-can@vger.kernel.org \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fbdev@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux-wireless@vger.kernel.org \
--cc=mcgrof@kernel.org \
--cc=mchehab@infradead.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).