[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-Id: <cover.1660829433.git.mchehab@kernel.org>
Date: Thu, 18 Aug 2022 15:38:46 +0200
From: Mauro Carvalho Chehab <mchehab@...nel.org>
To: Linux Doc Mailing List <linux-doc@...r.kernel.org>, corbet@....net
Cc: Mauro Carvalho Chehab <mchehab@...nel.org>,
linux-kernel@...r.kernel.org,
"Peter Zijlstra (Intel)" <peterz@...radead.org>,
Akira Yokosawa <akiyks@...il.com>, Alex Shi <alexs@...nel.org>,
Andrew Morton <akpm@...ux-foundation.org>,
Andrey Grodzovsky <andrey.grodzovsky@....com>,
Bagas Sanjaya <bagasdotme@...il.com>,
Dan Williams <dan.j.williams@...el.com>,
Daniel Vetter <daniel@...ll.ch>,
David Airlie <airlied@...ux.ie>,
David Howells <dhowells@...hat.com>,
Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
Ilya Dryomov <idryomov@...il.com>,
Jiri Kosina <jkosina@...e.cz>,
Jiri Slaby <jirislaby@...nel.org>,
Kajol Jain <kjain@...ux.ibm.com>,
Kosuke Fujimoto <fujimotokosuke0@...il.com>,
Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>,
Leo Yan <leo.yan@...aro.org>,
Luis Chamberlain <mcgrof@...nel.org>,
Lukas Bulwahn <lukas.bulwahn@...il.com>,
Madhavan Srinivasan <maddy@...ibm.com>,
Mathieu Poirier <mathieu.poirier@...aro.org>,
Mike Kravetz <mike.kravetz@...cle.com>,
Mike Leach <mike.leach@...aro.org>,
Mike Rapoport <rppt@...nel.org>,
Muchun Song <songmuchun@...edance.com>,
Rob Herring <robh@...nel.org>,
Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
Suzuki K Poulose <suzuki.poulose@....com>,
Tsugikazu Shibata <shibata@...uxfoundation.org>,
Wu XiangCheng <bobwxc@...il.cn>, Xiubo Li <xiubli@...hat.com>,
Yanteng Si <siyanteng@...ngson.cn>, coresight@...ts.linaro.org,
dri-devel@...ts.freedesktop.org,
linux-arm-kernel@...ts.infradead.org, linux-cachefs@...hat.com,
linux-mm@...ck.org
Subject: [PATCH 00/13] Fix documentation build warnings against 6.0-rc1
Hi Jon,
This series is against 6.0-rc1, so it should apply fine on the top of your tree.
After applying one fix sent to ACPI:
https://lore.kernel.org/linux-acpi/20220818055156.7456-1-sakari.ailus@linux.intel.com/T/#u
make htmldocs (with Sphinx 2.4.4) produces a very clean result:
:
Warning: Documentation/devicetree/bindings/regulator/siliconmitus,sm5703
-regulator.yaml references a file that doesn't exist: Documentation/devicetree/b
indings/mfd/siliconmitus,sm5703.yaml
SPHINX htmldocs --> file:///new_devel/v4l/docs/Documentation/output
PARSE include/uapi/linux/dvb/ca.h
PARSE include/uapi/linux/dvb/dmx.h
PARSE include/uapi/linux/dvb/frontend.h
PARSE include/uapi/linux/dvb/net.h
PARSE include/uapi/linux/videodev2.h
PARSE include/uapi/linux/media.h
PARSE include/uapi/linux/cec.h
PARSE include/uapi/linux/lirc.h
Using sphinx_rtd_theme theme
The only warning is due to a driver that got its upstream way for MFD, but it seems that
the corresponding regulator driver has lost its way.
If we can fix such warning, we could add a sort of "Werror" for:
- some ABI issues;
- kernel-doc warnings/errors;
- broken kernel-doc warnings.
Although there will still have Sphinx warnings that can come up from various sources,
this could help to keep documentation on a better shape, as time goes by.
Regards,
Mauro
Mauro Carvalho Chehab (13):
scripts: kernel-doc: add support for EXPORT_SYMBOL variants
docs: update vmemmap_dedup.rst reference
docs: ja_JP: remove SubmittingPatches
docs: zh_CN: remove references to rust documentation
dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference
Documentation: coresight: fix a documentation build warning
MAINTAINERS: fix wildcard for mfd da90* files
MAINTAINERS: fix a typo for hpe,gxp-spifi.yaml
ABI: sysfs-bus-nvdimm: fix a doc build warning
docs: leds: add leds-qcom-lpg.rst to the index file
fscache: fix kernel-doc markup on two functions
serial: document start_rx member at struct uart_ops
fs/dcache: fix a kernel-doc markup
Documentation/ABI/testing/sysfs-bus-nvdimm | 2 +
Documentation/leds/index.rst | 1 +
.../trace/coresight/coresight-cpu-debug.rst | 2 +-
Documentation/trace/coresight/coresight.rst | 2 +-
.../translations/ja_JP/SubmittingPatches | 722 ------------------
.../zh_CN/doc-guide/kernel-doc.rst | 2 -
MAINTAINERS | 4 +-
drivers/gpu/drm/scheduler/sched_main.c | 1 +
include/drm/gpu_scheduler.h | 1 +
include/linux/dcache.h | 10 +-
include/linux/fscache.h | 4 +-
include/linux/serial_core.h | 8 +
mm/hugetlb_vmemmap.h | 2 +-
scripts/kernel-doc | 8 +-
14 files changed, 33 insertions(+), 736 deletions(-)
delete mode 100644 Documentation/translations/ja_JP/SubmittingPatches
--
2.37.1
Powered by blists - more mailing lists