Skip to content

Documentation fixes for Kernel 5.8

Mauro Carvalho Chehab dri-devel ecryptfs kvm kvm-ppc kvmarm linux-arch linux-arm-kernel linux-arm-msm linux-crypto linux-devicetree linux-doc linux-edac linux-fsdevel linux-i2c linux-ide linux-media linux-mm linux-pci linux-rdma linux-rockchip linux-spi linux-unionfs linux-usb linuxppc-dev lkml netdev ocfs2-devel 2 versions – Applied

Status from this message: Applied, thanks.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest33 patches 13 repliesApplied
  2. v135 patches 19 repliesApplied 1/35

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 filesSizeRepliesApplied
1/33scripts: kernel-doc: proper handle @foo->bar()scripts/kernel-doc+2 -00 replies
2/33scripts: kernel-doc: accept negation like !@varscripts/kernel-doc+3 -10 replies
3/33scripts: kernel-doc: accept blank lines on parameter descriptionscripts/kernel-doc+23 -120 replies
4/33docs: update recommended Sphinx version to 2.4.4Documentation/sphinx/requirements.txt+1 -12 replies
5/33docs: LaTeX/PDF: drop list of documentsDocumentation/conf.py+0 -380 replies
6/33MAINTAINERS: dt: update display/allwinner file entryMAINTAINERS+1 -11 reply
7/33MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealViewMAINTAINERS+4 -10 replies
8/33docs: dt: fix broken reference to phy-cadence-torrent.yamlDocumentation/devicetree/bindings/phy/ti,phy-j721e-wiz.yaml+1 -11 reply
9/33docs: fix broken references to text filesDocumentation/memory-barriers.txt Documentation/process/submit-checklist.rst Documentation/translations/it_IT/process/submit-checklist.rst +20 more+36 -360 replies
10/33docs: fix broken references for ReST files that moved aroundDocumentation/doc-guide/maintainer-profile.rst Documentation/virt/kvm/mmu.rst Documentation/virt/kvm/review-checklist.rst +8 more+13 -131 reply
11/33docs: filesystems: fix renamed referencesDocumentation/ABI/stable/sysfs-devices-node Documentation/ABI/testing/procfs-smaps_rollup Documentation/admin-guide/cpu-load.rst +42 more+52 -520 replies
12/33docs: amu: supress some Sphinx warningsDocumentation/arm64/amu.rst+5 -00 replies
13/33docs: arm64: booting.rst: get rid of some warningsDocumentation/arm64/booting.rst+22 -140 replies
14/33docs: pci: boot-interrupts.rst: improve html outputDocumentation/PCI/boot-interrupts.rst+19 -150 replies
15/33docs: ras: get rid of some warningsDocumentation/admin-guide/ras.rst+9 -70 replies
16/33docs: ras: don't need to repeat twice the same thingDocumentation/admin-guide/ras.rst+1 -10 replies
17/33docs: infiniband: verbs.c: fix some documentation warningsdrivers/infiniband/core/verbs.c+5 -21 reply
18/33docs: spi: spi.h: fix a doc building warninginclude/linux/spi/spi.h+1 -01 reply
19/33docs: drivers: fix some warnings at base/platform.c when building docsdrivers/base/platform.c+4 -20 replies
20/33docs: mm: userfaultfd.rst: use ``foo`` for literalsDocumentation/admin-guide/mm/userfaultfd.rst+104 -1030 replies
21/33docs: mm: userfaultfd.rst: use a cross-reference for a sectionDocumentation/admin-guide/mm/userfaultfd.rst+1 -10 replies
22/33docs: vm: index.rst: add an orphan doc to the building systemDocumentation/vm/index.rst+1 -00 replies
23/33docs: dt: qcom,dwc3.txt: fix cross-reference for a converted fileDocumentation/devicetree/bindings/usb/qcom,dwc3.txt+2 -21 reply
24/33docs: dt: fix a broken reference for a file converted to jsonDocumentation/devicetree/bindings/net/qualcomm-bluetooth.txt+1 -11 reply
25/33docs: powerpc: cxl.rst: mark two section titles as suchDocumentation/powerpc/cxl.rst+2 -01 reply
26/33docs: i2c: rename i2c.svg to i2c_bus.svgDocumentation/i2c/i2c_bus.svg Documentation/i2c/summary.rst+2 -20 replies
27/33docs: Makefile: place final pdf docs on a separate dirDocumentation/Makefile+5 -10 replies
28/33docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed fileDocumentation/devicetree/bindings/usb/rockchip,dwc3.txt+1 -11 reply
29/33ata: libata-core: fix a doc warningdrivers/ata/libata-core.c+1 -10 replies
30/33firewire: firewire-cdev.hL get rid of a docs warninginclude/uapi/linux/firewire-cdev.h+1 -10 replies
31/33fs: inode.c: get rid of docs warningsfs/inode.c+3 -30 replies
32/33futex: get rid of a kernel-docs build warningkernel/futex.c+3 -00 replies
33/33lib: bitmap.c: get rid of some doc warningslib/bitmap.c+14 -131 reply

Reviews trailers per patch

9 of 33 patches have a Reviewed-by or Acked-by.

PatchMathieu PoirierPaul E. McKenneyAlex ShiFederico VagaMarc ZyngierDavid SterbaGeert UytterhoevenStephen BoydWolfram SangStefan RichterBjorn HelgaasAndrew DonnellanCorentin Labbe
1/33
2/33
3/33
4/33
5/33
6/33
7/33
8/33
9/33R-b R-b A-b A-b A-b
10/33A-b
11/33A-b
12/33
13/33
14/33A-b
15/33
16/33
17/33
18/33
19/33
20/33
21/33
22/33
23/33R-b
24/33R-b
25/33A-b
26/33A-b
27/33
28/33
29/33
30/33A-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.

Read the v2 thread

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