Fix documentation build warnings against 6.0-rc1
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest13 patches 10 repliesIn review
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/13 | scripts: kernel-doc: add support for EXPORT_SYMBOL variantsscripts/ | +4 | 0 replies | |
| 2/13 | docs: update vmemmap_dedup.rst referencemm/ | +1 | 2 replies | |
| 3/13 | docs: ja_JP: remove SubmittingPatchesDocumentation/ | +0 | 2 replies | |
| 4/13 | docs: zh_CN: remove references to rust documentationDocumentation/ | +0 | 1 reply | |
| 5/13 | dt-bindings: arm: update arm,coresight-cpu-debug.yaml referenceDocumentation/ | +1 | 1 reply | |
| 6/13 | Documentation: coresight: fix a documentation build warningDocumentation/ | +1 | 2 replies | |
| 7/13 | MAINTAINERS: fix wildcard for mfd da90* filesMAINTAINERS | +1 | 0 replies | |
| 8/13 | MAINTAINERS: fix a typo for hpe,gxp-spifi.yamlMAINTAINERS | +1 | 0 replies | |
| 9/13 | ABI: sysfs-bus-nvdimm: fix a doc build warningDocumentation/ | +2 | 0 replies | |
| 10/13 | docs: leds: add leds-qcom-lpg.rst to the index fileDocumentation/ drivers/ include/ | +3 | 1 reply | |
| 11/13 | fscache: fix kernel-doc markup on two functionsinclude/ | +2 | 0 replies | |
| 12/13 | serial: document start_rx member at struct uart_opsinclude/ | +8 | 1 reply | |
| 13/13 | fs/dcache: fix a kernel-doc markupinclude/ | +9 | 0 replies |
Reviews trailers per patch
5 of 13 patches have a Reviewed-by or Acked-by.
| Patch | Wu XiangCheng | Muchun Song | Bagas Sanjaya | Jiri Slaby | Yanteng Si | Suzuki K Poulose |
|---|---|---|---|---|---|---|
| 1/13 | ||||||
| 2/13 | A-b | R-b | ||||
| 3/13 | ||||||
| 4/13 | R-b | |||||
| 5/13 | R-b | |||||
| 6/13 | A-b | A-b | ||||
| 7/13 | ||||||
| 8/13 | ||||||
| 9/13 | ||||||
| 10/13 | ||||||
| 11/13 | ||||||
| 12/13 | R-b | |||||
| 13/13 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 6 reviewers.
Cover letter [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/[email protected]/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
Signature · 1 line
2.37.1