* [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4
@ 2022-07-02 11:07 Mauro Carvalho Chehab
2022-07-02 11:07 ` [dm-devel] [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst Mauro Carvalho Chehab
2022-07-03 3:26 ` [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Bagas Sanjaya
0 siblings, 2 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2022-07-02 11:07 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Krzysztof Wilczyński, alsa-devel, kvm, linux-pci,
Brendan Higgins, Jaroslav Kysela, dm-devel, Andreas Dilger,
linux-kselftest, Alasdair Kergon, Jonathan Corbet,
Mauro Carvalho Chehab, Takashi Iwai, Jakub Kicinski, Paolo Abeni,
Mike Snitzer, linux-tegra, Mauro Carvalho Chehab, kunit-dev,
linux-ext4, Theodore Ts'o, Eric Dumazet, Dipen Patel, netdev,
linux-wireless, linux-kernel, Johannes Berg, David S. Miller
This series is against next-20220701. It fixes several warnings
that are currently produced while building html docs.
Each patch in this series is independent from the others, as
each one touches a different file.
Mauro Carvalho Chehab (12):
docs: ext4: blockmap.rst: fix a broken table
docs: tegra194-hte.rst: don't include gpiolib.c twice
docs: device-mapper: add a blank line at writecache.rst
docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
docs: PCI: pci-vntb-howto.rst: fix a title markup
docs: virt: kvm: fix a title markup at api.rst
docs: ABI: sysfs-bus-nvdimm
kunit: test.h: fix a kernel-doc markup
net: mac80211: fix a kernel-doc markup
docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
docs: arm: index.rst: add google/chromebook-boot-flow
docs: leds: index.rst: add leds-qcom-lpg to it
Documentation/ABI/testing/sysfs-bus-nvdimm | 2 ++
Documentation/PCI/endpoint/pci-vntb-function.rst | 2 +-
Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +-
Documentation/admin-guide/device-mapper/writecache.rst | 1 +
Documentation/arm/index.rst | 2 ++
Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
Documentation/filesystems/ext4/blockmap.rst | 2 +-
Documentation/leds/index.rst | 1 +
Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
Documentation/virt/kvm/api.rst | 6 +++---
include/kunit/test.h | 2 +-
include/net/mac80211.h | 2 +-
12 files changed, 15 insertions(+), 11 deletions(-)
--
2.36.1
--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel
^ permalink raw reply [flat|nested] 3+ messages in thread
* [dm-devel] [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst
2022-07-02 11:07 [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Mauro Carvalho Chehab
@ 2022-07-02 11:07 ` Mauro Carvalho Chehab
2022-07-03 3:26 ` [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Bagas Sanjaya
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2022-07-02 11:07 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Jonathan Corbet, Mauro Carvalho Chehab, Mike Snitzer,
linux-kernel, dm-devel, Mauro Carvalho Chehab, Alasdair Kergon
The lack of it causes a build warning:
Documentation/admin-guide/device-mapper/writecache.rst:23: WARNING: Unexpected indentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/
Documentation/admin-guide/device-mapper/writecache.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/admin-guide/device-mapper/writecache.rst b/Documentation/admin-guide/device-mapper/writecache.rst
index 10429779a91a..6bf78b0446ac 100644
--- a/Documentation/admin-guide/device-mapper/writecache.rst
+++ b/Documentation/admin-guide/device-mapper/writecache.rst
@@ -20,6 +20,7 @@ Constructor parameters:
size)
5. the number of optional parameters (the parameters with an argument
count as two)
+
start_sector n (default: 0)
offset from the start of cache device in 512-byte sectors
high_watermark n (default: 50)
--
2.36.1
--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4
2022-07-02 11:07 [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Mauro Carvalho Chehab
2022-07-02 11:07 ` [dm-devel] [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst Mauro Carvalho Chehab
@ 2022-07-03 3:26 ` Bagas Sanjaya
1 sibling, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2022-07-03 3:26 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Krzysztof Wilczyński, Gwendal Grignou, kvm,
Linux Doc Mailing List, linux-pci, Brendan Higgins, alsa-devel,
Jaroslav Kysela, dm-devel, Andreas Dilger, linux-kselftest,
Alasdair Kergon, Jonathan Corbet, Mauro Carvalho Chehab,
Takashi Iwai, Jakub Kicinski, Paolo Abeni, Mike Snitzer,
linux-tegra, kunit-dev, linux-ext4, Theodore Ts'o,
Eric Dumazet, Dipen Patel, netdev, linux-wireless, linux-kernel,
Johannes Berg, David S. Miller
On Sat, Jul 02, 2022 at 12:07:32PM +0100, Mauro Carvalho Chehab wrote:
> This series is against next-20220701. It fixes several warnings
> that are currently produced while building html docs.
>
> Each patch in this series is independent from the others, as
> each one touches a different file.
>
> Mauro Carvalho Chehab (12):
> docs: ext4: blockmap.rst: fix a broken table
> docs: tegra194-hte.rst: don't include gpiolib.c twice
> docs: device-mapper: add a blank line at writecache.rst
> docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
> docs: PCI: pci-vntb-howto.rst: fix a title markup
> docs: virt: kvm: fix a title markup at api.rst
> docs: ABI: sysfs-bus-nvdimm
> kunit: test.h: fix a kernel-doc markup
> net: mac80211: fix a kernel-doc markup
> docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
> docs: arm: index.rst: add google/chromebook-boot-flow
> docs: leds: index.rst: add leds-qcom-lpg to it
>
Hi Mauro,
Thanks for cleaning up these warning above. However, I have already
submitted some of these cleanups (pending reviews or integration):
[1]: https://lore.kernel.org/linux-doc/20220702042350.23187-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/20220612000125.9777-1-bagasdotme@gmail.com/
[3]: https://lore.kernel.org/linux-doc/20220627095151.19339-1-bagasdotme@gmail.com/
[4]: https://lore.kernel.org/linux-doc/20220627082928.11239-1-bagasdotme@gmail.com/
There's still a warning left:
Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
But I think the Date: field that triggered the warning above looks OK.
Regardless of that, the build successed.
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
--
An old man doll... just what I always wanted! - Clara
--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-07-07 7:28 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-02 11:07 [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Mauro Carvalho Chehab
2022-07-02 11:07 ` [dm-devel] [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst Mauro Carvalho Chehab
2022-07-03 3:26 ` [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Bagas Sanjaya
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).