From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5E481C2BB85 for ; Tue, 14 Apr 2020 16:55:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3C8492074D for ; Tue, 14 Apr 2020 16:55:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586883331; bh=hpU3ilpDhIBh1EkpHoT8CRglKxDNGuySrswIRHuRmXU=; h=From:To:Cc:Subject:Date:List-ID:From; b=nY9b/xnbOFkhcx4+tJgE8Vk1H/1yTFanhKlJnaDcEhW16iKpEkuvy8KWSMufZ3roA Y9eQmlwOOPW0MOSvKr643ir3yXc+euaTwCxDFElrZnyNd1p0s08p7At1RqGBEtCR+v HFXwc+7uI6y0aW51CJfeBHUIBwhac4O/rfLfFlbE= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2440303AbgDNQz2 (ORCPT ); Tue, 14 Apr 2020 12:55:28 -0400 Received: from mail.kernel.org ([198.145.29.99]:55194 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2440299AbgDNQtI (ORCPT ); Tue, 14 Apr 2020 12:49:08 -0400 Received: from mail.kernel.org (ip5f5ad4d8.dynamic.kabel-deutschland.de [95.90.212.216]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 64BDD20787; Tue, 14 Apr 2020 16:49:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586882942; bh=hpU3ilpDhIBh1EkpHoT8CRglKxDNGuySrswIRHuRmXU=; h=From:To:Cc:Subject:Date:From; b=qP/fh2JuBrTWMBDU0Po9QgHcYacrRlFhnHwEY8en7h953JH1K2J6xRWgtWi+ouXIY 3gGiDenojv2rrUzJ4Wxk3whARW64aaikv0MOeHbofi1sPuRVe5IZT8BpzPaRPNxcO+ 07Ps8XSWU9UmRtIfijlblMPlQG+5+iBYwuA7KjAY= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jOOk8-0068kv-FR; Tue, 14 Apr 2020 18:49:00 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Rob Herring , Maxime Ripard , Linus Walleij , Sudeep Holla , Kishon Vijay Abraham I , Yuti Amonkar , devicetree@vger.kernel.org, linux-arch@vger.kernel.org, kvm@vger.kernel.org, kvm-ppc@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, dri-devel@lists.freedesktop.org, linux-arm-kernel@lists.infradead.org, linux-fsdevel@vger.kernel.org, linux-unionfs@vger.kernel.org, linux-mm@kvack.org, linux-rdma@vger.kernel.org, kvmarm@lists.cs.columbia.edu, linux-crypto@vger.kernel.org, linux-media@vger.kernel.org, linux-arm-msm@vger.kernel.org, freedreno@lists.freedesktop.org, linux-afs@lists.infradead.org, ecryptfs@vger.kernel.org, linux-ntfs-dev@lists.sourceforge.net, ocfs2-devel@oss.oracle.com, linux-pci@vger.kernel.org, linux-edac@vger.kernel.org, linux-spi@vger.kernel.org, Sandeep Maheswaram , Stephen Boyd , Matthias Kaehlcke , linux-usb@vger.kernel.org, Geert Uytterhoeven , Matthias Brugger , netdev@vger.kernel.org, linux-i2c@vger.kernel.org, linux-rockchip@lists.infradead.org, linux-ide@vger.kernel.org, linux1394-devel@lists.sourceforge.net Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Date: Tue, 14 Apr 2020 18:48:26 +0200 Message-Id: X-Mailer: git-send-email 2.25.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-unionfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-unionfs@vger.kernel.org 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 From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Date: Tue, 14 Apr 2020 18:48:26 +0200 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: freedreno-bounces-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org Sender: "Freedreno" To: Linux Doc Mailing List Cc: kvm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-pci-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, Linus Walleij , dri-devel-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org, linux-unionfs-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-mm-Bw31MaZKKs3YtjvyW6yDsg@public.gmane.org, netdev-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-i2c-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux1394-devel-5NWGOfrQmneRv+LV9MX5uipxlwaOVQ5f@public.gmane.org, kvmarm-FPEHb7Xf0XXUo1n7N8X6UoWGPAHP3yOg@public.gmane.org, linux-arch-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, Rob Herring , Geert Uytterhoeven , Jonathan Corbet , Mauro Carvalho Chehab , Kishon Vijay Abraham I , linux-rockchip-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, Matthias Kaehlcke , Sandeep Maheswaram , linux-media-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-afs-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, ecryptfs-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, kvm-ppc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, Stephen Boyd , Maxime Ripard l List-Id: linux-arch.vger.kernel.org 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 From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Date: Tue, 14 Apr 2020 18:48:26 +0200 Subject: [Ocfs2-devel] [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Message-ID: List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: Linux Doc Mailing List Cc: kvm@vger.kernel.org, linux-pci@vger.kernel.org, dri-devel@lists.freedesktop.org, linux-unionfs@vger.kernel.org, linux-mm@kvack.org, netdev@vger.kernel.org, linux-i2c@vger.kernel.org, linux1394-devel@lists.sourceforge.net, kvmarm@lists.cs.columbia.edu, linux-arch@vger.kernel.org, Geert Uytterhoeven , Jonathan Corbet , Mauro Carvalho Chehab , Kishon Vijay Abraham I , linux-rockchip@lists.infradead.org, Matthias Kaehlcke , Sandeep Maheswaram , linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-afs@lists.infradead.org, linux-arm-msm@vger.kernel.org, ecryptfs@vger.kernel.org, kvm-ppc@vger.kernel.org, Stephen Boyd , Maxime Ripard , linux-arm-kernel@lists.infradead.org, linux-edac@vger.kernel.org, Matthias Brugger , Yuti Amonkar , linux-ide@vger.kernel.org, linux-ntfs-dev@lists.sourceforge.net, freedreno@lists.freedesktop.org, linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, linux-rdma@vger.kernel.org, linux-crypto@vger.kernel.org, Sudeep Holla , linux-fsdevel@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, ocfs2-devel@oss.oracle.com 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 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EDCB1C2BA19 for ; Tue, 14 Apr 2020 17:20:02 +0000 (UTC) Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 623BA20678 for ; Tue, 14 Apr 2020 17:20:02 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="qP/fh2Ju" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 623BA20678 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linuxppc-dev-bounces+linuxppc-dev=archiver.kernel.org@lists.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 491sgL4cq3zDr3L for ; Wed, 15 Apr 2020 03:19:58 +1000 (AEST) Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=kernel.org (client-ip=198.145.29.99; helo=mail.kernel.org; envelope-from=mchehab@kernel.org; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=pass (p=none dis=none) header.from=kernel.org Authentication-Results: lists.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=kernel.org header.i=@kernel.org header.a=rsa-sha256 header.s=default header.b=qP/fh2Ju; dkim-atps=neutral Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 491rzk0JZYzDqTn for ; Wed, 15 Apr 2020 02:49:06 +1000 (AEST) Received: from mail.kernel.org (ip5f5ad4d8.dynamic.kabel-deutschland.de [95.90.212.216]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 64BDD20787; Tue, 14 Apr 2020 16:49:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586882942; bh=hpU3ilpDhIBh1EkpHoT8CRglKxDNGuySrswIRHuRmXU=; h=From:To:Cc:Subject:Date:From; b=qP/fh2JuBrTWMBDU0Po9QgHcYacrRlFhnHwEY8en7h953JH1K2J6xRWgtWi+ouXIY 3gGiDenojv2rrUzJ4Wxk3whARW64aaikv0MOeHbofi1sPuRVe5IZT8BpzPaRPNxcO+ 07Ps8XSWU9UmRtIfijlblMPlQG+5+iBYwuA7KjAY= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jOOk8-0068kv-FR; Tue, 14 Apr 2020 18:49:00 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Date: Tue, 14 Apr 2020 18:48:26 +0200 Message-Id: X-Mailer: git-send-email 2.25.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: linuxppc-dev@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux on PowerPC Developers Mail List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kvm@vger.kernel.org, linux-pci@vger.kernel.org, Linus Walleij , dri-devel@lists.freedesktop.org, linux-unionfs@vger.kernel.org, linux-mm@kvack.org, netdev@vger.kernel.org, linux-i2c@vger.kernel.org, linux1394-devel@lists.sourceforge.net, kvmarm@lists.cs.columbia.edu, linux-arch@vger.kernel.org, Rob Herring , Geert Uytterhoeven , Jonathan Corbet , Mauro Carvalho Chehab , Kishon Vijay Abraham I , linux-rockchip@lists.infradead.org, Matthias Kaehlcke , Sandeep Maheswaram , linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-afs@lists.infradead.org, linux-arm-msm@vger.kernel.org, ecryptfs@vger.kernel.org, kvm-ppc@vger.kernel.org, Stephen Boyd , Maxime Ripard , linux-arm-kernel@lists.infradead.org, linux-edac@vger.kernel.org, Matthias Brugger , Yuti Amonkar , linux-ide@vger.kernel.org, linux-ntfs-dev@lists.sourceforge.net, freedreno@lists.freedesktop.org, linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, linux-rdma@vger.kernel.org, linux-crypto@vger.kernel.org, Sudeep Holla , linux-fsdevel@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, ocfs2-devel@oss.oracle.com Errors-To: linuxppc-dev-bounces+linuxppc-dev=archiver.kernel.org@lists.ozlabs.org Sender: "Linuxppc-dev" 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 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 24C00C2BA19 for ; Tue, 14 Apr 2020 16:50:05 +0000 (UTC) Received: from mm01.cs.columbia.edu (mm01.cs.columbia.edu [128.59.11.253]) by mail.kernel.org (Postfix) with ESMTP id D26F42074D for ; Tue, 14 Apr 2020 16:50:04 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="qP/fh2Ju" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org D26F42074D Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=kvmarm-bounces@lists.cs.columbia.edu Received: from localhost (localhost [127.0.0.1]) by mm01.cs.columbia.edu (Postfix) with ESMTP id 5A5584B207; Tue, 14 Apr 2020 12:50:04 -0400 (EDT) X-Virus-Scanned: at lists.cs.columbia.edu Authentication-Results: mm01.cs.columbia.edu (amavisd-new); dkim=softfail (fail, message has been altered) header.i=@kernel.org Received: from mm01.cs.columbia.edu ([127.0.0.1]) by localhost (mm01.cs.columbia.edu [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ROY0UT26Q3tI; Tue, 14 Apr 2020 12:49:59 -0400 (EDT) Received: from mm01.cs.columbia.edu (localhost [127.0.0.1]) by mm01.cs.columbia.edu (Postfix) with ESMTP id B40CD4B20C; Tue, 14 Apr 2020 12:49:55 -0400 (EDT) Received: from localhost (localhost [127.0.0.1]) by mm01.cs.columbia.edu (Postfix) with ESMTP id 681A34B1F7 for ; Tue, 14 Apr 2020 12:49:09 -0400 (EDT) X-Virus-Scanned: at lists.cs.columbia.edu Received: from mm01.cs.columbia.edu ([127.0.0.1]) by localhost (mm01.cs.columbia.edu [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id H61xWWfqjJyi for ; Tue, 14 Apr 2020 12:49:03 -0400 (EDT) Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by mm01.cs.columbia.edu (Postfix) with ESMTPS id BF79F4B1DC for ; Tue, 14 Apr 2020 12:49:03 -0400 (EDT) Received: from mail.kernel.org (ip5f5ad4d8.dynamic.kabel-deutschland.de [95.90.212.216]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 64BDD20787; Tue, 14 Apr 2020 16:49:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586882942; bh=hpU3ilpDhIBh1EkpHoT8CRglKxDNGuySrswIRHuRmXU=; h=From:To:Cc:Subject:Date:From; b=qP/fh2JuBrTWMBDU0Po9QgHcYacrRlFhnHwEY8en7h953JH1K2J6xRWgtWi+ouXIY 3gGiDenojv2rrUzJ4Wxk3whARW64aaikv0MOeHbofi1sPuRVe5IZT8BpzPaRPNxcO+ 07Ps8XSWU9UmRtIfijlblMPlQG+5+iBYwuA7KjAY= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jOOk8-0068kv-FR; Tue, 14 Apr 2020 18:49:00 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Date: Tue, 14 Apr 2020 18:48:26 +0200 Message-Id: X-Mailer: git-send-email 2.25.2 MIME-Version: 1.0 X-Mailman-Approved-At: Tue, 14 Apr 2020 12:49:54 -0400 Cc: kvm@vger.kernel.org, linux-pci@vger.kernel.org, Linus Walleij , dri-devel@lists.freedesktop.org, linux-unionfs@vger.kernel.org, linux-mm@kvack.org, netdev@vger.kernel.org, linux-i2c@vger.kernel.org, linux1394-devel@lists.sourceforge.net, kvmarm@lists.cs.columbia.edu, linux-arch@vger.kernel.org, Rob Herring , Geert Uytterhoeven , Jonathan Corbet , Mauro Carvalho Chehab , Kishon Vijay Abraham I , linux-rockchip@lists.infradead.org, Matthias Kaehlcke , Sandeep Maheswaram , linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-afs@lists.infradead.org, linux-arm-msm@vger.kernel.org, ecryptfs@vger.kernel.org, kvm-ppc@vger.kernel.org, Stephen Boyd , Maxime Ripard , linux-arm-kernel@lists.infradead.org, linux-edac@vger.kernel.org, Matthias Brugger , Yuti Amonkar , linux-ide@vger.kernel.org, linux-ntfs-dev@lists.sourceforge.net, freedreno@lists.freedesktop.org, linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, linux-rdma@vger.kernel.org, linux-crypto@vger.kernel.org, Sudeep Holla , linux-fsdevel@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, ocfs2-devel@oss.oracle.com X-BeenThere: kvmarm@lists.cs.columbia.edu X-Mailman-Version: 2.1.14 Precedence: list List-Id: Where KVM/ARM decisions are made List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: kvmarm-bounces@lists.cs.columbia.edu Sender: kvmarm-bounces@lists.cs.columbia.edu 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 _______________________________________________ kvmarm mailing list kvmarm@lists.cs.columbia.edu https://lists.cs.columbia.edu/mailman/listinfo/kvmarm From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8D044C2BA19 for ; Tue, 14 Apr 2020 16:49:11 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 42FBB206E9 for ; Tue, 14 Apr 2020 16:49:11 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="eDn1ECtp"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="qP/fh2Ju" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 42FBB206E9 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:To :From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=aAalkMKAP2Svj4BAzOMPjCR/7f8JvfKT6fpL7ymGND4=; b=eDn1ECtpD90TKU x4b/VSD1MUP/iYcdxhnrR+R1yLqhu1is3s2Y8+e/vYsJEt+eg2zHG43xzu1Uc/4753VmaNTLVj+Yb xa6DWNGd9Q3P6KevzJpoRmt5uwpwV3mI6uGaPWfiB5FWSnpSCgsLrC7JyxGHLVYjhX8kYRrgYkG1A UL6yLbPTFi7P6I60FP9MqxcVn0HUG0RjLAeAzPzQebjwSkJ5hwZaFUFD3A/LJnOvfWCA42mxcwFXP 6UMr9mrhzUTFw20XePtCFpO4y3tyoIbv2F1fw8My1bRGy7+NFqd0oa+Em1NgWsrZcijGNysI95JrO Vs/58lkUB1CCVokVJJ/w==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jOOkI-0007Ka-7Z; Tue, 14 Apr 2020 16:49:10 +0000 Received: from mail.kernel.org ([198.145.29.99]) by bombadil.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jOOkB-0007ID-Ct; Tue, 14 Apr 2020 16:49:08 +0000 Received: from mail.kernel.org (ip5f5ad4d8.dynamic.kabel-deutschland.de [95.90.212.216]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 64BDD20787; Tue, 14 Apr 2020 16:49:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586882942; bh=hpU3ilpDhIBh1EkpHoT8CRglKxDNGuySrswIRHuRmXU=; h=From:To:Cc:Subject:Date:From; b=qP/fh2JuBrTWMBDU0Po9QgHcYacrRlFhnHwEY8en7h953JH1K2J6xRWgtWi+ouXIY 3gGiDenojv2rrUzJ4Wxk3whARW64aaikv0MOeHbofi1sPuRVe5IZT8BpzPaRPNxcO+ 07Ps8XSWU9UmRtIfijlblMPlQG+5+iBYwuA7KjAY= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jOOk8-0068kv-FR; Tue, 14 Apr 2020 18:49:00 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Date: Tue, 14 Apr 2020 18:48:26 +0200 Message-Id: X-Mailer: git-send-email 2.25.2 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200414_094903_487191_62A0AB56 X-CRM114-Status: GOOD ( 14.04 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kvm@vger.kernel.org, linux-pci@vger.kernel.org, Linus Walleij , dri-devel@lists.freedesktop.org, linux-unionfs@vger.kernel.org, linux-mm@kvack.org, netdev@vger.kernel.org, linux-i2c@vger.kernel.org, linux1394-devel@lists.sourceforge.net, kvmarm@lists.cs.columbia.edu, linux-arch@vger.kernel.org, Rob Herring , Geert Uytterhoeven , Jonathan Corbet , Mauro Carvalho Chehab , Kishon Vijay Abraham I , linux-rockchip@lists.infradead.org, Matthias Kaehlcke , Sandeep Maheswaram , linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-afs@lists.infradead.org, linux-arm-msm@vger.kernel.org, ecryptfs@vger.kernel.org, kvm-ppc@vger.kernel.org, Stephen Boyd , Maxime Ripard , linux-arm-kernel@lists.infradead.org, linux-edac@vger.kernel.org, Matthias Brugger , Yuti Amonkar , linux-ide@vger.kernel.org, linux-ntfs-dev@lists.sourceforge.net, freedreno@lists.freedesktop.org, linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, linux-rdma@vger.kernel.org, linux-crypto@vger.kernel.org, Sudeep Holla , linux-fsdevel@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, ocfs2-devel@oss.oracle.com Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org 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 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C5C78C352BE for ; Tue, 14 Apr 2020 16:49:05 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 97FB622200 for ; Tue, 14 Apr 2020 16:49:05 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="qP/fh2Ju" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 97FB622200 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 4117B6E23B; Tue, 14 Apr 2020 16:49:04 +0000 (UTC) Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by gabe.freedesktop.org (Postfix) with ESMTPS id DDBBD896F7; Tue, 14 Apr 2020 16:49:02 +0000 (UTC) Received: from mail.kernel.org (ip5f5ad4d8.dynamic.kabel-deutschland.de [95.90.212.216]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 64BDD20787; Tue, 14 Apr 2020 16:49:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586882942; bh=hpU3ilpDhIBh1EkpHoT8CRglKxDNGuySrswIRHuRmXU=; h=From:To:Cc:Subject:Date:From; b=qP/fh2JuBrTWMBDU0Po9QgHcYacrRlFhnHwEY8en7h953JH1K2J6xRWgtWi+ouXIY 3gGiDenojv2rrUzJ4Wxk3whARW64aaikv0MOeHbofi1sPuRVe5IZT8BpzPaRPNxcO+ 07Ps8XSWU9UmRtIfijlblMPlQG+5+iBYwuA7KjAY= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jOOk8-0068kv-FR; Tue, 14 Apr 2020 18:49:00 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Date: Tue, 14 Apr 2020 18:48:26 +0200 Message-Id: X-Mailer: git-send-email 2.25.2 MIME-Version: 1.0 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kvm@vger.kernel.org, linux-pci@vger.kernel.org, dri-devel@lists.freedesktop.org, linux-unionfs@vger.kernel.org, linux-mm@kvack.org, netdev@vger.kernel.org, linux-i2c@vger.kernel.org, linux1394-devel@lists.sourceforge.net, kvmarm@lists.cs.columbia.edu, linux-arch@vger.kernel.org, Geert Uytterhoeven , Jonathan Corbet , Mauro Carvalho Chehab , Kishon Vijay Abraham I , linux-rockchip@lists.infradead.org, Matthias Kaehlcke , Sandeep Maheswaram , linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-afs@lists.infradead.org, linux-arm-msm@vger.kernel.org, ecryptfs@vger.kernel.org, kvm-ppc@vger.kernel.org, Stephen Boyd , Maxime Ripard , linux-arm-kernel@lists.infradead.org, linux-edac@vger.kernel.org, Matthias Brugger , Yuti Amonkar , linux-ide@vger.kernel.org, linux-ntfs-dev@lists.sourceforge.net, freedreno@lists.freedesktop.org, linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, linux-rdma@vger.kernel.org, linux-crypto@vger.kernel.org, Sudeep Holla , linux-fsdevel@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, ocfs2-devel@oss.oracle.com Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-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 _______________________________________________ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Date: Tue, 14 Apr 2020 18:48:26 +0200 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: freedreno-bounces-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org Sender: "Freedreno" To: Linux Doc Mailing List Cc: kvm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-pci-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, Linus Walleij , dri-devel-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org, linux-unionfs-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-mm-Bw31MaZKKs3YtjvyW6yDsg@public.gmane.org, netdev-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-i2c-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux1394-devel-5NWGOfrQmneRv+LV9MX5uipxlwaOVQ5f@public.gmane.org, kvmarm-FPEHb7Xf0XXUo1n7N8X6UoWGPAHP3yOg@public.gmane.org, linux-arch-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, Rob Herring , Geert Uytterhoeven , Jonathan Corbet , Mauro Carvalho Chehab , Kishon Vijay Abraham I , linux-rockchip-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, Matthias Kaehlcke , Sandeep Maheswaram , linux-media-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-afs-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, ecryptfs-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, kvm-ppc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, Stephen Boyd , Maxime Ripard , l 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 From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Date: Tue, 14 Apr 2020 16:48:26 +0000 Subject: [PATCH v2 00/33] Documentation fixes for Kernel 5.8 Message-Id: List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Rob Herring , Maxime Ripard , Linus Walleij , Sudeep Holla , Kishon Vijay Abraham I , Yuti Amonkar , devicetree@vger.kernel.org, linux-arch@vger.kernel.org, kvm@vger.kernel.org, kvm-ppc@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, dri-devel@lists.freedesktop.org, linux-arm-kernel@lists.infradead.org, linux-fsdevel@vger.kernel.org, linux-unionfs@vger.kernel.org, linux-mm@kvack.org, linux-rdma@vger.kernel.org, kvmarm@lists.cs.columbia.edu, linux-crypto@vger.kernel.org, linux-media@vger.kernel.org, linux-arm-msm@vger.kernel.org, freedreno@lists.freedesktop.org, linux-afs@lists.infradead.org, ecryptfs@vger.kernel.org, linux-ntfs-dev@lists.sourceforge.net, ocfs2-devel@oss.oracle.com, linux-pci@vger.kernel.org, linux-edac@vger.kernel.org, linux-spi@vger.kernel.org, Sandeep Maheswaram , Stephen Boyd , Matthias Kaehlcke , linux-usb@vger.kernel.org, Geert Uytterhoeven , Matthias Brugger , netdev@vger.kernel.org, linux-i2c@vger.kernel.org, linux-rockchip@lists.infradead.org, linux-ide@vger.kernel.org, linux1394-devel@lists.sourceforge.net 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