* [PATCH v2 00/33] Documentation fixes for Kernel 5.8
@ 2020-04-14 16:48 Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2020-04-14 16:48 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Rob Herring, Maxime Ripard, Linus Walleij, Sudeep Holla,
Kishon Vijay Abraham I, Yuti Amonkar, devicetree, linux-arch,
kvm, kvm-ppc, linuxppc-dev, dri-devel, linux-arm-kernel,
linux-fsdevel, linux-unionfs, linux-mm, linux-rdma, kvmarm,
linux-crypto, linux-media, linux-arm-msm, freedreno, linux-afs,
ecryptfs, linux-ntfs-dev, ocfs2-devel, linux-pci, linux-edac,
linux-spi, Sandeep Maheswaram, Stephen Boyd, Matthias Kaehlcke,
linux-usb, Geert Uytterhoeven, Matthias Brugger, netdev,
linux-i2c, linux-rockchip, linux-ide, linux1394-devel
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%)
--
2.25.2
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
2020-04-14 16:48 [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Mauro Carvalho Chehab
@ 2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 21:01 ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file Mauro Carvalho Chehab
2020-04-20 21:43 ` [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Jonathan Corbet
2 siblings, 1 reply; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2020-04-14 16:48 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Andy Gross,
Bjorn Andersson, Greg Kroah-Hartman, Rob Herring, Stephen Boyd,
Kishon Vijay Abraham I, Sandeep Maheswaram, Matthias Kaehlcke,
linux-arm-msm, linux-usb, devicetree
The qcom-qusb2-phy.txt file was converted and renamed to yaml.
Update cross-reference accordingly.
Fixes: 8ce65d8d38df ("dt-bindings: phy: qcom,qusb2: Convert QUSB2 phy bindings to yaml")
Reviewed-by: Stephen Boyd <swboyd@chromium.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/devicetree/bindings/usb/qcom,dwc3.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/devicetree/bindings/usb/qcom,dwc3.txt b/Documentation/devicetree/bindings/usb/qcom,dwc3.txt
index cb695aa3fba4..fbdd01756752 100644
--- a/Documentation/devicetree/bindings/usb/qcom,dwc3.txt
+++ b/Documentation/devicetree/bindings/usb/qcom,dwc3.txt
@@ -52,8 +52,8 @@ A child node must exist to represent the core DWC3 IP block. The name of
the node is not important. The content of the node is defined in dwc3.txt.
Phy documentation is provided in the following places:
-Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt - USB3 QMP PHY
-Documentation/devicetree/bindings/phy/qcom-qusb2-phy.txt - USB2 QUSB2 PHY
+Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt - USB3 QMP PHY
+Documentation/devicetree/bindings/phy/qcom,qusb2-phy.yaml - USB2 QUSB2 PHY
Example device nodes:
--
2.25.2
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file
2020-04-14 16:48 [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
@ 2020-04-14 16:48 ` Mauro Carvalho Chehab
2020-04-14 21:02 ` Rob Herring
2020-04-20 21:43 ` [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Jonathan Corbet
2 siblings, 1 reply; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2020-04-14 16:48 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Greg Kroah-Hartman, Rob Herring, Heiko Stuebner, linux-usb,
devicetree, linux-arm-kernel, linux-rockchip
phy-rockchip-inno-usb2.txt was converted to yaml.
Fix the corresponding reference.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/devicetree/bindings/usb/rockchip,dwc3.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt b/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt
index c8c4b00ecb94..94520493233b 100644
--- a/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt
+++ b/Documentation/devicetree/bindings/usb/rockchip,dwc3.txt
@@ -16,7 +16,7 @@ A child node must exist to represent the core DWC3 IP block. The name of
the node is not important. The content of the node is defined in dwc3.txt.
Phy documentation is provided in the following places:
-Documentation/devicetree/bindings/phy/phy-rockchip-inno-usb2.txt - USB2.0 PHY
+Documentation/devicetree/bindings/phy/phy-rockchip-inno-usb2.yaml - USB2.0 PHY
Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt - Type-C PHY
Example device nodes:
--
2.25.2
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
2020-04-14 16:48 ` [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
@ 2020-04-14 21:01 ` Rob Herring
0 siblings, 0 replies; 6+ messages in thread
From: Rob Herring @ 2020-04-14 21:01 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Andy Gross, Bjorn Andersson, Greg Kroah-Hartman,
Stephen Boyd, Kishon Vijay Abraham I, Sandeep Maheswaram,
Matthias Kaehlcke, linux-arm-msm, linux-usb, devicetree
On Tue, 14 Apr 2020 18:48:49 +0200, Mauro Carvalho Chehab wrote:
> The qcom-qusb2-phy.txt file was converted and renamed to yaml.
> Update cross-reference accordingly.
>
> Fixes: 8ce65d8d38df ("dt-bindings: phy: qcom,qusb2: Convert QUSB2 phy bindings to yaml")
> Reviewed-by: Stephen Boyd <swboyd@chromium.org>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> Documentation/devicetree/bindings/usb/qcom,dwc3.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
Applied, thanks.
Rob
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file
2020-04-14 16:48 ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file Mauro Carvalho Chehab
@ 2020-04-14 21:02 ` Rob Herring
0 siblings, 0 replies; 6+ messages in thread
From: Rob Herring @ 2020-04-14 21:02 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Greg Kroah-Hartman, Heiko Stuebner, linux-usb,
devicetree, linux-arm-kernel, linux-rockchip
On Tue, 14 Apr 2020 18:48:54 +0200, Mauro Carvalho Chehab wrote:
> phy-rockchip-inno-usb2.txt was converted to yaml.
>
> Fix the corresponding reference.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> Documentation/devicetree/bindings/usb/rockchip,dwc3.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
Applied, thanks.
Rob
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 00/33] Documentation fixes for Kernel 5.8
2020-04-14 16:48 [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file Mauro Carvalho Chehab
@ 2020-04-20 21:43 ` Jonathan Corbet
2 siblings, 0 replies; 6+ messages in thread
From: Jonathan Corbet @ 2020-04-20 21:43 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, linux-kernel, Rob Herring, Maxime Ripard,
Linus Walleij, Sudeep Holla, Kishon Vijay Abraham I,
Yuti Amonkar, devicetree, linux-arch, kvm, kvm-ppc, linuxppc-dev,
dri-devel, linux-arm-kernel, linux-fsdevel, linux-unionfs,
linux-mm, linux-rdma, kvmarm, linux-crypto, linux-media,
linux-arm-msm, freedreno, linux-afs, ecryptfs, linux-ntfs-dev,
ocfs2-devel, linux-pci, linux-edac, linux-spi,
Sandeep Maheswaram, Stephen Boyd, Matthias Kaehlcke, linux-usb,
Geert Uytterhoeven, Matthias Brugger, netdev, linux-i2c,
linux-rockchip, linux-ide, linux1394-devel
On Tue, 14 Apr 2020 18:48:26 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> 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).
OK, I've applied this set, minus #17 which was applied elsewhere.
Thanks,
jon
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2020-04-20 21:43 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-14 16:48 [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Mauro Carvalho Chehab
2020-04-14 16:48 ` [PATCH v2 23/33] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
2020-04-14 21:01 ` Rob Herring
2020-04-14 16:48 ` [PATCH v2 28/33] docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file Mauro Carvalho Chehab
2020-04-14 21:02 ` Rob Herring
2020-04-20 21:43 ` [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Jonathan Corbet
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).