Documentation fixes for Kernel 5.8
Status from this message: Applied, thanks.
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
Changes in v2 from the cover letter
- patches re-ordered;
- added reviewed/acked-by tags;
- rebased on the top of docs-next + v5.7-rc1.
Patches in v2 Applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/33 | scripts: kernel-doc: proper handle @foo->bar()scripts/ | +2 | 0 replies | |
| 2/33 | scripts: kernel-doc: accept negation like !@varscripts/ | +3 | 0 replies | |
| 3/33 | scripts: kernel-doc: accept blank lines on parameter descriptionscripts/ | +23 | 0 replies | |
| 4/33 | docs: update recommended Sphinx version to 2.4.4Documentation/ | +1 | 2 replies | |
| 5/33 | docs: LaTeX/PDF: drop list of documentsDocumentation/ | +0 | 0 replies | |
| 6/33 | MAINTAINERS: dt: update display/allwinner file entryMAINTAINERS | +1 | 1 reply | |
| 7/33 | MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealViewMAINTAINERS | +4 | 0 replies | |
| 8/33 | docs: dt: fix broken reference to phy-cadence-torrent.yamlDocumentation/ | +1 | 1 reply | |
| 9/33 | docs: fix broken references to text filesDocumentation/ Documentation/ Documentation/ +20 more | +36 | 0 replies | |
| 10/33 | docs: fix broken references for ReST files that moved aroundDocumentation/ Documentation/ Documentation/ +8 more | +13 | 1 reply | |
| 11/33 | docs: filesystems: fix renamed referencesDocumentation/ Documentation/ Documentation/ +42 more | +52 | 0 replies | |
| 12/33 | docs: amu: supress some Sphinx warningsDocumentation/ | +5 | 0 replies | |
| 13/33 | docs: arm64: booting.rst: get rid of some warningsDocumentation/ | +22 | 0 replies | |
| 14/33 | docs: pci: boot-interrupts.rst: improve html outputDocumentation/ | +19 | 0 replies | |
| 15/33 | docs: ras: get rid of some warningsDocumentation/ | +9 | 0 replies | |
| 16/33 | docs: ras: don't need to repeat twice the same thingDocumentation/ | +1 | 0 replies | |
| 17/33 | docs: infiniband: verbs.c: fix some documentation warningsdrivers/ | +5 | 1 reply | |
| 18/33 | docs: spi: spi.h: fix a doc building warninginclude/ | +1 | 1 reply | |
| 19/33 | docs: drivers: fix some warnings at base/platform.c when building docsdrivers/ | +4 | 0 replies | |
| 20/33 | docs: mm: userfaultfd.rst: use ``foo`` for literalsDocumentation/ | +104 | 0 replies | |
| 21/33 | docs: mm: userfaultfd.rst: use a cross-reference for a sectionDocumentation/ | +1 | 0 replies | |
| 22/33 | docs: vm: index.rst: add an orphan doc to the building systemDocumentation/ | +1 | 0 replies | |
| 23/33 | docs: dt: qcom,dwc3.txt: fix cross-reference for a converted fileDocumentation/ | +2 | 1 reply | |
| 24/33 | docs: dt: fix a broken reference for a file converted to jsonDocumentation/ | +1 | 1 reply | |
| 25/33 | docs: powerpc: cxl.rst: mark two section titles as suchDocumentation/ | +2 | 1 reply | |
| 26/33 | docs: i2c: rename i2c.svg to i2c_bus.svgDocumentation/ Documentation/ | +2 | 0 replies | |
| 27/33 | docs: Makefile: place final pdf docs on a separate dirDocumentation/ | +5 | 0 replies | |
| 28/33 | docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed fileDocumentation/ | +1 | 1 reply | |
| 29/33 | ata: libata-core: fix a doc warningdrivers/ | +1 | 0 replies | |
| 30/33 | firewire: firewire-cdev.hL get rid of a docs warninginclude/ | +1 | 0 replies | |
| 31/33 | fs: inode.c: get rid of docs warningsfs/ | +3 | 0 replies | |
| 32/33 | futex: get rid of a kernel-docs build warningkernel/ | +3 | 0 replies | |
| 33/33 | lib: bitmap.c: get rid of some doc warningslib/ | +14 | 1 reply |
Reviews trailers per patch
9 of 33 patches have a Reviewed-by or Acked-by.
| Patch | Mathieu Poirier | Paul E. McKenney | Alex Shi | Federico Vaga | Marc Zyngier | David Sterba | Geert Uytterhoeven | Stephen Boyd | Wolfram Sang | Stefan Richter | Bjorn Helgaas | Andrew Donnellan | Corentin Labbe |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1/33 | |||||||||||||
| 2/33 | |||||||||||||
| 3/33 | |||||||||||||
| 4/33 | |||||||||||||
| 5/33 | |||||||||||||
| 6/33 | |||||||||||||
| 7/33 | |||||||||||||
| 8/33 | |||||||||||||
| 9/33 | R-b | R-b | A-b | A-b | A-b | ||||||||
| 10/33 | A-b | ||||||||||||
| 11/33 | A-b | ||||||||||||
| 12/33 | |||||||||||||
| 13/33 | |||||||||||||
| 14/33 | A-b | ||||||||||||
| 15/33 | |||||||||||||
| 16/33 | |||||||||||||
| 17/33 | |||||||||||||
| 18/33 | |||||||||||||
| 19/33 | |||||||||||||
| 20/33 | |||||||||||||
| 21/33 | |||||||||||||
| 22/33 | |||||||||||||
| 23/33 | R-b | ||||||||||||
| 24/33 | R-b | ||||||||||||
| 25/33 | A-b | ||||||||||||
| 26/33 | A-b | ||||||||||||
| 27/33 | |||||||||||||
| 28/33 | |||||||||||||
| 29/33 | |||||||||||||
| 30/33 | A-b | ||||||||||||
| 31/33 | |||||||||||||
| 32/33 | |||||||||||||
| 33/33 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 13 reviewers.
Cover letter [PATCH v2 00/33] Documentation fixes for Kernel 5.8
Patches 1 to 5 contain changes to the documentation toolset:
- The first 3 patches help to reduce a lot the number of reported kernel-doc issues, by making the tool more smart.
- Patches 4 and 5 are meant to partially address the PDF build, with now requires Sphinx version 2.4 or upper.
The remaining patches fix broken references detected by this tool:
./scripts/documentation-file-ref-check
and address other random errors due to tags being mis-interpreted or mis-used.
They are independent each other, but some may depend on the kernel-doc improvements.
PS.: Due to the large number of C/C, I opted to keep a smaller set of C/C at this first e-mail (only e-mails with "L:" tag from MAINTAINERS file).
Jon,
Those patches should apply cleanly at docs-next, once you pull from v5.7-rc1.
-
v2:
- patches re-ordered;
- added reviewed/acked-by tags;
- rebased on the top of docs-next + v5.7-rc1.
Mauro Carvalho Chehab (33):
scripts: kernel-doc: proper handle @foo->bar()
scripts: kernel-doc: accept negation like !@var
scripts: kernel-doc: accept blank lines on parameter description
docs: update recommended Sphinx version to 2.4.4
docs: LaTeX/PDF: drop list of documents
MAINTAINERS: dt: update display/allwinner file entry
MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and
RealView
docs: dt: fix broken reference to phy-cadence-torrent.yaml
docs: fix broken references to text files
docs: fix broken references for ReST files that moved around
docs: filesystems: fix renamed references
docs: amu: supress some Sphinx warnings
docs: arm64: booting.rst: get rid of some warnings
docs: pci: boot-interrupts.rst: improve html output
docs: ras: get rid of some warnings
docs: ras: don't need to repeat twice the same thing
docs: infiniband: verbs.c: fix some documentation warnings
docs: spi: spi.h: fix a doc building warning
docs: drivers: fix some warnings at base/platform.c when building docs
docs: mm: userfaultfd.rst: use ``foo`` for literals
docs: mm: userfaultfd.rst: use a cross-reference for a section
docs: vm: index.rst: add an orphan doc to the building system
docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
docs: dt: fix a broken reference for a file converted to json
docs: powerpc: cxl.rst: mark two section titles as such
docs: i2c: rename i2c.svg to i2c_bus.svg
docs: Makefile: place final pdf docs on a separate dir
docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file
ata: libata-core: fix a doc warning
firewire: firewire-cdev.hL get rid of a docs warning
fs: inode.c: get rid of docs warnings
futex: get rid of a kernel-docs build warning
lib: bitmap.c: get rid of some doc warnings
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-smaps_rollup | 2 +-
Documentation/Makefile | 6 +-
Documentation/PCI/boot-interrupts.rst | 34 +--
Documentation/admin-guide/cpu-load.rst | 2 +-
Documentation/admin-guide/mm/userfaultfd.rst | 209 +++++++++---------
Documentation/admin-guide/nfs/nfsroot.rst | 2 +-
Documentation/admin-guide/ras.rst | 18 +-
Documentation/arm64/amu.rst | 5 +
Documentation/arm64/booting.rst | 36 +--
Documentation/conf.py | 38 ----
.../bindings/net/qualcomm-bluetooth.txt | 2 +-
.../bindings/phy/ti,phy-j721e-wiz.yaml | 2 +-
.../devicetree/bindings/usb/qcom,dwc3.txt | 4 +-
.../devicetree/bindings/usb/rockchip,dwc3.txt | 2 +-
.../doc-guide/maintainer-profile.rst | 2 +-
.../driver-api/driver-model/device.rst | 4 +-
.../driver-api/driver-model/overview.rst | 2 +-
Documentation/filesystems/dax.txt | 2 +-
Documentation/filesystems/dnotify.txt | 2 +-
.../filesystems/ramfs-rootfs-initramfs.rst | 2 +-
Documentation/filesystems/sysfs.rst | 2 +-
Documentation/i2c/{i2c.svg => i2c_bus.svg} | 2 +-
Documentation/i2c/summary.rst | 2 +-
Documentation/memory-barriers.txt | 2 +-
Documentation/powerpc/cxl.rst | 2 +
.../powerpc/firmware-assisted-dump.rst | 2 +-
Documentation/process/adding-syscalls.rst | 2 +-
Documentation/process/submit-checklist.rst | 2 +-
Documentation/sphinx/requirements.txt | 2 +-
.../it_IT/process/adding-syscalls.rst | 2 +-
.../it_IT/process/submit-checklist.rst | 2 +-
.../translations/ko_KR/memory-barriers.txt | 2 +-
.../translations/zh_CN/filesystems/sysfs.txt | 8 +-
.../zh_CN/process/submit-checklist.rst | 2 +-
Documentation/virt/kvm/arm/pvtime.rst | 2 +-
Documentation/virt/kvm/devices/vcpu.rst | 2 +-
Documentation/virt/kvm/hypercalls.rst | 4 +-
Documentation/virt/kvm/mmu.rst | 2 +-
Documentation/virt/kvm/review-checklist.rst | 2 +-
Documentation/vm/index.rst | 1 +
MAINTAINERS | 7 +-
arch/powerpc/include/uapi/asm/kvm_para.h | 2 +-
arch/x86/kvm/mmu/mmu.c | 2 +-
drivers/ata/libata-core.c | 2 +-
drivers/base/core.c | 2 +-
drivers/base/platform.c | 6 +-
.../allwinner/sun8i-ce/sun8i-ce-cipher.c | 2 +-
.../crypto/allwinner/sun8i-ce/sun8i-ce-core.c | 2 +-
.../allwinner/sun8i-ss/sun8i-ss-cipher.c | 2 +-
.../crypto/allwinner/sun8i-ss/sun8i-ss-core.c | 2 +-
drivers/gpu/drm/Kconfig | 2 +-
drivers/gpu/drm/drm_ioctl.c | 2 +-
drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h | 2 +-
drivers/hwtracing/coresight/Kconfig | 2 +-
drivers/infiniband/core/verbs.c | 7 +-
drivers/media/v4l2-core/v4l2-fwnode.c | 2 +-
fs/Kconfig | 2 +-
fs/Kconfig.binfmt | 2 +-
fs/adfs/Kconfig | 2 +-
fs/affs/Kconfig | 2 +-
fs/afs/Kconfig | 6 +-
fs/bfs/Kconfig | 2 +-
fs/cramfs/Kconfig | 2 +-
fs/ecryptfs/Kconfig | 2 +-
fs/fat/Kconfig | 8 +-
fs/fuse/Kconfig | 2 +-
fs/fuse/dev.c | 2 +-
fs/hfs/Kconfig | 2 +-
fs/hpfs/Kconfig | 2 +-
fs/inode.c | 6 +-
fs/isofs/Kconfig | 2 +-
fs/namespace.c | 2 +-
fs/notify/inotify/Kconfig | 2 +-
fs/ntfs/Kconfig | 2 +-
fs/ocfs2/Kconfig | 2 +-
fs/overlayfs/Kconfig | 6 +-
fs/proc/Kconfig | 4 +-
fs/romfs/Kconfig | 2 +-
fs/sysfs/dir.c | 2 +-
fs/sysfs/file.c | 2 +-
fs/sysfs/mount.c | 2 +-
fs/sysfs/symlink.c | 2 +-
fs/sysv/Kconfig | 2 +-
fs/udf/Kconfig | 2 +-
include/linux/kobject.h | 2 +-
include/linux/kobject_ns.h | 2 +-
include/linux/mm.h | 4 +-
include/linux/relay.h | 2 +-
include/linux/spi/spi.h | 1 +
include/linux/sysfs.h | 2 +-
include/uapi/linux/ethtool_netlink.h | 2 +-
include/uapi/linux/firewire-cdev.h | 2 +-
include/uapi/linux/kvm.h | 4 +-
include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +-
kernel/futex.c | 3 +
kernel/relay.c | 2 +-
lib/bitmap.c | 27 +--
lib/kobject.c | 4 +-
mm/gup.c | 12 +-
scripts/kernel-doc | 41 ++--
tools/include/uapi/linux/kvm.h | 4 +-
virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +-
virt/kvm/arm/vgic/vgic.h | 4 +-
104 files changed, 343 insertions(+), 326 deletions(-)
rename Documentation/i2c/{i2c.svg => i2c_bus.svg} (99%)Signature · 1 line
2.25.2