Documentation fixes for Kernel 5.8
Subsystems (68)
cover Documentation fixes for Kernel 5.8
Hi Jon,
I have a large list of patches this time for the Documentation/. So, I'm starting sending them a little earier. Yet, those are meant to be applied after the end of the merge window. They're based on today's linux-next, with has only 49 patches pending to be applied upstream touching Documentation/, so I don't expect much conflicts if applied early at -rc cycle.
Most of the patches here were already submitted, but weren't merged yet at next. So, it seems that nobody picked them yet.
In any case, most of those patches here are independent from the others.
The number of doc build warnings have been rising with time. The main goal with this series is to get rid of most Sphinx warnings and other errors.
Patches 1 to 5: fix broken references detected by this tool:
./scripts/documentation-file-ref-check
The other patches fix other random errors due to tags being mis-interpreted or mis-used.
You should notice that several patches touch kernel-doc scripts. IMHO, some of the warnings are actually due to kernel-doc being too pedantic. So, I ended by improving some things at the toolset, in order to make it smarter. That's the case of those patches:
docs: scripts/kernel-doc: accept blank lines on parameter description
scripts: kernel-doc: accept negation like !@var
scripts: kernel-doc: proper handle @foo->bar()
The last 4 patches address problems with PDF building.
The first one address a conflict that will rise during the merge
window: Documentation/media will be removed. Instead of just drop it from the list of PDF documents, I opted to drop the entire list, as conf.py will auto-generate from the sources:
docs: LaTeX/PDF: drop list of documents
Also, right now, PDF output is broken due to a namespace conflict at I2c (two pdf outputs there will have the same name).
docs: i2c: rename i2c.svg to i2c_bus.svg
The third PDF patch is not really a fix, but it helps a lot to identify if the build succeeded or not, by placing the final PDF output on a separate dir:
docs: Makefile: place final pdf docs on a separate dir
Finally, the last one solves a bug since the first supported Sphinx version, with also impacts PDF output: basically while nested tables are valid with ReST notation, the toolset only started supporting it on PDF output since version 2.4:
docs: update recommended Sphinx version to 2.4.4
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).
Mauro Carvalho Chehab (35):
MAINTAINERS: dt: update display/allwinner file entry
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
futex: get rid of a kernel-docs build warning
firewire: firewire-cdev.hL get rid of a docs warning
scripts: kernel-doc: proper handle @foo->bar()
lib: bitmap.c: get rid of some doc warnings
ata: libata-core: fix a doc warning
fs: inode.c: get rid of docs warnings
docs: ras: get rid of some warnings
docs: ras: don't need to repeat twice the same thing
docs: watch_queue.rst: supress some Sphinx warnings
scripts: kernel-doc: accept negation like !@var
docs: infiniband: verbs.c: fix some documentation warnings
docs: scripts/kernel-doc: accept blank lines on parameter description
docs: spi: spi.h: fix a doc building warning
docs: drivers: fix some warnings at base/platform.c when building docs
docs: fusion: mptbase.c: get rid of a doc build warning
docs: mm: slab.h: fix a broken cross-reference
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
MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and
RealView
docs: dt: fix a broken reference for a file converted to json
powerpc: docs: cxl.rst: mark two section titles as such
docs: LaTeX/PDF: drop list of documents
docs: i2c: rename i2c.svg to i2c_bus.svg
docs: Makefile: place final pdf docs on a separate dir
docs: update recommended Sphinx version to 2.4.4
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 +-
.../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 +
Documentation/watch_queue.rst | 34 ++-
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 +-
drivers/message/fusion/mptbase.c | 8 +-
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/slab.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 +-
106 files changed, 373 insertions(+), 338 deletions(-)
rename Documentation/i2c/{i2c.svg => i2c_bus.svg} (99%)Signature · 1 line
2.25.2
PATCH 3/35 docs: fix broken references to text files
Several references got broken due to txt to ReST conversion.
Several of them can be automatically fixed with:
scripts/documentation-file-ref-check --fix
--- Documentation/memory-barriers.txt | 2 +- Documentation/process/submit-checklist.rst | 2 +- .../translations/it_IT/process/submit-checklist.rst | 2 +- Documentation/translations/ko_KR/memory-barriers.txt | 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/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 ++-- arch/powerpc/include/uapi/asm/kvm_para.h | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/gpu/drm/drm_ioctl.c | 2 +- drivers/hwtracing/coresight/Kconfig | 2 +- fs/fat/Kconfig | 8 ++++---- fs/fuse/Kconfig | 2 +- fs/fuse/dev.c | 2 +- fs/overlayfs/Kconfig | 6 +++--- include/linux/mm.h | 4 ++-- include/uapi/linux/ethtool_netlink.h | 2 +- include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +- mm/gup.c | 12 ++++++------ virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +- virt/kvm/arm/vgic/vgic.h | 4 ++-- 23 files changed, 36 insertions(+), 36 deletions(-)
Documentation/memory-barriers.txt +1 -1
@@ -620,7 +620,7 @@ because the CPUs that the Linux kernel supports don't do writes until they are certain (1) that the write will actually happen, (2) of the location of the write, and (3) of the value to be written. But please carefully read the "CONTROL DEPENDENCIES" section and the -Documentation/RCU/rcu_dereference.txt file: The compiler can and does +Documentation/RCU/rcu_dereference.rst file: The compiler can and does break dependencies in a great many highly creative ways. CPU 1 CPU 2
Documentation/process/submit-checklist.rst +1 -1
@@ -107,7 +107,7 @@ and elsewhere regarding submitting Linux kernel patches. and why. 26) If any ioctl's are added by the patch, then also update - ``Documentation/ioctl/ioctl-number.rst``. + ``Documentation/userspace-api/ioctl/ioctl-number.rst``. 27) If your modified source code depends on or uses any of the kernel APIs or features that are related to the following ``Kconfig`` symbols,
Documentation/translations/it_IT/process/submit-checklist.rst +1 -1
@@ -117,7 +117,7 @@ sottomissione delle patch, in particolare sorgenti che ne spieghi la logica: cosa fanno e perché. 25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate - ``Documentation/ioctl/ioctl-number.rst``. + ``Documentation/userspace-api/ioctl/ioctl-number.rst``. 26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o funzionalità del kernel che è associata a uno dei seguenti simboli
Documentation/translations/ko_KR/memory-barriers.txt +1 -1
@@ -641,7 +641,7 @@ P 는 짝수 번호 캐시 라인에 저장되어 있고, 변수 B 는 홀수 리눅스 커널이 지원하는 CPU 들은 (1) 쓰기가 정말로 일어날지, (2) 쓰기가 어디에 이루어질지, 그리고 (3) 쓰여질 값을 확실히 알기 전까지는 쓰기를 수행하지 않기 때문입니다. 하지만 "컨트롤 의존성" 섹션과 -Documentation/RCU/rcu_dereference.txt 파일을 주의 깊게 읽어 주시기 바랍니다: +Documentation/RCU/rcu_dereference.rst 파일을 주의 깊게 읽어 주시기 바랍니다: 컴파일러는 매우 창의적인 많은 방법으로 종속성을 깰 수 있습니다. CPU 1 CPU 2
Documentation/translations/zh_CN/filesystems/sysfs.txt +1 -1
@@ -281,7 +281,7 @@ drivers/ 包含了每个已为特定总线上的设备而挂载的驱动程序 假定驱动没有跨越多个总线类型)。 fs/ 包含了一个为文件系统设立的目录。现在每个想要导出属性的文件系统必须 -在 fs/ 下创建自己的层次结构(参见Documentation/filesystems/fuse.txt)。 +在 fs/ 下创建自己的层次结构(参见Documentation/filesystems/fuse.rst)。 dev/ 包含两个子目录: char/ 和 block/。在这两个子目录中,有以 <major>:<minor> 格式命名的符号链接。这些符号链接指向 sysfs 目录
Documentation/translations/zh_CN/process/submit-checklist.rst +1 -1
@@ -97,7 +97,7 @@ Linux内核补丁提交清单 24) 所有内存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要源代码中的注 释来解释它们正在执行的操作及其原因的逻辑。 -25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/ioctl/ioctl-number.rst`` +25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/userspace-api/ioctl/ioctl-number.rst`` 26) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或 功能,则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` (如果该选项可用)的情况
Documentation/virt/kvm/arm/pvtime.rst +1 -1
@@ -76,5 +76,5 @@ It is advisable that one or more 64k pages are set aside for the purpose of these structures and not used for other purposes, this enables the guest to map the region using 64k pages and avoids conflicting attributes with other memory. -For the user space interface see Documentation/virt/kvm/devices/vcpu.txt +For the user space interface see Documentation/virt/kvm/devices/vcpu.rst section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL".
Documentation/virt/kvm/devices/vcpu.rst +1 -1
@@ -110,5 +110,5 @@ Returns: Specifies the base address of the stolen time structure for this VCPU. The base address must be 64 byte aligned and exist within a valid guest memory -region. See Documentation/virt/kvm/arm/pvtime.txt for more information +region. See Documentation/virt/kvm/arm/pvtime.rst for more information including the layout of the stolen time structure.
Documentation/virt/kvm/hypercalls.rst +2 -2
@@ -22,7 +22,7 @@ S390: number in R1. For further information on the S390 diagnose call as supported by KVM, - refer to Documentation/virt/kvm/s390-diag.txt. + refer to Documentation/virt/kvm/s390-diag.rst. PowerPC: It uses R3-R10 and hypercall number in R11. R4-R11 are used as output registers.
@@ -30,7 +30,7 @@ PowerPC: KVM hypercalls uses 4 byte opcode, that are patched with 'hypercall-instructions' property inside the device tree's /hypervisor node. - For more information refer to Documentation/virt/kvm/ppc-pv.txt + For more information refer to Documentation/virt/kvm/ppc-pv.rst MIPS: KVM hypercalls use the HYPCALL instruction with code 0 and the hypercall
arch/powerpc/include/uapi/asm/kvm_para.h +1 -1
@@ -31,7 +31,7 @@* Struct fields are always 32 or 64 bit aligned, depending on them being 32 * or 64 bit wide respectively. * -* See Documentation/virt/kvm/ppc-pv.txt +* See Documentation/virt/kvm/ppc-pv.rst */ struct kvm_vcpu_arch_shared {__u64 scratch1;
drivers/gpu/drm/Kconfig +1 -1
@@ -161,7 +161,7 @@ config DRM_LOAD_EDID_FIRMWARE monitor are unable to provide appropriate EDID data. Since this feature is provided as a workaround for broken hardware, the default case is N. Details and instructions how to build your own - EDID data are given in Documentation/driver-api/edid.rst. + EDID data are given in Documentation/admin-guide/edid.rst. config DRM_DP_CEC bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support"
drivers/gpu/drm/drm_ioctl.c +1 -1
@@ -741,7 +741,7 @@ static const struct drm_ioctl_desc drm_ioctls[] = {* }; * * Please make sure that you follow all the best practices from -* ``Documentation/ioctl/botching-up-ioctls.rst``. Note that drm_ioctl() +* ``Documentation/process/botching-up-ioctls.rst``. Note that drm_ioctl() * automatically zero-extends structures, hence make sure you can add more stuff * at the end, i.e. don't put a variable sized array there. *
drivers/hwtracing/coresight/Kconfig +1 -1
@@ -107,7 +107,7 @@ config CORESIGHT_CPU_DEBUG can quickly get to know program counter (PC), secure state, exception level, etc. Before use debugging functionality, platform needs to ensure the clock domain and power domain are enabled - properly, please refer Documentation/trace/coresight-cpu-debug.rst + properly, please refer Documentation/trace/coresight/coresight-cpu-debug.rst for detailed description and the example for usage. config CORESIGHT_CTI
fs/fat/Kconfig +4 -4
@@ -69,7 +69,7 @@ config VFAT_FS The VFAT support enlarges your kernel by about 10 KB and it only works if you said Y to the "DOS FAT fs support" above. Please read - the file <file:Documentation/filesystems/vfat.txt> for details. If + the file <file:Documentation/filesystems/vfat.rst> for details. If unsure, say Y. To compile this as a module, choose M here: the module will be called
@@ -82,7 +82,7 @@ config FAT_DEFAULT_CODEPAGE help This option should be set to the codepage of your FAT filesystems. It can be overridden with the "codepage" mount option. - See <file:Documentation/filesystems/vfat.txt> for more information. + See <file:Documentation/filesystems/vfat.rst> for more information. config FAT_DEFAULT_IOCHARSET string "Default iocharset for FAT"
@@ -96,7 +96,7 @@ config FAT_DEFAULT_IOCHARSET Note that "utf8" is not recommended for FAT filesystems. If unsure, you shouldn't set "utf8" here - select the next option instead if you would like to use UTF-8 encoded file names by default. - See <file:Documentation/filesystems/vfat.txt> for more information. + See <file:Documentation/filesystems/vfat.rst> for more information. Enable any character sets you need in File Systems/Native Language Support.
@@ -114,4 +114,4 @@ config FAT_DEFAULT_UTF8 Say Y if you use UTF-8 encoding for file names, N otherwise. - See <file:Documentation/filesystems/vfat.txt> for more information. + See <file:Documentation/filesystems/vfat.rst> for more information.
fs/fuse/Kconfig +1 -1
@@ -12,7 +12,7 @@ config FUSE_FS although chances are your distribution already has that library installed if you've installed the "fuse" package itself. - See <file:Documentation/filesystems/fuse.txt> for more information. + See <file:Documentation/filesystems/fuse.rst> for more information. See <file:Documentation/Changes> for needed library/utility version. If you want to develop a userspace FS, or if you want to use
fs/fuse/dev.c +1 -1
@@ -2081,7 +2081,7 @@ static void end_polls(struct fuse_conn *fc)* The same effect is usually achievable through killing the filesystem daemon * and all users of the filesystem. The exception is the combination of an * asynchronous request and the tricky deadlock (see -* Documentation/filesystems/fuse.txt). +* Documentation/filesystems/fuse.rst). * * Aborting requests under I/O goes as follows: 1: Separate out unlocked * requests, they should be finished off immediately. Locked requests will be
fs/overlayfs/Kconfig +3 -3
@@ -9,7 +9,7 @@ config OVERLAY_FS 'lower' filesystem is either hidden or, in the case of directories, merged with the 'upper' object. - For more information see Documentation/filesystems/overlayfs.txt + For more information see Documentation/filesystems/overlayfs.rst config OVERLAY_FS_REDIRECT_DIR bool "Overlayfs: turn on redirect directory feature by default"
@@ -38,7 +38,7 @@ config OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW If backward compatibility is not an issue, then it is safe and recommended to say N here. - For more information, see Documentation/filesystems/overlayfs.txt + For more information, see Documentation/filesystems/overlayfs.rst If unsure, say Y.
@@ -103,7 +103,7 @@ config OVERLAY_FS_XINO_AUTO If compatibility with applications that expect 32bit inodes is not an issue, then it is safe and recommended to say Y here. - For more information, see Documentation/filesystems/overlayfs.txt + For more information, see Documentation/filesystems/overlayfs.rst If unsure, say N.
include/linux/mm.h +2 -2
@@ -1220,7 +1220,7 @@ void unpin_user_pages(struct page **pages, unsigned long npages);* used to track the pincount (instead using of the GUP_PIN_COUNTING_BIAS * scheme). * -* For more information, please see Documentation/vm/pin_user_pages.rst. +* For more information, please see Documentation/core-api/pin_user_pages.rst. * * @page: pointer to page to be queried. * @Return: True, if it is likely that the page has been "dma-pinned".
@@ -2836,7 +2836,7 @@ struct page *follow_page(struct vm_area_struct *vma, unsigned long address,* releasing pages: get_user_pages*() pages must be released via put_page(), * while pin_user_pages*() pages must be released via unpin_user_page(). * -* Please see Documentation/vm/pin_user_pages.rst for more information. +* Please see Documentation/core-api/pin_user_pages.rst for more information. */ static inline int vm_fault_to_errno (vm_fault_t vm_fault,int foll_flags)
include/uapi/linux/ethtool_netlink.h +1 -1
@@ -2,7 +2,7 @@/* * include/uapi/linux/ethtool_netlink.h - netlink interface for ethtool * -* See Documentation/networking/ethtool-netlink.txt in kernel source tree for +* See Documentation/networking/ethtool-netlink.rst in kernel source tree for * doucumentation of the interface. */
include/uapi/rdma/rdma_user_ioctl_cmds.h +1 -1
@@ -36,7 +36,7 @@#include <linux/types.h> #include <linux/ioctl.h> -/* Documentation/ioctl/ioctl-number.rst */ +/* Documentation/userspace-api/ioctl/ioctl-number.rst */ #define RDMA_IOCTL_MAGIC 0x1b#define RDMA_VERBS_IOCTL \ _IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
mm/gup.c +6 -6
@@ -2840,9 +2840,9 @@ EXPORT_SYMBOL_GPL(get_user_pages_fast);* the arguments here are identical. * * FOLL_PIN means that the pages must be released via unpin_user_page(). Please -* see Documentation/vm/pin_user_pages.rst for further details. +* see Documentation/core-api/pin_user_pages.rst for further details. * -* This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It +* This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It * is NOT intended for Case 2 (RDMA: long-term pins). */ int pin_user_pages_fast(unsigned long start, int nr_pages,
@@ -2880,9 +2880,9 @@ EXPORT_SYMBOL_GPL(pin_user_pages_fast);* the arguments here are identical. * * FOLL_PIN means that the pages must be released via unpin_user_page(). Please -* see Documentation/vm/pin_user_pages.rst for details. +* see Documentation/core-api/pin_user_pages.rst for details. * -* This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It +* This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It * is NOT intended for Case 2 (RDMA: long-term pins). */ long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
@@ -2916,9 +2916,9 @@ EXPORT_SYMBOL(pin_user_pages_remote);* FOLL_PIN is set. * * FOLL_PIN means that the pages must be released via unpin_user_page(). Please -* see Documentation/vm/pin_user_pages.rst for details. +* see Documentation/core-api/pin_user_pages.rst for details. * -* This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It +* This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It * is NOT intended for Case 2 (RDMA: long-term pins). */ long pin_user_pages(unsigned long start, unsigned long nr_pages,
virt/kvm/arm/vgic/vgic-mmio-v3.c +1 -1
@@ -301,7 +301,7 @@ static unsigned long vgic_v3_uaccess_read_pending(struct kvm_vcpu *vcpu,* pending state of interrupt is latched in pending_latch variable. * Userspace will save and restore pending state and line_level * separately. -* Refer to Documentation/virt/kvm/devices/arm-vgic-v3.txt +* Refer to Documentation/virt/kvm/devices/arm-vgic-v3.rst * for handling of ISPENDR and ICPENDR. */ for (i =0 ; i < len *8 ; i++) {
virt/kvm/arm/vgic/vgic.h +2 -2
@@ -42,7 +42,7 @@ VGIC_AFFINITY_LEVEL(val, 3))/* -* As per Documentation/virt/kvm/devices/arm-vgic-v3.txt, +* As per Documentation/virt/kvm/devices/arm-vgic-v3.rst, * below macros are defined for CPUREG encoding. */ #define KVM_REG_ARM_VGIC_SYSREG_OP0_MASK 0x000000000000c000
@@ -63,7 +63,7 @@ KVM_REG_ARM_VGIC_SYSREG_OP2_MASK)/* -* As per Documentation/virt/kvm/devices/arm-vgic-its.txt, +* As per Documentation/virt/kvm/devices/arm-vgic-its.rst, * below macros are defined for ITS table entry encoding. */ #define KVM_ITS_CTE_VALID_SHIFT 63
Signature · 1 line
2.25.2
PATCH 5/35 docs: filesystems: fix renamed references
In reply to Mauro Carvalho ChehabSome filesystem references got broken by a previous patch series I submitted. Address those.
--- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-smaps_rollup | 2 +- Documentation/admin-guide/cpu-load.rst | 2 +- Documentation/admin-guide/nfs/nfsroot.rst | 2 +- Documentation/driver-api/driver-model/device.rst | 4 ++-- Documentation/driver-api/driver-model/overview.rst | 2 +- Documentation/filesystems/dax.txt | 2 +- Documentation/filesystems/dnotify.txt | 2 +- Documentation/filesystems/ramfs-rootfs-initramfs.rst | 2 +- Documentation/filesystems/sysfs.rst | 2 +- Documentation/powerpc/firmware-assisted-dump.rst | 2 +- Documentation/process/adding-syscalls.rst | 2 +- .../translations/it_IT/process/adding-syscalls.rst | 2 +- Documentation/translations/zh_CN/filesystems/sysfs.txt | 6 +++--- drivers/base/core.c | 2 +- drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h | 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/hfs/Kconfig | 2 +- fs/hpfs/Kconfig | 2 +- fs/isofs/Kconfig | 2 +- fs/namespace.c | 2 +- fs/notify/inotify/Kconfig | 2 +- fs/ntfs/Kconfig | 2 +- fs/ocfs2/Kconfig | 2 +- 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/relay.h | 2 +- include/linux/sysfs.h | 2 +- kernel/relay.c | 2 +- lib/kobject.c | 4 ++-- 45 files changed, 52 insertions(+), 52 deletions(-)
Documentation/ABI/stable/sysfs-devices-node +1 -1
@@ -54,7 +54,7 @@ Date: October 2002 Contact: Linux Memory Management list <[email protected]> Description: Provides information about the node's distribution and memory - utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.txt + utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.rst What: /sys/devices/system/node/nodeX/numastat Date: October 2002
Documentation/ABI/testing/procfs-smaps_rollup +1 -1
@@ -11,7 +11,7 @@ Description: Additionally, the fields Pss_Anon, Pss_File and Pss_Shmem are not present in /proc/pid/smaps. These fields represent the sum of the Pss field of each type (anon, file, shmem). - For more details, see Documentation/filesystems/proc.txt + For more details, see Documentation/filesystems/proc.rst and the procfs man page. Typical output looks like this:
Documentation/admin-guide/cpu-load.rst +1 -1
@@ -105,7 +105,7 @@ References ---------- - http://lkml.org/lkml/2007/2/12/6 -- Documentation/filesystems/proc.txt (1.8) +- Documentation/filesystems/proc.rst (1.8) Thanks
Documentation/admin-guide/nfs/nfsroot.rst +1 -1
@@ -18,7 +18,7 @@ Mounting the root filesystem via NFS (nfsroot) In order to use a diskless system, such as an X-terminal or printer server for example, it is necessary for the root filesystem to be present on a non-disk device. This may be an initramfs (see -Documentation/filesystems/ramfs-rootfs-initramfs.txt), a ramdisk (see +Documentation/filesystems/ramfs-rootfs-initramfs.rst), a ramdisk (see Documentation/admin-guide/initrd.rst) or a filesystem mounted via NFS. The following text describes on how to use NFS for the root filesystem. For the rest of this text 'client' means the diskless system, and 'server' means the NFS
Documentation/driver-api/driver-model/device.rst +2 -2
@@ -50,10 +50,10 @@ Attributes Attributes of devices can be exported by a device driver through sysfs. -Please see Documentation/filesystems/sysfs.txt for more information +Please see Documentation/filesystems/sysfs.rst for more information on how sysfs works. -As explained in Documentation/kobject.txt, device attributes must be +As explained in Documentation/core-api/kobject.rst, device attributes must be created before the KOBJ_ADD uevent is generated. The only way to realize that is by defining an attribute group.
Documentation/driver-api/driver-model/overview.rst +1 -1
@@ -121,4 +121,4 @@ device-specific data or tunable interfaces. More information about the sysfs directory layout can be found in the other documents in this directory and in the file -Documentation/filesystems/sysfs.txt. +Documentation/filesystems/sysfs.rst.
Documentation/filesystems/dax.txt +1 -1
@@ -74,7 +74,7 @@ are zeroed out and converted to written extents before being returned to avoid exposure of uninitialized data through mmap. These filesystems may be used for inspiration: -- ext2: see Documentation/filesystems/ext2.txt +- ext2: see Documentation/filesystems/ext2.rst - ext4: see Documentation/filesystems/ext4/ - xfs: see Documentation/admin-guide/xfs.rst
Documentation/filesystems/dnotify.txt +1 -1
@@ -67,4 +67,4 @@ See tools/testing/selftests/filesystems/dnotify_test.c for an example. NOTE ---- Beginning with Linux 2.6.13, dnotify has been replaced by inotify. -See Documentation/filesystems/inotify.txt for more information on it. +See Documentation/filesystems/inotify.rst for more information on it.
Documentation/filesystems/ramfs-rootfs-initramfs.rst +1 -1
@@ -71,7 +71,7 @@ be allowed write access to a ramfs mount. A ramfs derivative called tmpfs was created to add size limits, and the ability to write the data to swap space. Normal users can be allowed write access to -tmpfs mounts. See Documentation/filesystems/tmpfs.txt for more information. +tmpfs mounts. See Documentation/filesystems/tmpfs.rst for more information. What is rootfs? ---------------
Documentation/filesystems/sysfs.rst +1 -1
@@ -20,7 +20,7 @@ a means to export kernel data structures, their attributes, and the linkages between them to userspace. sysfs is tied inherently to the kobject infrastructure. Please read -Documentation/kobject.txt for more information concerning the kobject +Documentation/core-api/kobject.rst for more information concerning the kobject interface.
Documentation/powerpc/firmware-assisted-dump.rst +1 -1
@@ -344,7 +344,7 @@ Here is the list of files under powerpc debugfs: NOTE: - Please refer to Documentation/filesystems/debugfs.txt on + Please refer to Documentation/filesystems/debugfs.rst on how to mount the debugfs filesystem.
Documentation/process/adding-syscalls.rst +1 -1
@@ -33,7 +33,7 @@ interface. to a somewhat opaque API. - If you're just exposing runtime system information, a new node in sysfs - (see ``Documentation/filesystems/sysfs.txt``) or the ``/proc`` filesystem may + (see ``Documentation/filesystems/sysfs.rst``) or the ``/proc`` filesystem may be more appropriate. However, access to these mechanisms requires that the relevant filesystem is mounted, which might not always be the case (e.g. in a namespaced/sandboxed/chrooted environment). Avoid adding any API to
Documentation/translations/it_IT/process/adding-syscalls.rst +1 -1
@@ -39,7 +39,7 @@ vostra interfaccia. un qualche modo opaca. - Se dovete esporre solo delle informazioni sul sistema, un nuovo nodo in - sysfs (vedere ``Documentation/filesystems/sysfs.txt``) o + sysfs (vedere ``Documentation/filesystems/sysfs.rst``) o in procfs potrebbe essere sufficiente. Tuttavia, l'accesso a questi meccanismi richiede che il filesystem sia montato, il che potrebbe non essere sempre vero (per esempio, in ambienti come namespace/sandbox/chroot).
Documentation/translations/zh_CN/filesystems/sysfs.txt +3 -3
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/filesystems/sysfs.txt +Chinese translated version of Documentation/filesystems/sysfs.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem
@@ -10,7 +10,7 @@ Maintainer: Patrick Mochel <[email protected]> Mike Murphy <[email protected]> Chinese maintainer: Fu Wei <[email protected]> --------------------------------------------------------------------- -Documentation/filesystems/sysfs.txt 的中文翻译 +Documentation/filesystems/sysfs.rst 的中文翻译 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
@@ -40,7 +40,7 @@ sysfs 是一个最初基于 ramfs 且位于内存的文件系统。它提供导 数据结构及其属性,以及它们之间的关联到用户空间的方法。 sysfs 始终与 kobject 的底层结构紧密相关。请阅读 -Documentation/kobject.txt 文档以获得更多关于 kobject 接口的 +Documentation/core-api/kobject.rst 文档以获得更多关于 kobject 接口的 信息。
drivers/base/core.c +1 -1
@@ -1374,7 +1374,7 @@ static void device_release(struct kobject *kobj)else if (dev->class && dev->class->dev_release) dev->class->dev_release (dev);else -WARN (1 ,KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/kobject.txt.\n" , +WARN (1 ,KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/core-api/kobject.rst.\n" ,dev_name (dev));kfree (p); }
drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h +1 -1
@@ -170,7 +170,7 @@ struct dpu_global_state* * Main debugfs documentation is located at, * -* Documentation/filesystems/debugfs.txt +* Documentation/filesystems/debugfs.rst * * @dpu_debugfs_setup_regset32: Initialize data for dpu_debugfs_create_regset32 * @dpu_debugfs_create_regset32: Create 32-bit register dump file
fs/Kconfig +1 -1
@@ -166,7 +166,7 @@ config TMPFS space. If you unmount a tmpfs instance, everything stored therein is lost. - See <file:Documentation/filesystems/tmpfs.txt> for details. + See <file:Documentation/filesystems/tmpfs.rst> for details. config TMPFS_POSIX_ACL bool "Tmpfs POSIX Access Control Lists"
fs/Kconfig.binfmt +1 -1
@@ -72,7 +72,7 @@ config CORE_DUMP_DEFAULT_ELF_HEADERS The core dump behavior can be controlled per process using the /proc/PID/coredump_filter pseudo-file; this setting is - inherited. See Documentation/filesystems/proc.txt for details. + inherited. See Documentation/filesystems/proc.rst for details. This config option changes the default setting of coredump_filter seen at boot time. If unsure, say Y.
fs/adfs/Kconfig +1 -1
@@ -12,7 +12,7 @@ config ADFS_FS The ADFS partition should be the first partition (i.e., /dev/[hs]d?1) on each of your drives. Please read the file - <file:Documentation/filesystems/adfs.txt> for further details. + <file:Documentation/filesystems/adfs.rst> for further details. To compile this code as a module, choose M here: the module will be called adfs.
fs/affs/Kconfig +1 -1
@@ -9,7 +9,7 @@ config AFFS_FS FFS partition on your hard drive. Amiga floppies however cannot be read with this driver due to an incompatibility of the floppy controller used in an Amiga and the standard floppy controller in - PCs and workstations. Read <file:Documentation/filesystems/affs.txt> + PCs and workstations. Read <file:Documentation/filesystems/affs.rst> and <file:fs/affs/Changes>. With this driver you can also mount disk files used by Bernd
fs/afs/Kconfig +3 -3
@@ -8,7 +8,7 @@ config AFS_FS If you say Y here, you will get an experimental Andrew File System driver. It currently only supports unsecured read-only AFS access. - See <file:Documentation/filesystems/afs.txt> for more information. + See <file:Documentation/filesystems/afs.rst> for more information. If unsure, say N.
@@ -18,7 +18,7 @@ config AFS_DEBUG help Say Y here to make runtime controllable debugging messages appear. - See <file:Documentation/filesystems/afs.txt> for more information. + See <file:Documentation/filesystems/afs.rst> for more information. If unsure, say N.
@@ -37,6 +37,6 @@ config AFS_DEBUG_CURSOR the dmesg log if the server rotation algorithm fails to successfully contact a server. - See <file:Documentation/filesystems/afs.txt> for more information. + See <file:Documentation/filesystems/afs.rst> for more information. If unsure, say N.
fs/bfs/Kconfig +1 -1
@@ -11,7 +11,7 @@ config BFS_FS on your /stand slice from within Linux. You then also need to say Y to "UnixWare slices support", below. More information about the BFS file system is contained in the file - <file:Documentation/filesystems/bfs.txt>. + <file:Documentation/filesystems/bfs.rst>. If you don't know what this is about, say N.
fs/cramfs/Kconfig +1 -1
@@ -9,7 +9,7 @@ config CRAMFS limited to 256MB file systems (with 16MB files), and doesn't support 16/32 bits uid/gid, hard links and timestamps. - See <file:Documentation/filesystems/cramfs.txt> and + See <file:Documentation/filesystems/cramfs.rst> and <file:fs/cramfs/README> for further information. To compile this as a module, choose M here: the module will be called
fs/ecryptfs/Kconfig +1 -1
@@ -7,7 +7,7 @@ config ECRYPT_FS select CRYPTO_MD5 help Encrypted filesystem that operates on the VFS layer. See - <file:Documentation/filesystems/ecryptfs.txt> to learn more about + <file:Documentation/filesystems/ecryptfs.rst> to learn more about eCryptfs. Userspace components are required and can be obtained from <http://ecryptfs.sf.net>.
fs/hfs/Kconfig +1 -1
@@ -6,7 +6,7 @@ config HFS_FS help If you say Y here, you will be able to mount Macintosh-formatted floppy disks and hard drive partitions with full read-write access. - Please read <file:Documentation/filesystems/hfs.txt> to learn about + Please read <file:Documentation/filesystems/hfs.rst> to learn about the available mount options. To compile this file system support as a module, choose M here: the
fs/hpfs/Kconfig +1 -1
@@ -9,7 +9,7 @@ config HPFS_FS write files to an OS/2 HPFS partition on your hard drive. OS/2 floppies however are in regular MSDOS format, so you don't need this option in order to be able to read them. Read - <file:Documentation/filesystems/hpfs.txt>. + <file:Documentation/filesystems/hpfs.rst>. To compile this file system support as a module, choose M here: the module will be called hpfs. If unsure, say N.
fs/isofs/Kconfig +1 -1
@@ -8,7 +8,7 @@ config ISO9660_FS long Unix filenames and symbolic links are also supported by this driver. If you have a CD-ROM drive and want to do more with it than just listen to audio CDs and watch its LEDs, say Y (and read - <file:Documentation/filesystems/isofs.txt> and the CD-ROM-HOWTO, + <file:Documentation/filesystems/isofs.rst> and the CD-ROM-HOWTO, available from <http://www.tldp.org/docs.html#howto>), thereby enlarging your kernel by about 27 KB; otherwise say N.
fs/namespace.c +1 -1
@@ -3592,7 +3592,7 @@ EXPORT_SYMBOL(path_is_under);* file system may be mounted on put_old. After all, new_root is a mountpoint. * * Also, the current root cannot be on the 'rootfs' (initial ramfs) filesystem. -* See Documentation/filesystems/ramfs-rootfs-initramfs.txt for alternatives +* See Documentation/filesystems/ramfs-rootfs-initramfs.rst for alternatives * in this situation. * * Notes:
fs/notify/inotify/Kconfig +1 -1
@@ -12,6 +12,6 @@ config INOTIFY_USER new features including multiple file events, one-shot support, and unmount notification. - For more information, see <file:Documentation/filesystems/inotify.txt> + For more information, see <file:Documentation/filesystems/inotify.rst> If unsure, say Y.
fs/ntfs/Kconfig +1 -1
@@ -18,7 +18,7 @@ config NTFS_FS the Linux 2.4 kernel series is separately available as a patch from the project web site. - For more information see <file:Documentation/filesystems/ntfs.txt> + For more information see <file:Documentation/filesystems/ntfs.rst> and <http://www.linux-ntfs.org/>. To compile this file system support as a module, choose M here: the
fs/ocfs2/Kconfig +1 -1
@@ -21,7 +21,7 @@ config OCFS2_FS OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/ For more information on OCFS2, see the file - <file:Documentation/filesystems/ocfs2.txt>. + <file:Documentation/filesystems/ocfs2.rst>. config OCFS2_FS_O2CB tristate "O2CB Kernelspace Clustering"
fs/proc/Kconfig +2 -2
@@ -23,7 +23,7 @@ config PROC_FS /proc" or the equivalent line in /etc/fstab does the job. The /proc file system is explained in the file - <file:Documentation/filesystems/proc.txt> and on the proc(5) manpage + <file:Documentation/filesystems/proc.rst> and on the proc(5) manpage ("man 5 proc"). This option will enlarge your kernel by about 67 KB. Several
@@ -95,7 +95,7 @@ config PROC_CHILDREN default n help Provides a fast way to retrieve first level children pids of a task. See - <file:Documentation/filesystems/proc.txt> for more information. + <file:Documentation/filesystems/proc.rst> for more information. Say Y if you are running any user-space software which takes benefit from this interface. For example, rkt is such a piece of software.
fs/romfs/Kconfig +1 -1
@@ -6,7 +6,7 @@ config ROMFS_FS This is a very small read-only file system mainly intended for initial ram disks of installation disks, but it could be used for other read-only media as well. Read - <file:Documentation/filesystems/romfs.txt> for details. + <file:Documentation/filesystems/romfs.rst> for details. To compile this file system support as a module, choose M here: the module will be called romfs. Note that the file system of your
fs/sysfs/dir.c +1 -1
@@ -6,7 +6,7 @@* Copyright (c) 2007 SUSE Linux Products GmbH * Copyright (c) 2007 Tejun Heo <[email protected]> * -* Please see Documentation/filesystems/sysfs.txt for more information. +* Please see Documentation/filesystems/sysfs.rst for more information. */ #define pr_fmt (fmt) "sysfs: " fmt
fs/sysfs/file.c +1 -1
@@ -6,7 +6,7 @@* Copyright (c) 2007 SUSE Linux Products GmbH * Copyright (c) 2007 Tejun Heo <[email protected]> * -* Please see Documentation/filesystems/sysfs.txt for more information. +* Please see Documentation/filesystems/sysfs.rst for more information. */ #include <linux/module.h>
fs/sysfs/mount.c +1 -1
@@ -6,7 +6,7 @@* Copyright (c) 2007 SUSE Linux Products GmbH * Copyright (c) 2007 Tejun Heo <[email protected]> * -* Please see Documentation/filesystems/sysfs.txt for more information. +* Please see Documentation/filesystems/sysfs.rst for more information. */ #include <linux/fs.h>
fs/sysfs/symlink.c +1 -1
@@ -6,7 +6,7 @@* Copyright (c) 2007 SUSE Linux Products GmbH * Copyright (c) 2007 Tejun Heo <[email protected]> * -* Please see Documentation/filesystems/sysfs.txt for more information. +* Please see Documentation/filesystems/sysfs.rst for more information. */ #include <linux/fs.h>
fs/sysv/Kconfig +1 -1
@@ -28,7 +28,7 @@ config SYSV_FS tar" or preferably "info tar"). Note also that this option has nothing whatsoever to do with the option "System V IPC". Read about the System V file system in - <file:Documentation/filesystems/sysv-fs.txt>. + <file:Documentation/filesystems/sysv-fs.rst>. Saying Y here will enlarge your kernel by about 27 KB. To compile this as a module, choose M here: the module will be called
fs/udf/Kconfig +1 -1
@@ -9,7 +9,7 @@ config UDF_FS compatible with standard unix file systems, it is also suitable for removable USB disks. Say Y if you intend to mount DVD discs or CDRW's written in packet mode, or if you want to use UDF for removable USB - disks. Please read <file:Documentation/filesystems/udf.txt>. + disks. Please read <file:Documentation/filesystems/udf.rst>. To compile this file system support as a module, choose M here: the module will be called udf.
include/linux/kobject.h +1 -1
@@ -7,7 +7,7 @@* Copyright (c) 2006-2008 Greg Kroah-Hartman <[email protected]> * Copyright (c) 2006-2008 Novell Inc. * -* Please read Documentation/kobject.txt before using the kobject +* Please read Documentation/core-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */
include/linux/kobject_ns.h +1 -1
@@ -8,7 +8,7 @@* * Split from kobject.h by David Howells ([email protected]) * -* Please read Documentation/kobject.txt before using the kobject +* Please read Documentation/core-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */
include/linux/relay.h +1 -1
@@ -141,7 +141,7 @@ struct rchan_callbacks* cause relay_open() to create a single global buffer rather * than the default set of per-cpu buffers. * -* See Documentation/filesystems/relay.txt for more info. +* See Documentation/filesystems/relay.rst for more info. */ struct dentry *(*create_buf_file)(const char *filename, struct dentry *parent,
include/linux/sysfs.h +1 -1
@@ -7,7 +7,7 @@* Copyright (c) 2007 SUSE Linux Products GmbH * Copyright (c) 2007 Tejun Heo <[email protected]> * -* Please see Documentation/filesystems/sysfs.txt for more information. +* Please see Documentation/filesystems/sysfs.rst for more information. */ #ifndef _SYSFS_H_
kernel/relay.c +1 -1
@@ -1,7 +1,7 @@/* * Public API and common code for kernel->userspace relay file support. * -* See Documentation/filesystems/relay.txt for an overview. +* See Documentation/filesystems/relay.rst for an overview. * * Copyright (C) 2002-2005 - Tom Zanussi ([email protected]), IBM Corp * Copyright (C) 1999-2005 - Karim Yaghmour ([email protected])
lib/kobject.c +2 -2
@@ -6,7 +6,7 @@* Copyright (c) 2006-2007 Greg Kroah-Hartman <[email protected]> * Copyright (c) 2006-2007 Novell Inc. * -* Please see the file Documentation/kobject.txt for critical information +* Please see the file Documentation/core-api/kobject.rst for critical information * about using the kobject interface. */
@@ -670,7 +670,7 @@ static void kobject_cleanup(struct kobject *kobj) kobject_name(kobj), kobj, __func__, kobj->parent);if (t && !t->release) -pr_debug ("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/kobject.txt.\n" , +pr_debug ("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/core-api/kobject.rst.\n" ,kobject_name (kobj), kobj);/* send "remove" if the caller did not do it but sent "add" */
Signature · 6 lines
2.25.2 _______________________________________________ Freedreno mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/freedreno
PATCH 21/35 docs: spi: spi.h: fix a doc building warning
In reply to Mauro Carvalho ChehabWe need to add a blank line to avoid this warning:
./include/linux/spi/spi.h:401: WARNING: Unexpected indentation.
--- include/linux/spi/spi.h | 1 + 1 file changed, 1 insertion(+)
include/linux/spi/spi.h +1 -0
@@ -394,6 +394,7 @@ static inline void spi_unregister_driver(struct spi_driver *sdrv)* for example doing DMA mapping. Called from threaded * context. * @transfer_one: transfer a single spi_transfer. +* * - return 0 if the transfer is finished, * - return 1 if the transfer is still in progress. When * the driver is finished with this transfer it must
Signature · 1 line
2.25.2
PATCH 28/35 docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
In reply to Mauro Carvalho ChehabThe qcom-qusb2-phy.txt file was converted and renamed to yaml. Update cross-reference accordingly.
--- Documentation/devicetree/bindings/usb/qcom,dwc3.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/devicetree/bindings/usb/qcom,dwc3.txt +2 -2
@@ -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:
Signature · 1 line
2.25.2
PATCH 11/35 scripts: kernel-doc: proper handle @foo->bar()
In reply to Mauro Carvalho ChehabThe pattern @foo->bar() is valid, as it can be used by a function pointer inside a struct passed as a parameter.
Right now, it causes a warning:
./drivers/firewire/core-transaction.c:606: WARNING: Inline strong start-string without end-string.
In this specific case, the kernel-doc markup is:
/**
* fw_core_remove_address_handler() - unregister an address handler
* @handler: callback
*
* To be called in process context.
*
* When fw_core_remove_address_handler() returns, @handler->callback() is
* guaranteed to not run on any CPU anymore.
*/
With seems valid on my eyes. So, instead of trying to hack the kernel-doc markup, let's teach it about how to handle such things. This should likely remove lots of other similar warnings as well.
--- scripts/kernel-doc | 2 ++ 1 file changed, 2 insertions(+)
scripts/kernel-doc +2 -0
@@ -214,6 +214,7 @@ my $type_constant2 = '\%([-_\w]+)'; my $type_func = '(\w+)\(\)'; my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params +my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params my $type_env = '(\$\w+)'; my $type_enum = '\&(enum\s*([_\w]+))'; my $type_struct = '\&(struct\s*([_\w]+))';
@@ -249,6 +250,7 @@ my @highlights_rst = ( [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"], [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], [$type_fp_param, "**\$1\\\\(\\\\)**"], + [$type_fp_param2, "**\$1\\\\(\\\\)**"], [$type_func, "\$1()"], [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
Signature · 1 line
2.25.2
PATCH 4/35 docs: fix broken references for ReST files that moved around
In reply to Mauro Carvalho ChehabSome broken references happened due to shifting files around and ReST renames. Those can't be auto-fixed by the script, so let's fix them manually.
--- Documentation/doc-guide/maintainer-profile.rst | 2 +- Documentation/virt/kvm/mmu.rst | 2 +- Documentation/virt/kvm/review-checklist.rst | 2 +- arch/x86/kvm/mmu/mmu.c | 2 +- drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c | 2 +- drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c | 2 +- drivers/crypto/allwinner/sun8i-ss/sun8i-ss-cipher.c | 2 +- drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c | 2 +- drivers/media/v4l2-core/v4l2-fwnode.c | 2 +- include/uapi/linux/kvm.h | 4 ++-- tools/include/uapi/linux/kvm.h | 4 ++-- 11 files changed, 13 insertions(+), 13 deletions(-)
Documentation/doc-guide/maintainer-profile.rst +1 -1
@@ -6,7 +6,7 @@ Documentation subsystem maintainer entry profile The documentation "subsystem" is the central coordinating point for the kernel's documentation and associated infrastructure. It covers the hierarchy under Documentation/ (with the exception of -Documentation/device-tree), various utilities under scripts/ and, at least +Documentation/devicetree), various utilities under scripts/ and, at least some of the time, LICENSES/. It's worth noting, though, that the boundaries of this subsystem are rather
Documentation/virt/kvm/mmu.rst +1 -1
@@ -319,7 +319,7 @@ Handling a page fault is performed as follows: - If both P bit and R/W bit of error code are set, this could possibly be handled as a "fast page fault" (fixed without taking the MMU lock). See - the description in Documentation/virt/kvm/locking.txt. + the description in Documentation/virt/kvm/locking.rst. - if needed, walk the guest page tables to determine the guest translation (gva->gpa or ngpa->gpa)
Documentation/virt/kvm/review-checklist.rst +1 -1
@@ -10,7 +10,7 @@ Review checklist for kvm patches 2. Patches should be against kvm.git master branch. 3. If the patch introduces or modifies a new userspace API: - - the API must be documented in Documentation/virt/kvm/api.txt + - the API must be documented in Documentation/virt/kvm/api.rst - the API must be discoverable using KVM_CHECK_EXTENSION 4. New state must include support for save/restore.
arch/x86/kvm/mmu/mmu.c +1 -1
@@ -3586,7 +3586,7 @@ static bool fast_page_fault(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa,/* * Currently, fast page fault only works for direct mapping * since the gfn is not stable for indirect shadow page. See -* Documentation/virt/kvm/locking.txt to get more detail. +* Documentation/virt/kvm/locking.rst to get more detail. */ fault_handled = fast_pf_fix_direct_spte(vcpu, sp, iterator.sptep, spte,
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c +1 -1
@@ -8,7 +8,7 @@* This file add support for AES cipher with 128,192,256 bits keysize in * CBC and ECB mode. * -* You could find a link for the datasheet in Documentation/arm/sunxi/README +* You could find a link for the datasheet in Documentation/arm/sunxi.rst */ #include <linux/crypto.h>
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c +1 -1
@@ -7,7 +7,7 @@* * Core file which registers crypto algorithms supported by the CryptoEngine. * -* You could find a link for the datasheet in Documentation/arm/sunxi/README +* You could find a link for the datasheet in Documentation/arm/sunxi.rst */ #include <linux/clk.h> #include <linux/crypto.h>
drivers/crypto/allwinner/sun8i-ss/sun8i-ss-cipher.c +1 -1
@@ -8,7 +8,7 @@* This file add support for AES cipher with 128,192,256 bits keysize in * CBC and ECB mode. * -* You could find a link for the datasheet in Documentation/arm/sunxi/README +* You could find a link for the datasheet in Documentation/arm/sunxi.rst */ #include <linux/crypto.h>
drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c +1 -1
@@ -7,7 +7,7 @@* * Core file which registers crypto algorithms supported by the SecuritySystem * -* You could find a link for the datasheet in Documentation/arm/sunxi/README +* You could find a link for the datasheet in Documentation/arm/sunxi.rst */ #include <linux/clk.h> #include <linux/crypto.h>
drivers/media/v4l2-core/v4l2-fwnode.c +1 -1
@@ -980,7 +980,7 @@ static int v4l2_fwnode_reference_parse(struct device *dev,* * THIS EXAMPLE EXISTS MERELY TO DOCUMENT THIS FUNCTION. DO NOT USE IT AS A * REFERENCE IN HOW ACPI TABLES SHOULD BE WRITTEN!! See documentation under -* Documentation/acpi/dsd instead and especially graph.txt, +* Documentation/firmware-guide/acpi/dsd/ instead and especially graph.txt, * data-node-references.txt and leds.txt . * * Scope (\_SB.PCI0.I2C2)
include/uapi/linux/kvm.h +2 -2
@@ -116,7 +116,7 @@ struct kvm_irq_level {* ACPI gsi notion of irq. * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47.. * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23.. -* For ARM: See Documentation/virt/kvm/api.txt +* For ARM: See Documentation/virt/kvm/api.rst */ union {__u32 irq;
@@ -1107,7 +1107,7 @@ struct kvm_xen_hvm_config {* * KVM_IRQFD_FLAG_RESAMPLE indicates resamplefd is valid and specifies * the irqfd to operate in resampling mode for level triggered interrupt -* emulation. See Documentation/virt/kvm/api.txt. +* emulation. See Documentation/virt/kvm/api.rst. */ #define KVM_IRQFD_FLAG_RESAMPLE (1 << 1)
tools/include/uapi/linux/kvm.h +2 -2
@@ -116,7 +116,7 @@ struct kvm_irq_level {* ACPI gsi notion of irq. * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47.. * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23.. -* For ARM: See Documentation/virt/kvm/api.txt +* For ARM: See Documentation/virt/kvm/api.rst */ union {__u32 irq;
@@ -1100,7 +1100,7 @@ struct kvm_xen_hvm_config {* * KVM_IRQFD_FLAG_RESAMPLE indicates resamplefd is valid and specifies * the irqfd to operate in resampling mode for level triggered interrupt -* emulation. See Documentation/virt/kvm/api.txt. +* emulation. See Documentation/virt/kvm/api.rst. */ #define KVM_IRQFD_FLAG_RESAMPLE (1 << 1)
Signature · 1 line
2.25.2
PATCH 6/35 docs: amu: supress some Sphinx warnings
In reply to Mauro Carvalho ChehabAdd extra blank lines on some places, in order to avoid those warnings when building the docs:
Documentation/arm64/amu.rst:26: WARNING: Unexpected indentation. Documentation/arm64/amu.rst:60: WARNING: Unexpected indentation. Documentation/arm64/amu.rst:81: WARNING: Unexpected indentation. Documentation/arm64/amu.rst:108: WARNING: Unexpected indentation.
--- Documentation/arm64/amu.rst | 5 +++++ 1 file changed, 5 insertions(+)
Documentation/arm64/amu.rst +5 -0
@@ -23,6 +23,7 @@ optional external memory-mapped interface. Version 1 of the Activity Monitors architecture implements a counter group of four fixed and architecturally defined 64-bit event counters. + - CPU cycle counter: increments at the frequency of the CPU. - Constant counter: increments at the fixed frequency of the system clock.
@@ -57,6 +58,7 @@ counters, only the presence of the extension. Firmware (code running at higher exception levels, e.g. arm-tf) support is needed to: + - Enable access for lower exception levels (EL2 and EL1) to the AMU registers. - Enable the counters. If not enabled these will read as 0.
@@ -78,6 +80,7 @@ are not trapped in EL2/EL3. The fixed counters of AMUv1 are accessible though the following system register definitions: + - SYS_AMEVCNTR0_CORE_EL0 - SYS_AMEVCNTR0_CONST_EL0 - SYS_AMEVCNTR0_INST_RET_EL0
@@ -93,6 +96,7 @@ Userspace access ---------------- Currently, access from userspace to the AMU registers is disabled due to: + - Security reasons: they might expose information about code executed in secure mode. - Purpose: AMU counters are intended for system management use.
@@ -105,6 +109,7 @@ Virtualization Currently, access from userspace (EL0) and kernelspace (EL1) on the KVM guest side is disabled due to: + - Security reasons: they might expose information about code executed by other guests or the host.
Signature · 7 lines
2.25.2 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH 24/35 docs: mm: slab.h: fix a broken cross-reference
In reply to Mauro Carvalho ChehabThere is a typo at the cross-reference link, causing this warning:
./include/linux/slab.h:11: WARNING: undefined label: memory-allocation (if the link has no caption the label must precede a section header)
--- include/linux/slab.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/slab.h +1 -1
@@ -501,7 +501,7 @@ static __always_inline void *kmalloc_large(size_t size, gfp_t flags)* :ref:`Documentation/core-api/mm-api.rst <mm-api-gfp-flags>` * * The recommended usage of the @flags is described at -* :ref:`Documentation/core-api/memory-allocation.rst <memory-allocation>` +* :ref:`Documentation/core-api/memory-allocation.rst <memory_allocation>` * * Below is a brief outline of the most useful GFP flags *
Signature · 1 line
2.25.2
PATCH 7/35 docs: arm64: booting.rst: get rid of some warnings
In reply to Mauro Carvalho ChehabGet rid of those warnings:
Documentation/arm64/booting.rst:253: WARNING: Unexpected indentation. Documentation/arm64/booting.rst:259: WARNING: Block quote ends without a blank line; unexpected unindent.
By adding an extra blank lines where needed.
While here, use list markups on some places, as otherwise Sphinx will consider the next lines as continuation of the privious ones.
--- Documentation/arm64/booting.rst | 36 ++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 14 deletions(-)
Documentation/arm64/booting.rst +22 -14
@@ -173,7 +173,9 @@ Before jumping into the kernel, the following conditions must be met: - Caches, MMUs The MMU must be off. + Instruction cache may be on or off. + The address range corresponding to the loaded kernel image must be cleaned to the PoC. In the presence of a system cache or other coherent masters with caches enabled, this will typically require
@@ -238,6 +240,7 @@ Before jumping into the kernel, the following conditions must be met: - The DT or ACPI tables must describe a GICv2 interrupt controller. For CPUs with pointer authentication functionality: + - If EL3 is present: - SCR_EL3.APK (bit 16) must be initialised to 0b1
@@ -249,18 +252,22 @@ Before jumping into the kernel, the following conditions must be met: - HCR_EL2.API (bit 41) must be initialised to 0b1 For CPUs with Activity Monitors Unit v1 (AMUv1) extension present: + - If EL3 is present: - CPTR_EL3.TAM (bit 30) must be initialised to 0b0 - CPTR_EL2.TAM (bit 30) must be initialised to 0b0 - AMCNTENSET0_EL0 must be initialised to 0b1111 - AMCNTENSET1_EL0 must be initialised to a platform specific value - having 0b1 set for the corresponding bit for each of the auxiliary - counters present. + + - CPTR_EL3.TAM (bit 30) must be initialised to 0b0 + - CPTR_EL2.TAM (bit 30) must be initialised to 0b0 + - AMCNTENSET0_EL0 must be initialised to 0b1111 + - AMCNTENSET1_EL0 must be initialised to a platform specific value + having 0b1 set for the corresponding bit for each of the auxiliary + counters present. + - If the kernel is entered at EL1: - AMCNTENSET0_EL0 must be initialised to 0b1111 - AMCNTENSET1_EL0 must be initialised to a platform specific value - having 0b1 set for the corresponding bit for each of the auxiliary - counters present. + + - AMCNTENSET0_EL0 must be initialised to 0b1111 + - AMCNTENSET1_EL0 must be initialised to a platform specific value + having 0b1 set for the corresponding bit for each of the auxiliary + counters present. The requirements described above for CPU mode, caches, MMUs, architected timers, coherency and system registers apply to all CPUs. All CPUs must
@@ -304,7 +311,8 @@ following manner: Documentation/devicetree/bindings/arm/psci.yaml. - Secondary CPU general-purpose register settings - x0 = 0 (reserved for future use) - x1 = 0 (reserved for future use) - x2 = 0 (reserved for future use) - x3 = 0 (reserved for future use) + + - x0 = 0 (reserved for future use) + - x1 = 0 (reserved for future use) + - x2 = 0 (reserved for future use) + - x3 = 0 (reserved for future use)
Signature · 1 line
2.25.2
PATCH 31/35 powerpc: docs: cxl.rst: mark two section titles as such
In reply to Mauro Carvalho ChehabThe User API chapter contains two sub-chapters. Mark them as such.
--- Documentation/powerpc/cxl.rst | 2 ++ 1 file changed, 2 insertions(+)
Documentation/powerpc/cxl.rst +2 -0
@@ -133,6 +133,7 @@ User API ======== 1. AFU character devices +^^^^^^^^^^^^^^^^^^^^^^^^ For AFUs operating in AFU directed mode, two character device files will be created. /dev/cxl/afu0.0m will correspond to a
@@ -395,6 +396,7 @@ read 2. Card character device (powerVM guest only) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In a powerVM guest, an extra character device is created for the card. The device is only used to write (flash) a new image on the
Signature · 1 line
2.25.2
PATCH 25/35 docs mm: userfaultfd.rst: use ``foo`` for literals
In reply to Mauro Carvalho ChehabSeveral parts of this document define literals: ioctl names, function calls, directory patches, etc. Mark those as literal blocks, in order to improve its readability (both at text mode and after parsed by Sphinx.
This fixes those two warnings:
Documentation/admin-guide/mm/userfaultfd.rst:139: WARNING: Inline emphasis start-string without end-string. Documentation/admin-guide/mm/userfaultfd.rst:139: WARNING: Inline emphasis start-string without end-string.
produced during documentation build.
--- Documentation/admin-guide/mm/userfaultfd.rst | 207 ++++++++++--------- 1 file changed, 104 insertions(+), 103 deletions(-)
Documentation/admin-guide/mm/userfaultfd.rst +104 -103
@@ -12,107 +12,107 @@ and more generally they allow userland to take control of various memory page faults, something otherwise only the kernel code could do. For example userfaults allows a proper and more optimal implementation -of the PROT_NONE+SIGSEGV trick. +of the ``PROT_NONE+SIGSEGV`` trick. Design ====== -Userfaults are delivered and resolved through the userfaultfd syscall. +Userfaults are delivered and resolved through the ``userfaultfd`` syscall. -The userfaultfd (aside from registering and unregistering virtual +The ``userfaultfd`` (aside from registering and unregistering virtual memory ranges) provides two primary functionalities: -1) read/POLLIN protocol to notify a userland thread of the faults +1) ``read/POLLIN`` protocol to notify a userland thread of the faults happening -2) various UFFDIO_* ioctls that can manage the virtual memory regions - registered in the userfaultfd that allows userland to efficiently +2) various ``UFFDIO_*`` ioctls that can manage the virtual memory regions + registered in the ``userfaultfd`` that allows userland to efficiently resolve the userfaults it receives via 1) or to manage the virtual memory in the background The real advantage of userfaults if compared to regular virtual memory management of mremap/mprotect is that the userfaults in all their operations never involve heavyweight structures like vmas (in fact the -userfaultfd runtime load never takes the mmap_sem for writing). +``userfaultfd`` runtime load never takes the mmap_sem for writing). Vmas are not suitable for page- (or hugepage) granular fault tracking when dealing with virtual address spaces that could span Terabytes. Too many vmas would be needed for that. -The userfaultfd once opened by invoking the syscall, can also be +The ``userfaultfd`` once opened by invoking the syscall, can also be passed using unix domain sockets to a manager process, so the same manager process could handle the userfaults of a multitude of different processes without them being aware about what is going on -(well of course unless they later try to use the userfaultfd +(well of course unless they later try to use the ``userfaultfd`` themselves on the same region the manager is already tracking, which -is a corner case that would currently return -EBUSY). +is a corner case that would currently return ``-EBUSY``). API === -When first opened the userfaultfd must be enabled invoking the -UFFDIO_API ioctl specifying a uffdio_api.api value set to UFFD_API (or -a later API version) which will specify the read/POLLIN protocol -userland intends to speak on the UFFD and the uffdio_api.features -userland requires. The UFFDIO_API ioctl if successful (i.e. if the -requested uffdio_api.api is spoken also by the running kernel and the +When first opened the ``userfaultfd`` must be enabled invoking the +``UFFDIO_API`` ioctl specifying a ``uffdio_api.api`` value set to ``UFFD_API`` (or +a later API version) which will specify the ``read/POLLIN`` protocol +userland intends to speak on the ``UFFD`` and the ``uffdio_api.features`` +userland requires. The ``UFFDIO_API`` ioctl if successful (i.e. if the +requested ``uffdio_api.api`` is spoken also by the running kernel and the requested features are going to be enabled) will return into -uffdio_api.features and uffdio_api.ioctls two 64bit bitmasks of +``uffdio_api.features`` and ``uffdio_api.ioctls`` two 64bit bitmasks of respectively all the available features of the read(2) protocol and the generic ioctl available. -The uffdio_api.features bitmask returned by the UFFDIO_API ioctl -defines what memory types are supported by the userfaultfd and what +The ``uffdio_api.features`` bitmask returned by the ``UFFDIO_API`` ioctl +defines what memory types are supported by the ``userfaultfd`` and what events, except page fault notifications, may be generated. -If the kernel supports registering userfaultfd ranges on hugetlbfs -virtual memory areas, UFFD_FEATURE_MISSING_HUGETLBFS will be set in -uffdio_api.features. Similarly, UFFD_FEATURE_MISSING_SHMEM will be -set if the kernel supports registering userfaultfd ranges on shared -memory (covering all shmem APIs, i.e. tmpfs, IPCSHM, /dev/zero -MAP_SHARED, memfd_create, etc). +If the kernel supports registering ``userfaultfd`` ranges on hugetlbfs +virtual memory areas, ``UFFD_FEATURE_MISSING_HUGETLBFS`` will be set in +``uffdio_api.features``. Similarly, ``UFFD_FEATURE_MISSING_SHMEM`` will be +set if the kernel supports registering ``userfaultfd`` ranges on shared +memory (covering all shmem APIs, i.e. tmpfs, ``IPCSHM``, ``/dev/zero``, +``MAP_SHARED``, ``memfd_create``, etc). -The userland application that wants to use userfaultfd with hugetlbfs +The userland application that wants to use ``userfaultfd`` with hugetlbfs or shared memory need to set the corresponding flag in -uffdio_api.features to enable those features. +``uffdio_api.features`` to enable those features. If the userland desires to receive notifications for events other than -page faults, it has to verify that uffdio_api.features has appropriate -UFFD_FEATURE_EVENT_* bits set. These events are described in more +page faults, it has to verify that ``uffdio_api.features`` has appropriate +``UFFD_FEATURE_EVENT_*`` bits set. These events are described in more detail below in "Non-cooperative userfaultfd" section. -Once the userfaultfd has been enabled the UFFDIO_REGISTER ioctl should -be invoked (if present in the returned uffdio_api.ioctls bitmask) to -register a memory range in the userfaultfd by setting the -uffdio_register structure accordingly. The uffdio_register.mode +Once the ``userfaultfd`` has been enabled the ``UFFDIO_REGISTER`` ioctl should +be invoked (if present in the returned ``uffdio_api.ioctls`` bitmask) to +register a memory range in the ``userfaultfd`` by setting the +uffdio_register structure accordingly. The ``uffdio_register.mode`` bitmask will specify to the kernel which kind of faults to track for -the range (UFFDIO_REGISTER_MODE_MISSING would track missing -pages). The UFFDIO_REGISTER ioctl will return the -uffdio_register.ioctls bitmask of ioctls that are suitable to resolve +the range (``UFFDIO_REGISTER_MODE_MISSING`` would track missing +pages). The ``UFFDIO_REGISTER`` ioctl will return the +``uffdio_register.ioctls`` bitmask of ioctls that are suitable to resolve userfaults on the range registered. Not all ioctls will necessarily be supported for all memory types depending on the underlying virtual memory backend (anonymous memory vs tmpfs vs real filebacked mappings). -Userland can use the uffdio_register.ioctls to manage the virtual +Userland can use the ``uffdio_register.ioctls`` to manage the virtual address space in the background (to add or potentially also remove -memory from the userfaultfd registered range). This means a userfault +memory from the ``userfaultfd`` registered range). This means a userfault could be triggering just before userland maps in the background the user-faulted page. -The primary ioctl to resolve userfaults is UFFDIO_COPY. That +The primary ioctl to resolve userfaults is ``UFFDIO_COPY``. That atomically copies a page into the userfault registered range and wakes -up the blocked userfaults (unless uffdio_copy.mode & -UFFDIO_COPY_MODE_DONTWAKE is set). Other ioctl works similarly to -UFFDIO_COPY. They're atomic as in guaranteeing that nothing can see an -half copied page since it'll keep userfaulting until the copy has -finished. +up the blocked userfaults +(unless ``uffdio_copy.mode & UFFDIO_COPY_MODE_DONTWAKE`` is set). +Other ioctl works similarly to ``UFFDIO_COPY``. They're atomic as in +guaranteeing that nothing can see an half copied page since it'll +keep userfaulting until the copy has finished. Notes: -- If you requested UFFDIO_REGISTER_MODE_MISSING when registering then +- If you requested ``UFFDIO_REGISTER_MODE_MISSING`` when registering then you must provide some kind of page in your thread after reading from - the uffd. You must provide either UFFDIO_COPY or UFFDIO_ZEROPAGE. + the uffd. You must provide either ``UFFDIO_COPY`` or ``UFFDIO_ZEROPAGE``. The normal behavior of the OS automatically providing a zero page on an annonymous mmaping is not in place.
@@ -122,13 +122,13 @@ Notes: - You get the address of the access that triggered the missing page event out of a struct uffd_msg that you read in the thread from the - uffd. You can supply as many pages as you want with UFFDIO_COPY or - UFFDIO_ZEROPAGE. Keep in mind that unless you used DONTWAKE then + uffd. You can supply as many pages as you want with ``UFFDIO_COPY`` or + ``UFFDIO_ZEROPAGE``. Keep in mind that unless you used DONTWAKE then the first of any of those IOCTLs wakes up the faulting thread. -- Be sure to test for all errors including (pollfd[0].revents & - POLLERR). This can happen, e.g. when ranges supplied were - incorrect. +- Be sure to test for all errors including + (``pollfd[0].revents & POLLERR``). This can happen, e.g. when ranges + supplied were incorrect. Write Protect Notifications ---------------------------
@@ -136,41 +136,42 @@ Write Protect Notifications This is equivalent to (but faster than) using mprotect and a SIGSEGV signal handler. -Firstly you need to register a range with UFFDIO_REGISTER_MODE_WP. -Instead of using mprotect(2) you use ioctl(uffd, UFFDIO_WRITEPROTECT, -struct *uffdio_writeprotect) while mode = UFFDIO_WRITEPROTECT_MODE_WP +Firstly you need to register a range with ``UFFDIO_REGISTER_MODE_WP``. +Instead of using mprotect(2) you use +``ioctl(uffd, UFFDIO_WRITEPROTECT, struct *uffdio_writeprotect)`` +while ``mode = UFFDIO_WRITEPROTECT_MODE_WP`` in the struct passed in. The range does not default to and does not have to be identical to the range you registered with. You can write protect as many ranges as you like (inside the registered range). Then, in the thread reading from uffd the struct will have -msg.arg.pagefault.flags & UFFD_PAGEFAULT_FLAG_WP set. Now you send -ioctl(uffd, UFFDIO_WRITEPROTECT, struct *uffdio_writeprotect) again -while pagefault.mode does not have UFFDIO_WRITEPROTECT_MODE_WP set. -This wakes up the thread which will continue to run with writes. This +``msg.arg.pagefault.flags & UFFD_PAGEFAULT_FLAG_WP`` set. Now you send +``ioctl(uffd, UFFDIO_WRITEPROTECT, struct *uffdio_writeprotect)`` +again while ``pagefault.mode`` does not have ``UFFDIO_WRITEPROTECT_MODE_WP`` +set. This wakes up the thread which will continue to run with writes. This allows you to do the bookkeeping about the write in the uffd reading thread before the ioctl. -If you registered with both UFFDIO_REGISTER_MODE_MISSING and -UFFDIO_REGISTER_MODE_WP then you need to think about the sequence in +If you registered with both ``UFFDIO_REGISTER_MODE_MISSING`` and +``UFFDIO_REGISTER_MODE_WP`` then you need to think about the sequence in which you supply a page and undo write protect. Note that there is a difference between writes into a WP area and into a !WP area. The -former will have UFFD_PAGEFAULT_FLAG_WP set, the latter -UFFD_PAGEFAULT_FLAG_WRITE. The latter did not fail on protection but -you still need to supply a page when UFFDIO_REGISTER_MODE_MISSING was +former will have ``UFFD_PAGEFAULT_FLAG_WP`` set, the latter +``UFFD_PAGEFAULT_FLAG_WRITE``. The latter did not fail on protection but +you still need to supply a page when ``UFFDIO_REGISTER_MODE_MISSING`` was used. QEMU/KVM ======== -QEMU/KVM is using the userfaultfd syscall to implement postcopy live +QEMU/KVM is using the ``userfaultfd`` syscall to implement postcopy live migration. Postcopy live migration is one form of memory externalization consisting of a virtual machine running with part or all of its memory residing on a different node in the cloud. The -userfaultfd abstraction is generic enough that not a single line of +``userfaultfd`` abstraction is generic enough that not a single line of KVM kernel code had to be modified in order to add postcopy live migration to QEMU. -Guest async page faults, FOLL_NOWAIT and all other GUP features work +Guest async page faults, ``FOLL_NOWAIT`` and all other ``GUP*`` features work just fine in combination with userfaults. Userfaults trigger async page faults in the guest scheduler so those guest processes that aren't waiting for userfaults (i.e. network bound) can keep running in
@@ -183,19 +184,19 @@ generating userfaults for readonly guest regions. The implementation of postcopy live migration currently uses one single bidirectional socket but in the future two different sockets will be used (to reduce the latency of the userfaults to the minimum -possible without having to decrease /proc/sys/net/ipv4/tcp_wmem). +possible without having to decrease ``/proc/sys/net/ipv4/tcp_wmem``). The QEMU in the source node writes all pages that it knows are missing in the destination node, into the socket, and the migration thread of -the QEMU running in the destination node runs UFFDIO_COPY|ZEROPAGE -ioctls on the userfaultfd in order to map the received pages into the -guest (UFFDIO_ZEROCOPY is used if the source page was a zero page). +the QEMU running in the destination node runs ``UFFDIO_COPY|ZEROPAGE`` +ioctls on the ``userfaultfd`` in order to map the received pages into the +guest (``UFFDIO_ZEROCOPY`` is used if the source page was a zero page). A different postcopy thread in the destination node listens with -poll() to the userfaultfd in parallel. When a POLLIN event is +poll() to the ``userfaultfd`` in parallel. When a ``POLLIN`` event is generated after a userfault triggers, the postcopy thread read() from -the userfaultfd and receives the fault address (or -EAGAIN in case the -userfault was already resolved and waken by a UFFDIO_COPY|ZEROPAGE run +the ``userfaultfd`` and receives the fault address (or ``-EAGAIN`` in case the +userfault was already resolved and waken by a ``UFFDIO_COPY|ZEROPAGE`` run by the parallel QEMU migration thread). After the QEMU postcopy thread (running in the destination node) gets
@@ -206,7 +207,7 @@ remaining missing pages from that new page offset. Soon after that (just the time to flush the tcp_wmem queue through the network) the migration thread in the QEMU running in the destination node will receive the page that triggered the userfault and it'll map it as -usual with the UFFDIO_COPY|ZEROPAGE (without actually knowing if it +usual with the ``UFFDIO_COPY|ZEROPAGE`` (without actually knowing if it was spontaneously sent by the source or if it was an urgent page requested through a userfault).
@@ -219,74 +220,74 @@ checked to find which missing pages to send in round robin and we seek over it when receiving incoming userfaults. After sending each page of course the bitmap is updated accordingly. It's also useful to avoid sending the same page twice (in case the userfault is read by the -postcopy thread just before UFFDIO_COPY|ZEROPAGE runs in the migration +postcopy thread just before ``UFFDIO_COPY|ZEROPAGE`` runs in the migration thread). Non-cooperative userfaultfd =========================== -When the userfaultfd is monitored by an external manager, the manager +When the ``userfaultfd`` is monitored by an external manager, the manager must be able to track changes in the process virtual memory layout. Userfaultfd can notify the manager about such changes using the same read(2) protocol as for the page fault notifications. The manager has to explicitly enable these events by setting appropriate -bits in uffdio_api.features passed to UFFDIO_API ioctl: +bits in ``uffdio_api.features`` passed to ``UFFDIO_API`` ioctl: -UFFD_FEATURE_EVENT_FORK - enable userfaultfd hooks for fork(). When this feature is - enabled, the userfaultfd context of the parent process is +``UFFD_FEATURE_EVENT_FORK`` + enable ``userfaultfd`` hooks for fork(). When this feature is + enabled, the ``userfaultfd`` context of the parent process is duplicated into the newly created process. The manager - receives UFFD_EVENT_FORK with file descriptor of the new - userfaultfd context in the uffd_msg.fork. + receives ``UFFD_EVENT_FORK`` with file descriptor of the new + ``userfaultfd`` context in the ``uffd_msg.fork``. -UFFD_FEATURE_EVENT_REMAP +``UFFD_FEATURE_EVENT_REMAP`` enable notifications about mremap() calls. When the non-cooperative process moves a virtual memory area to a different location, the manager will receive - UFFD_EVENT_REMAP. The uffd_msg.remap will contain the old and + ``UFFD_EVENT_REMAP``. The ``uffd_msg.remap`` will contain the old and new addresses of the area and its original length. -UFFD_FEATURE_EVENT_REMOVE +``UFFD_FEATURE_EVENT_REMOVE`` enable notifications about madvise(MADV_REMOVE) and - madvise(MADV_DONTNEED) calls. The event UFFD_EVENT_REMOVE will - be generated upon these calls to madvise. The uffd_msg.remove + madvise(MADV_DONTNEED) calls. The event ``UFFD_EVENT_REMOVE`` will + be generated upon these calls to madvise(). The ``uffd_msg.remove`` will contain start and end addresses of the removed area. -UFFD_FEATURE_EVENT_UNMAP +``UFFD_FEATURE_EVENT_UNMAP`` enable notifications about memory unmapping. The manager will - get UFFD_EVENT_UNMAP with uffd_msg.remove containing start and + get ``UFFD_EVENT_UNMAP`` with ``uffd_msg.remove`` containing start and end addresses of the unmapped area. -Although the UFFD_FEATURE_EVENT_REMOVE and UFFD_FEATURE_EVENT_UNMAP +Although the ``UFFD_FEATURE_EVENT_REMOVE`` and ``UFFD_FEATURE_EVENT_UNMAP`` are pretty similar, they quite differ in the action expected from the -userfaultfd manager. In the former case, the virtual memory is +``userfaultfd`` manager. In the former case, the virtual memory is removed, but the area is not, the area remains monitored by the -userfaultfd, and if a page fault occurs in that area it will be +``userfaultfd``, and if a page fault occurs in that area it will be delivered to the manager. The proper resolution for such page fault is to zeromap the faulting address. However, in the latter case, when an area is unmapped, either explicitly (with munmap() system call), or implicitly (e.g. during mremap()), the area is removed and in turn the -userfaultfd context for such area disappears too and the manager will +``userfaultfd`` context for such area disappears too and the manager will not get further userland page faults from the removed area. Still, the notification is required in order to prevent manager from using -UFFDIO_COPY on the unmapped area. +``UFFDIO_COPY`` on the unmapped area. Unlike userland page faults which have to be synchronous and require explicit or implicit wakeup, all the events are delivered asynchronously and the non-cooperative process resumes execution as -soon as manager executes read(). The userfaultfd manager should -carefully synchronize calls to UFFDIO_COPY with the events -processing. To aid the synchronization, the UFFDIO_COPY ioctl will -return -ENOSPC when the monitored process exits at the time of -UFFDIO_COPY, and -ENOENT, when the non-cooperative process has changed -its virtual memory layout simultaneously with outstanding UFFDIO_COPY +soon as manager executes read(). The ``userfaultfd`` manager should +carefully synchronize calls to ``UFFDIO_COPY`` with the events +processing. To aid the synchronization, the ``UFFDIO_COPY`` ioctl will +return ``-ENOSPC`` when the monitored process exits at the time of +``UFFDIO_COPY``, and ``-ENOENT``, when the non-cooperative process has changed +its virtual memory layout simultaneously with outstanding ``UFFDIO_COPY`` operation. The current asynchronous model of the event delivery is optimal for -single threaded non-cooperative userfaultfd manager implementations. A +single threaded non-cooperative ``userfaultfd`` manager implementations. A synchronous event delivery model can be added later as a new -userfaultfd feature to facilitate multithreading enhancements of the -non cooperative manager, for example to allow UFFDIO_COPY ioctls to +``userfaultfd`` feature to facilitate multithreading enhancements of the +non cooperative manager, for example to allow ``UFFDIO_COPY`` ioctls to run in parallel to the event reception. Single threaded implementations should continue to use the current async event delivery model instead.
Signature · 1 line
2.25.2
PATCH 1/35 MAINTAINERS: dt: update display/allwinner file entry
In reply to Mauro Carvalho ChehabChangeset f5a98bfe7b37 ("dt-bindings: display: Convert Allwinner display pipeline to schemas") split Documentation/devicetree/bindings/display/sunxi/sun4i-drm.txt
into several files. Yet, it kept the old place at MAINTAINERS.
Update it to point to the new place.
--- MAINTAINERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -1
@@ -5573,7 +5573,7 @@ M: Chen-Yu Tsai <[email protected]> L: [email protected] S: Supported F: drivers/gpu/drm/sun4i/ -F: Documentation/devicetree/bindings/display/sunxi/sun4i-drm.txt +F: Documentation/devicetree/bindings/display/allwinner* T: git git://anongit.freedesktop.org/drm/drm-misc DRM DRIVER FOR ALLWINNER DE2 AND DE3 ENGINE
Signature · 1 line
2.25.2
PATCH 20/35 docs: scripts/kernel-doc: accept blank lines on parameter description
In reply to Mauro Carvalho ChehabSphinx is very pedantic with respect to blank lines. Sometimes, in order to make it to properly handle something, we need to add a blank line. However, currently, any blank line inside a kernel-doc comment like:
/*
* @foo: bar
*
* foobar
*
* some descriptionwill be considered as if "foobar" was part of the description.
This patch changes kernel-doc behavior. After it, foobar will be considered as part of the parameter text. The description will only be considered as such if it starts with:
zero spaces after asterisk:
*foo
one space after asterisk:
* foo
or have a explicit Description section:
* Description:
--- scripts/kernel-doc | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-)
scripts/kernel-doc +23 -12
@@ -331,13 +331,14 @@ my $lineprefix=""; # Parser states use constant { - STATE_NORMAL => 0, # normal code - STATE_NAME => 1, # looking for function name - STATE_BODY_MAYBE => 2, # body - or maybe more description - STATE_BODY => 3, # the body of the comment - STATE_PROTO => 4, # scanning prototype - STATE_DOCBLOCK => 5, # documentation block - STATE_INLINE => 6, # gathering documentation outside main block + STATE_NORMAL => 0, # normal code + STATE_NAME => 1, # looking for function name + STATE_BODY_MAYBE => 2, # body - or maybe more description + STATE_BODY => 3, # the body of the comment + STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line + STATE_PROTO => 5, # scanning prototype + STATE_DOCBLOCK => 6, # documentation block + STATE_INLINE => 7, # gathering doc outside main block }; my $state; my $in_doc_sect;
@@ -1957,6 +1958,12 @@ sub process_body($$) { } } + if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) { + dump_section($file, $section, $contents); + $section = $section_default; + $contents = ""; + } + if (/$doc_sect/i) { # case insensitive for supported section names $newsection = $1; $newcontents = $2;
@@ -2010,18 +2017,21 @@ sub process_body($$) { $state = STATE_PROTO; $brcount = 0; } elsif (/$doc_content/) { - # miguel-style comment kludge, look for blank lines after - # @parameter line to signify start of description if ($1 eq "") { - if ($section =~ m/^@/ || $section eq $section_context) { + if ($section eq $section_context) { dump_section($file, $section, $contents); $section = $section_default; $contents = ""; $new_start_line = $.; + $state = STATE_BODY; } else { + if ($section ne $section_default) { + $state = STATE_BODY_WITH_BLANK_LINE; + } else { + $state = STATE_BODY; + } $contents .= "\n"; } - $state = STATE_BODY; } elsif ($state == STATE_BODY_MAYBE) { # Continued declaration purpose chomp($declaration_purpose);
@@ -2173,7 +2183,8 @@ sub process_file($) { process_normal(); } elsif ($state == STATE_NAME) { process_name($file, $_); - } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE) { + } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE || + $state == STATE_BODY_WITH_BLANK_LINE) { process_body($file, $_); } elsif ($state == STATE_INLINE) { # scanning for inline parameters process_inline($file, $_);
Signature · 1 line
2.25.2
PATCH 33/35 docs: i2c: rename i2c.svg to i2c_bus.svg
In reply to Mauro Carvalho ChehabWhen generating the PDF output, the Documentation/i2c dir will generate an i2c.pdf. The same happens with i2c.svg:
it will also produce a file with the same name, at the same dir.
This causes errors when building the PDF output. So, rename the image to i2c_bus.svg.
---
Documentation/i2c/{i2c.svg => i2c_bus.svg} | 2 +-
Documentation/i2c/summary.rst | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
rename Documentation/i2c/{i2c.svg => i2c_bus.svg} (99%)Documentation/i2c/i2c_bus.svg renamed from Documentation/i2c/i2c.svg +1 -1
@@ -9,7 +9,7 @@ xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - sodipodi:docname="i2c.svg" + sodipodi:docname="i2c_bus.svg" inkscape:version="0.92.3 (2405546, 2018-03-11)" version="1.1" id="svg2"
Documentation/i2c/summary.rst +1 -1
@@ -34,7 +34,7 @@ Terminology Using the terminology from the official documentation, the I2C bus connects one or more *master* chips and one or more *slave* chips. -.. kernel-figure:: i2c.svg +.. kernel-figure:: i2c_bus.svg :alt: Simple I2C bus with one master and 3 slaves Simple I2C bus
Signature · 1 line
2.25.2
PATCH 30/35 docs: dt: fix a broken reference for a file converted to json
In reply to Mauro Carvalho ChehabChangeset 32ced09d7903 ("dt-bindings: serial: Convert slave-device bindings to json-schema") moved a binding to json and updated the links. Yet, one link
was forgotten.
Update this one too.
--- Documentation/devicetree/bindings/net/qualcomm-bluetooth.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/net/qualcomm-bluetooth.txt +1 -1
@@ -30,7 +30,7 @@ Required properties for compatible string qcom,wcn399x-bt: Optional properties for compatible string qcom,wcn399x-bt: - - max-speed: see Documentation/devicetree/bindings/serial/slave-device.txt + - max-speed: see Documentation/devicetree/bindings/serial/serial.yaml - firmware-name: specify the name of nvm firmware to load - clocks: clock provided to the controller
Signature · 1 line
2.25.2
PATCH 22/35 docs: drivers: fix some warnings at base/platform.c when building docs
In reply to Mauro Carvalho ChehabCurrrently, two warnings are generated when building docs:
./drivers/base/platform.c:136: WARNING: Unexpected indentation. ./drivers/base/platform.c:214: WARNING: Unexpected indentation.
As examples are code blocks, they should use "::" markup. However,
Example::
Is currently interpreted as a new section.
While we could fix kernel-doc to accept such new syntax, it is easier to just replace it with:
For Example::
--- drivers/base/platform.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/base/platform.c +4 -2
@@ -147,7 +147,8 @@ EXPORT_SYMBOL_GPL(devm_platform_ioremap_resource_byname);* request_irq() APIs. This is the same as platform_get_irq(), except that it * does not print an error message if an IRQ can not be obtained. * -* Example: +* For example:: +* * int irq = platform_get_irq_optional(pdev, 0); * if (irq < 0) * return irq;
@@ -226,7 +227,8 @@ EXPORT_SYMBOL_GPL(platform_get_irq_optional);* IRQ fails. Device drivers should check the return value for errors so as to * not pass a negative integer value to the request_irq() APIs. * -* Example: +* For example:: +* * int irq = platform_get_irq(pdev, 0); * if (irq < 0) * return irq;
Signature · 1 line
2.25.2
PATCH 23/35 docs: fusion: mptbase.c: get rid of a doc build warning
In reply to Mauro Carvalho ChehabUse a table for the enum list, to avoid this warning:
./drivers/message/fusion/mptbase.c:5058: WARNING: Definition list ends without a blank line; unexpected unindent.
--- drivers/message/fusion/mptbase.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
drivers/message/fusion/mptbase.c +5 -3
@@ -5052,9 +5052,11 @@ GetLanConfigPages(MPT_ADAPTER *ioc)* @ioc: Pointer to MPT_ADAPTER structure * @persist_opcode: see below * -* MPI_SAS_OP_CLEAR_NOT_PRESENT - Free all persist TargetID mappings for -* devices not currently present. -* MPI_SAS_OP_CLEAR_ALL_PERSISTENT - Clear al persist TargetID mappings +* =============================== ====================================== +* MPI_SAS_OP_CLEAR_NOT_PRESENT Free all persist TargetID mappings for +* devices not currently present. +* MPI_SAS_OP_CLEAR_ALL_PERSISTENT Clear al persist TargetID mappings +* =============================== ====================================== * * NOTE: Don't use not this function during interrupt time. *
Signature · 1 line
2.25.2
PATCH 26/35 docs: mm: userfaultfd.rst: use a cross-reference for a section
In reply to Mauro Carvalho ChehabInstead of using "foo", let's use foo_, with is a ReST way of saying that foo is a section of the document. With that, after building the docs, an hyperlink is generated.
--- Documentation/admin-guide/mm/userfaultfd.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/mm/userfaultfd.rst +1 -1
@@ -79,7 +79,7 @@ or shared memory need to set the corresponding flag in If the userland desires to receive notifications for events other than page faults, it has to verify that ``uffdio_api.features`` has appropriate ``UFFD_FEATURE_EVENT_*`` bits set. These events are described in more -detail below in "Non-cooperative userfaultfd" section. +detail below in `Non-cooperative userfaultfd`_ section. Once the ``userfaultfd`` has been enabled the ``UFFDIO_REGISTER`` ioctl should be invoked (if present in the returned ``uffdio_api.ioctls`` bitmask) to
Signature · 1 line
2.25.2
PATCH 34/35 docs: Makefile: place final pdf docs on a separate dir
In reply to Mauro Carvalho ChehabThe Sphinx build system for PDF is too complex and generate lots of ancillary files, including one PDF file for each image.
So, at the end, the main latex dir has 156 pdf files, instead of the 71 ones that would match each generated book. That's confusing and it makes harder to identify when something didn't work.
So, instead, let's move the final PDF output(s) to a separate dir. This way, the latex/ dir will have the temporary and the final *.tex files, while the final pdf files that built ok will be under the pdf/ directory.
--- Documentation/Makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
Documentation/Makefile +5 -1
@@ -98,7 +98,11 @@ else # HAVE_PDFLATEX pdfdocs: latexdocs @$(srctree)/scripts/sphinx-pre-install --version-check - $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit;) + $(foreach var,$(SPHINXDIRS), \ + $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \ + mkdir -p $(BUILDDIR)/$(var)/pdf; \ + mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \ + ) endif # HAVE_PDFLATEX
Signature · 1 line
2.25.2
PATCH 19/35 docs: infiniband: verbs.c: fix some documentation warnings
In reply to Mauro Carvalho ChehabParsing this file with kernel-doc produce some warnings:
./drivers/infiniband/core/verbs.c:2579: WARNING: Unexpected indentation. ./drivers/infiniband/core/verbs.c:2581: WARNING: Block quote ends without a blank line; unexpected unindent. ./drivers/infiniband/core/verbs.c:2613: WARNING: Unexpected indentation. ./drivers/infiniband/core/verbs.c:2579: WARNING: Unexpected indentation. ./drivers/infiniband/core/verbs.c:2581: WARNING: Block quote ends without a blank line; unexpected unindent. ./drivers/infiniband/core/verbs.c:2613: WARNING: Unexpected indentation.
Address them by adding an extra blank line and converting the parameters on one of the arguments to a table.
--- drivers/infiniband/core/verbs.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
drivers/infiniband/core/verbs.c +5 -2
@@ -2574,6 +2574,7 @@ EXPORT_SYMBOL(ib_map_mr_sg_pi);* @page_size: page vector desired page size * * Constraints: +* * - The first sg element is allowed to have an offset. * - Each sg element must either be aligned to page_size or virtually * contiguous to the previous element. In case an sg element has a
@@ -2607,10 +2608,12 @@ EXPORT_SYMBOL(ib_map_mr_sg);* @mr: memory region * @sgl: dma mapped scatterlist * @sg_nents: number of entries in sg -* @sg_offset_p: IN: start offset in bytes into sg -* OUT: offset in bytes for element n of the sg of the first +* @sg_offset_p: ==== ======================================================= +* IN start offset in bytes into sg +* OUT offset in bytes for element n of the sg of the first * byte that has not been processed where n is the return * value of this function. +* ==== ======================================================= * @set_page: driver page assignment function pointer * * Core service helper for drivers to convert the largest
Signature · 1 line
2.25.2
PATCH 32/35 docs: LaTeX/PDF: drop list of documents
In reply to Mauro Carvalho ChehabThe building system can auto-generate a list of documents since
commit: 9d42afbe6bd4 ("docs: pdf: add all Documentation/*/index.rst to PDF output").
The added logic there allows keeping the existing list, but there's not real reason to keep it. Now, the media document has gone (it was split into tree).
So, it sounds about time to get rid of the manual entries, and let the script to generate it automatically instead.
--- Documentation/conf.py | 38 -------------------------------------- 1 file changed, 38 deletions(-)
Documentation/conf.py +0 -38
@@ -388,44 +388,6 @@ if major == 1 and minor < 6: # author, documentclass [howto, manual, or own class]). # Sorted in alphabetical order latex_documents = [ - ('admin-guide/index', 'linux-user.tex', 'Linux Kernel User Documentation', - 'The kernel development community', 'manual'), - ('core-api/index', 'core-api.tex', 'The kernel core API manual', - 'The kernel development community', 'manual'), - ('crypto/index', 'crypto-api.tex', 'Linux Kernel Crypto API manual', - 'The kernel development community', 'manual'), - ('dev-tools/index', 'dev-tools.tex', 'Development tools for the Kernel', - 'The kernel development community', 'manual'), - ('doc-guide/index', 'kernel-doc-guide.tex', 'Linux Kernel Documentation Guide', - 'The kernel development community', 'manual'), - ('driver-api/index', 'driver-api.tex', 'The kernel driver API manual', - 'The kernel development community', 'manual'), - ('filesystems/index', 'filesystems.tex', 'Linux Filesystems API', - 'The kernel development community', 'manual'), - ('admin-guide/ext4', 'ext4-admin-guide.tex', 'ext4 Administration Guide', - 'ext4 Community', 'manual'), - ('filesystems/ext4/index', 'ext4-data-structures.tex', - 'ext4 Data Structures and Algorithms', 'ext4 Community', 'manual'), - ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide', - 'The kernel development community', 'manual'), - ('input/index', 'linux-input.tex', 'The Linux input driver subsystem', - 'The kernel development community', 'manual'), - ('kernel-hacking/index', 'kernel-hacking.tex', 'Unreliable Guide To Hacking The Linux Kernel', - 'The kernel development community', 'manual'), - ('media/index', 'media.tex', 'Linux Media Subsystem Documentation', - 'The kernel development community', 'manual'), - ('networking/index', 'networking.tex', 'Linux Networking Documentation', - 'The kernel development community', 'manual'), - ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation', - 'The kernel development community', 'manual'), - ('security/index', 'security.tex', 'The kernel security subsystem manual', - 'The kernel development community', 'manual'), - ('sh/index', 'sh.tex', 'SuperH architecture implementation manual', - 'The kernel development community', 'manual'), - ('sound/index', 'sound.tex', 'Linux Sound Subsystem Documentation', - 'The kernel development community', 'manual'), - ('userspace-api/index', 'userspace-api.tex', 'The Linux kernel user-space API guide', - 'The kernel development community', 'manual'), ] # Add all other index files from Documentation/ subdirectories
Signature · 1 line
2.25.2
PATCH 35/35 docs: update recommended Sphinx version to 2.4.4
In reply to Mauro Carvalho ChehabThere are some docs that have nested tables. While this was always part of the spec, only Sphinx version 2.4.x can translate it to LaTeX.
In other words, if someone is using a Sphinx version < 2.4, the LaTeX and PDF output won't work for some of the docs.
So, it seems that it is time to raise the bar again for the recommented version.
The Sphinx check script is already smart enough to keep working, with older versions, warning the users that an upgrade is recommended (and explaining how):
Sphinx version 1.7.9
Warning: It is recommended at least Sphinx version 2.4.4. Detected OS: Fedora release 31 (Thirty One).
To upgrade Sphinx, use:
/usr/bin/virtualenv sphinx_2.4.4
. sphinx_2.4.4/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt
--- Documentation/sphinx/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/sphinx/requirements.txt +1 -1
@@ -1,3 +1,3 @@ docutils -Sphinx==1.7.9 +Sphinx==2.4.4 sphinx_rtd_theme
Signature · 1 line
2.25.2
PATCH 17/35 docs: watch_queue.rst: supress some Sphinx warnings
In reply to Mauro Carvalho ChehabSphinx doesn't like multi-line literal blocks with ``foobar``:
Documentation/watch_queue.rst:109: WARNING: Inline literal start-string without end-string. Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:186: WARNING: Inline literal start-string without end-string. Documentation/watch_queue.rst:186: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:185: WARNING: Inline emphasis start-string without end-string.
So, let's use the "::" markup instead.
While we could do the fix only at the affected lines, let's do the same change along the entire file, in order to preserve the same look and feel at the entire doc.
--- Documentation/watch_queue.rst | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-)
Documentation/watch_queue.rst +25 -9
@@ -105,15 +105,19 @@ watch that specific key). To manage a watch list, the following functions are provided: - * ``void init_watch_list(struct watch_list *wlist, - void (*release_watch)(struct watch *wlist));`` + * :: + + void init_watch_list(struct watch_list *wlist, + void (*release_watch)(struct watch *wlist)); Initialise a watch list. If ``release_watch`` is not NULL, then this indicates a function that should be called when the watch_list object is destroyed to discard any references the watch list holds on the watched object. - * ``void remove_watch_list(struct watch_list *wlist);`` + * :: + + void remove_watch_list(struct watch_list *wlist); This removes all of the watches subscribed to a watch_list and frees them and then destroys the watch_list object itself.
@@ -127,14 +131,18 @@ records will be written into. The workings of this are hidden entirely inside of the watch_queue device driver, but it is necessary to gain a reference to it to set a watch. These can be managed with: - * ``struct watch_queue *get_watch_queue(int fd);`` + * :: + + struct watch_queue *get_watch_queue(int fd);`` Since watch queues are indicated to the kernel by the fd of the pipe that implements the buffer, userspace must hand that fd through a system call. This can be used to look up an opaque pointer to the watch queue from the system call. - * ``void put_watch_queue(struct watch_queue *wqueue);`` + * :: + + void put_watch_queue(struct watch_queue *wqueue); This discards the reference obtained from ``get_watch_queue()``.
@@ -170,18 +178,24 @@ different ID are ignored. The following functions are provided to manage watches: - * ``void init_watch(struct watch *watch, struct watch_queue *wqueue);`` + * :: + + void init_watch(struct watch *watch, struct watch_queue *wqueue); Initialise a watch object, setting its pointer to the watch queue, using appropriate barriering to avoid lockdep complaints. - * ``int add_watch_to_object(struct watch *watch, struct watch_list *wlist);`` + * :: + + int add_watch_to_object(struct watch *watch, struct watch_list *wlist); Subscribe a watch to a watch list (notification source). The driver-settable fields in the watch struct must have been set before this is called. - * ``int remove_watch_from_object(struct watch_list *wlist, + * :: + + int remove_watch_from_object(struct watch_list *wlist, struct watch_queue *wqueue, u64 id, false);``
@@ -190,7 +204,9 @@ The following functions are provided to manage watches: (``WATCH_META_REMOVAL_NOTIFICATION``) is sent to the watch queue to indicate that the watch got removed. - * ``int remove_watch_from_object(struct watch_list *wlist, NULL, 0, true);`` + * :: + + int remove_watch_from_object(struct watch_list *wlist, NULL, 0, true); Remove all the watches from a watch list. It is expected that this will be called preparatory to destruction and that the watch list will be
Signature · 1 line
2.25.2
PATCH 27/35 docs: vm: index.rst: add an orphan doc to the building system
In reply to Mauro Carvalho ChehabThe new free_page_reporting.rst file is not listed at the index.
--- Documentation/vm/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/vm/index.rst +1 -0
@@ -31,6 +31,7 @@ descriptions of data structures and algorithms. active_mm balance cleancache + free_page_reporting frontswap highmem hmm
Signature · 1 line
2.25.2
PATCH 16/35 docs: ras: don't need to repeat twice the same thing
In reply to Mauro Carvalho ChehabWe don't need to say twice "for the first time" at the same paragraph.
--- Documentation/admin-guide/ras.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/ras.rst +1 -1
@@ -212,7 +212,7 @@ EDAC - Error Detection And Correction purposes. When the subsystem was pushed upstream for the first time, on - Kernel 2.6.16, for the first time, it was renamed to ``EDAC``. + Kernel 2.6.16, it was renamed to ``EDAC``. Purpose -------
Signature · 1 line
2.25.2
PATCH 29/35 MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealView
In reply to Mauro Carvalho ChehabThere's a conversion from a plain text binding file into 4 yaml ones. The old file got removed, causing this new warning:
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/arm/arm-boards
Address it by replacing the old reference by the new ones
--- MAINTAINERS | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
MAINTAINERS +4 -1
@@ -1296,7 +1296,10 @@ ARM INTEGRATOR, VERSATILE AND REALVIEW SUPPORT M: Linus Walleij <[email protected]> L: [email protected] (moderated for non-subscribers) S: Maintained -F: Documentation/devicetree/bindings/arm/arm-boards +F: Documentation/devicetree/bindings/arm/arm,integrator.yaml +F: Documentation/devicetree/bindings/arm/arm,realview.yaml +F: Documentation/devicetree/bindings/arm/arm,versatile.yaml +F: Documentation/devicetree/bindings/arm/arm,vexpress-juno.yaml F: Documentation/devicetree/bindings/auxdisplay/arm-charlcd.txt F: Documentation/devicetree/bindings/clock/arm,syscon-icst.yaml F: Documentation/devicetree/bindings/i2c/i2c-versatile.txt
Signature · 1 line
2.25.2
PATCH 18/35 scripts: kernel-doc: accept negation like !@var
In reply to Mauro Carvalho ChehabOn a few places, it sometimes need to indicate a negation of a parameter, like:
!@fshared
This pattern happens, for example, at:
kernel/futex.c
and it is perfectly valid. However, kernel-doc currently transforms it into:
!**fshared**
This won't do what it would be expected.
Fortunately, fixing the script is a simple matter of storing the "!" before "@" and adding it after the bold markup, like:
**!fshared**
--- scripts/kernel-doc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
scripts/kernel-doc +3 -1
@@ -213,6 +213,7 @@ my $type_constant = '\b``([^\`]+)``\b'; my $type_constant2 = '\%([-_\w]+)'; my $type_func = '(\w+)\(\)'; my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; +my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params my $type_env = '(\$\w+)';
@@ -237,6 +238,7 @@ my @highlights_man = ( [$type_typedef, "\\\\fI\$1\\\\fP"], [$type_union, "\\\\fI\$1\\\\fP"], [$type_param, "\\\\fI\$1\\\\fP"], + [$type_param_ref, "\\\\fI\$1\$2\\\\fP"], [$type_member, "\\\\fI\$1\$2\$3\\\\fP"], [$type_fallback, "\\\\fI\$1\\\\fP"] );
@@ -258,7 +260,7 @@ my @highlights_rst = ( [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], # in rst this can refer to any type [$type_fallback, "\\:c\\:type\\:`\$1`"], - [$type_param, "**\$1**"] + [$type_param_ref, "**\$1\$2**"] ); my $blankline_rst = "\n";
Signature · 1 line
2.25.2
PATCH 15/35 docs: ras: get rid of some warnings
In reply to Mauro Carvalho ChehabSphinx produce some warnings due to a bad table format:
Documentation/admin-guide/ras.rst:358: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/admin-guide/ras.rst:358: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/admin-guide/ras.rst:363: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/admin-guide/ras.rst:363: WARNING: Definition list ends without a blank line; unexpected unindent.
Rearrange the things there in order to supress the warnings while being precise at the Sphinx output about how ranks are mapped into csrows.
--- Documentation/admin-guide/ras.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)
Documentation/admin-guide/ras.rst +9 -7
@@ -351,15 +351,17 @@ controllers. The following example will assume 2 channels: +------------+-----------+-----------+ | | ``ch0`` | ``ch1`` | +============+===========+===========+ - | ``csrow0`` | DIMM_A0 | DIMM_B0 | - | | rank0 | rank0 | - +------------+ - | - | + | |**DIMM_A0**|**DIMM_B0**| + +------------+-----------+-----------+ + | ``csrow0`` | rank0 | rank0 | + +------------+-----------+-----------+ | ``csrow1`` | rank1 | rank1 | +------------+-----------+-----------+ - | ``csrow2`` | DIMM_A1 | DIMM_B1 | - | | rank0 | rank0 | - +------------+ - | - | - | ``csrow3`` | rank1 | rank1 | + | |**DIMM_A1**|**DIMM_B1**| + +------------+-----------+-----------+ + | ``csrow2`` | rank0 | rank0 | + +------------+-----------+-----------+ + | ``csrow3`` | rank1 | rank1 | +------------+-----------+-----------+ In the above example, there are 4 physical slots on the motherboard
Signature · 1 line
2.25.2
PATCH 14/35 fs: inode.c: get rid of docs warnings
In reply to Mauro Carvalho ChehabUse *foo makes the toolchain to think that this is an emphasis, causing those warnings:
./fs/inode.c:1609: WARNING: Inline emphasis start-string without end-string. ./fs/inode.c:1609: WARNING: Inline emphasis start-string without end-string. ./fs/inode.c:1615: WARNING: Inline emphasis start-string without end-string.
So, use, instead, ``*foo``, in order to mark it as a literal block.
--- fs/inode.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
fs/inode.c +3 -3
@@ -1606,14 +1606,14 @@ EXPORT_SYMBOL(iput);* @inode: inode owning the block number being requested * @block: pointer containing the block to find * -* Replaces the value in *block with the block number on the device holding +* Replaces the value in ``*block`` with the block number on the device holding * corresponding to the requested block number in the file. * That is, asked for block 4 of inode 1 the function will replace the -* 4 in *block, with disk block relative to the disk start that holds that +* 4 in ``*block``, with disk block relative to the disk start that holds that * block of the file. * * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a -* hole, returns 0 and *block is also set to 0. +* hole, returns 0 and ``*block`` is also set to 0. */ int bmap (struct inode *inode,sector_t *block) {
Signature · 1 line
2.25.2
PATCH 12/35 lib: bitmap.c: get rid of some doc warnings
In reply to Mauro Carvalho ChehabThere are two ascii art drawings there. Use a block markup tag there in order to get rid of those warnings:
./lib/bitmap.c:189: WARNING: Unexpected indentation.
./lib/bitmap.c:190: WARNING: Block quote ends without a blank line; unexpected unindent. ./lib/bitmap.c:190: WARNING: Unexpected indentation.
./lib/bitmap.c:191: WARNING: Line block ends without a blank line.
It should be noticed that there's actually a syntax violation right now, as something like:
/** ... @src:
will be handled as a definition for @src parameter, and not as part of a diagram. So, we need to add something before it, in order for this to be processed the way it should.
--- lib/bitmap.c | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-)
lib/bitmap.c +14 -13
@@ -182,21 +182,22 @@ EXPORT_SYMBOL(__bitmap_shift_left);* * In pictures, example for a big-endian 32-bit architecture: * -* @src: -* 31 63 -* | | -* 10000000 11000001 11110010 00010101 10000000 11000001 01110010 00010101 -* | | | | -* 16 14 0 32 +* The @src bitmap is:: * -* if @cut is 3, and @first is 14, bits 14-16 in @src are cut and @dst is: +* 31 63 +* | | +* 10000000 11000001 11110010 00010101 10000000 11000001 01110010 00010101 +* | | | | +* 16 14 0 32 * -* 31 63 -* | | -* 10110000 00011000 00110010 00010101 00010000 00011000 00101110 01000010 -* | | | -* 14 (bit 17 0 32 -* from @src) +* if @cut is 3, and @first is 14, bits 14-16 in @src are cut and @dst is:: +* +* 31 63 +* | | +* 10110000 00011000 00110010 00010101 00010000 00011000 00101110 01000010 +* | | | +* 14 (bit 17 0 32 +* from @src) * * Note that @dst and @src might overlap partially or entirely. *
Signature · 1 line
2.25.2
PATCH 8/35 docs: pci: boot-interrupts.rst: improve html output
In reply to Mauro Carvalho ChehabThere are some warnings with this file:
/Documentation/PCI/boot-interrupts.rst:42: WARNING: Unexpected indentation. /Documentation/PCI/boot-interrupts.rst:52: WARNING: Block quote ends without a blank line; unexpected unindent. /Documentation/PCI/boot-interrupts.rst:92: WARNING: Unexpected indentation. /Documentation/PCI/boot-interrupts.rst:98: WARNING: Unexpected indentation. /Documentation/PCI/boot-interrupts.rst:136: WARNING: Unexpected indentation.
It turns that this file conversion to ReST could be improved, in order to remove the warnings and provide a better output.
So, fix the warnings by adjusting blank lines, add a table and some list markups. Also, mark endnodes as such.
--- Documentation/PCI/boot-interrupts.rst | 34 +++++++++++++++------------ 1 file changed, 19 insertions(+), 15 deletions(-)
Documentation/PCI/boot-interrupts.rst +19 -15
@@ -32,12 +32,13 @@ interrupt goes unhandled over time, they are tracked by the Linux kernel as Spurious Interrupts. The IRQ will be disabled by the Linux kernel after it reaches a specific count with the error "nobody cared". This disabled IRQ now prevents valid usage by an existing interrupt which may happen to share -the IRQ line. +the IRQ line:: irq 19: nobody cared (try booting with the "irqpoll" option) CPU: 0 PID: 2988 Comm: irq/34-nipalk Tainted: 4.14.87-rt49-02410-g4a640ec-dirty #1 Hardware name: National Instruments NI PXIe-8880/NI PXIe-8880, BIOS 2.1.5f1 01/09/2020 Call Trace: + <IRQ> ? dump_stack+0x46/0x5e ? __report_bad_irq+0x2e/0xb0
@@ -85,15 +86,18 @@ Mitigations The mitigations take the form of PCI quirks. The preference has been to first identify and make use of a means to disable the routing to the PCH. In such a case a quirk to disable boot interrupt generation can be -added.[1] +added. [1]_ - Intel® 6300ESB I/O Controller Hub +Intel® 6300ESB I/O Controller Hub Alternate Base Address Register: BIE: Boot Interrupt Enable - 0 = Boot interrupt is enabled. - 1 = Boot interrupt is disabled. - Intel® Sandy Bridge through Sky Lake based Xeon servers: + == =========================== + 0 Boot interrupt is enabled. + 1 Boot interrupt is disabled. + == =========================== + +Intel® Sandy Bridge through Sky Lake based Xeon servers: Coherent Interface Protocol Interrupt Control dis_intx_route2pch/dis_intx_route2ich/dis_intx_route2dmi2: When this bit is set. Local INTx messages received from the
@@ -109,12 +113,12 @@ line by default. Therefore, on chipsets where this INTx routing cannot be disabled, the Linux kernel will reroute the valid interrupt to its legacy interrupt. This redirection of the handler will prevent the occurrence of the spurious interrupt detection which would ordinarily disable the IRQ -line due to excessive unhandled counts.[2] +line due to excessive unhandled counts. [2]_ The config option X86_REROUTE_FOR_BROKEN_BOOT_IRQS exists to enable (or disable) the redirection of the interrupt handler to the PCH interrupt line. The option can be overridden by either pci=ioapicreroute or -pci=noioapicreroute.[3] +pci=noioapicreroute. [3]_ More Documentation
@@ -127,19 +131,19 @@ into the evolution of its handling with chipsets. Example of disabling of the boot interrupt ------------------------------------------ -Intel® 6300ESB I/O Controller Hub (Document # 300641-004US) + - Intel® 6300ESB I/O Controller Hub (Document # 300641-004US) 5.7.3 Boot Interrupt https://www.intel.com/content/dam/doc/datasheet/6300esb-io-controller-hub-datasheet.pdf -Intel® Xeon® Processor E5-1600/2400/2600/4600 v3 Product Families -Datasheet - Volume 2: Registers (Document # 330784-003) + - Intel® Xeon® Processor E5-1600/2400/2600/4600 v3 Product Families + Datasheet - Volume 2: Registers (Document # 330784-003) 6.6.41 cipintrc Coherent Interface Protocol Interrupt Control https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/xeon-e5-v3-datasheet-vol-2.pdf Example of handler rerouting ---------------------------- -Intel® 6700PXH 64-bit PCI Hub (Document # 302628) + - Intel® 6700PXH 64-bit PCI Hub (Document # 302628) 2.15.2 PCI Express Legacy INTx Support and Boot Interrupt https://www.intel.com/content/dam/doc/datasheet/6700pxh-64-bit-pci-hub-datasheet.pdf
@@ -150,6 +154,6 @@ Cheers, Sean V Kelley [email protected] -[1] https://lore.kernel.org/r/[email protected]/ -[2] https://lore.kernel.org/r/[email protected]/ -[3] https://lore.kernel.org/r/[email protected]/ +.. [1] https://lore.kernel.org/r/[email protected]/ +.. [2] https://lore.kernel.org/r/[email protected]/ +.. [3] https://lore.kernel.org/r/[email protected]/
Signature · 1 line
2.25.2
PATCH 2/35 docs: dt: fix broken reference to phy-cadence-torrent.yaml
In reply to Mauro Carvalho ChehabThis file was removed, and another file was added instead of it, on two separate commits.
Splitting a single logical change (doc conversion) on two patches is a bad thing, as it makes harder to discover what crap happened.
Anyway, this patch fixes the broken reference, making it pointing to the new location of the file.
--- Documentation/devicetree/bindings/phy/ti,phy-j721e-wiz.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/phy/ti,phy-j721e-wiz.yaml +1 -1
@@ -146,7 +146,7 @@ patternProperties: bindings specified in Documentation/devicetree/bindings/phy/phy-cadence-sierra.txt Torrent SERDES should follow the bindings specified in - Documentation/devicetree/bindings/phy/phy-cadence-dp.txt + Documentation/devicetree/bindings/phy/phy-cadence-torrent.yaml required: - compatible
Signature · 1 line
2.25.2
PATCH 13/35 ata: libata-core: fix a doc warning
In reply to Mauro Carvalho ChehabThe docs toolchain doesn't recognise this pattern:
@link->[hw_]sata_spd_limit
As it can't really process it. So, instead, let's mark it with a literal block markup:
``link->[hw_]sata_spd_limit``
in order to get rid of the following warning:
./drivers/ata/libata-core.c:5974: WARNING: Unknown target name: "hw".
--- drivers/ata/libata-core.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/ata/libata-core.c +1 -1
@@ -5209,7 +5209,7 @@ void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp)* sata_link_init_spd - Initialize link->sata_spd_limit * @link: Link to configure sata_spd_limit for * -* Initialize @link->[hw_]sata_spd_limit to the currently +* Initialize ``link->[hw_]sata_spd_limit`` to the currently * configured value. * * LOCKING:
Signature · 1 line
2.25.2
PATCH 10/35 firewire: firewire-cdev.hL get rid of a docs warning
In reply to Mauro Carvalho ChehabThis warning:
./include/uapi/linux/firewire-cdev.h:312: WARNING: Inline literal start-string without end-string.
is because %FOO doesn't work if there's a parenthesis at the string (as a parenthesis may indicate a function). So, mark the literal block using the alternate ``FOO`` syntax.
--- include/uapi/linux/firewire-cdev.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/uapi/linux/firewire-cdev.h +1 -1
@@ -308,7 +308,7 @@ struct fw_cdev_event_iso_interrupt_mc {/** * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed * @closure: See &fw_cdev_event_common; -* set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl +* set by``FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE)`` ioctl * @type: %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED * @handle: Reference by which an allocated resource can be deallocated
Signature · 1 line
2.25.2
PATCH 9/35 futex: get rid of a kernel-docs build warning
In reply to Mauro Carvalho ChehabAdjust whitespaces and blank lines in order to get rid of this:
./kernel/futex.c:491: WARNING: Definition list ends without a blank line; unexpected unindent.
--- kernel/futex.c | 3 +++ 1 file changed, 3 insertions(+)
kernel/futex.c +3 -0
@@ -486,10 +486,13 @@ static u64 get_inode_sequence_number(struct inode *inode)* The key words are stored in @key on success. * * For shared mappings (when @fshared), the key is: +* * ( inode->i_sequence, page->index, offset_within_page ) +* * [ also see get_inode_sequence_number() ] * * For private mappings (or when !@fshared), the key is: +* * ( current->mm, address, 0 ) * * This allows (cross process, where applicable) identification of the futex
Signature · 1 line
2.25.2
Mark Brown
maintainerRe: [PATCH 21/35] docs: spi: spi.h: fix a doc building warning
In reply to Mauro Carvalho ChehabQuoted 9 lines · Mauro Carvalho Chehab
We need to add a blank line to avoid this warning:
./include/linux/spi/spi.h:401: WARNING: Unexpected indentation.* @transfer_one: transfer a single
spi_transfer.
+ *
* - return 0 if the transfer is finished,
* - return 1 if the transfer is still in progress. When
* the driver is finished with this transfer it must
Are you sure this is a sensible fix? The following lines should be part of the documentation for transfer_one, will that be the case after your change?
Re: [PATCH 05/35] docs: filesystems: fix renamed references
In reply to Mauro Carvalho ChehabQuoted 4 lines · Mauro Carvalho Chehab
Some filesystem references got broken by a previous patch series I submitted. Address those.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
For
Quoted 1 line
fs/affs/Kconfig | 2 +-
Re: [PATCH 33/35] docs: i2c: rename i2c.svg to i2c_bus.svg
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
When generating the PDF output, the
Documentation/i2cdir will generate an i2c.pdf. The same happens with i2c.svg:
it will also produce a file with the same name, at the same dir.This causes errors when building the PDF output. So, rename the image to i2c_bus.svg.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
I assume the series goes in via the doc-tree, let me know if I should pick it.
Re: [PATCH 21/35] docs: spi: spi.h: fix a doc building warning
In reply to Mark BrownHi Mark,
Em Wed, 8 Apr 2020 16:49:25 +0100
Mark Brown <[email protected]> escreveu:
Quoted 11 lines · Mauro Carvalho Chehab
Quoted 9 lines
We need to add a blank line to avoid this warning:
./include/linux/spi/spi.h:401: WARNING: Unexpected indentation.* @transfer_one: transfer a single
spi_transfer.
+ *
* - return 0 if the transfer is finished,
* - return 1 if the transfer is still in progress. When
* the driver is finished with this transfer it must
Quoted 3 lines
Are you sure this is a sensible fix? The following lines should be part of the documentation for
transfer_one, will that be the case after your change?
Without that, Sphinx will warn and may produce something unexpected.
Yet, right now, kernel-doc is not prepared for the above change. When kernel-doc finds a blank line, it just assumes that the remaining content is part of the description. That is due to some laziness on its parser.
This is fixed by patch 20/35 on this series:
Subject: [PATCH 20/35] docs: scripts/kernel-doc: accept blank lines on parameter description
If this patch is applied after 20/25, the output should produce the correct result:
https://www.infradead.org/~mchehab/kernel_docs/driver-api/spi.html#spi-master-methods
Thanks,
Mauro
Re: [PATCH 21/35] docs: spi: spi.h: fix a doc building warning
Quoted 7 lines · Mauro Carvalho Chehab
Mark Brown <[email protected]> escreveu:
Quoted 3 lines
Are you sure this is a sensible fix? The following lines should be part of the documentation for
transfer_one, will that be the case after your change?Without that, Sphinx will warn and may produce something unexpected.
Right, but if the warning is telling us something useful we want to handle it rather than just shutting it up.
Quoted 4 lines
If this patch is applied after 20/25, the output should produce the correct result:
https://www.infradead.org/~mchehab/kernel_docs/driver-api/spi.html#spi-master-methods
OK.
Re: [PATCH 21/35] docs: spi: spi.h: fix a doc building warning
Em Wed, 8 Apr 2020 17:16:29 +0100
Mark Brown <[email protected]> escreveu:
Quoted 11 lines · Mauro Carvalho Chehab
Quoted 7 lines
Mark Brown <[email protected]> escreveu:
Quoted 3 lines
Are you sure this is a sensible fix? The following lines should be part of the documentation for
transfer_one, will that be the case after your change?Without that, Sphinx will warn and may produce something unexpected.
Right, but if the warning is telling us something useful we want to handle it rather than just shutting it up.
True. Without adding the blank line, kernel-doc would output this as:
``transfer_one``
transfer a single spi_transfer.
- return 0 if the transfer is finished,
- return 1 if the transfer is still in progress. When the driver is finished with this transfer it must call spi_finalize_current_transfer() so the subsystem can issue the next transfer. Note: transfer_one and transfer_one_message are mutually exclusive; when both are set, the generic subsystem does not call your transfer_one callback.
This would be parsed by Sphinx (newer versions) as if the second line:
transfer a single spi_transfer.
would be a sort of subtitle that should be highlighted with a vertical line before that. E. g. something equivalent to:
============
|transfer_one|
-------------------------------
|transfer a single spi_transfer.|
- return 0 if the transfer is finished,
- return 1 if the transfer is still in progress. When the driver is finished with this transfer it must call spi_finalize_current_transfer() so the subsystem can issue the next transfer. Note: transfer_one and transfer_one_message are mutually exclusive; when both are set, the generic subsystem does not call your transfer_one callback.
Which is not the desired result.
Adding a blank line after it fixes the issue, making it produce the expected output.
Quoted 9 lines
Quoted 5 lines
If this patch is applied after 20/25, the output should produce the correct result:
https://www.infradead.org/~mchehab/kernel_docs/driver-api/spi.html#spi-master-methods
OK.
Acked-by Mark Brown <[email protected]>
Thanks,
Mauro
Re: [PATCH 03/35] docs: fix broken references to text files
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
Several references got broken due to txt to ReST conversion.
Several of them can be automatically fixed with:
scripts/documentation-file-ref-check --fix
For the memory-barrier.txt portions:
Quoted 420 lines
--- Documentation/memory-barriers.txt | 2 +- Documentation/process/submit-checklist.rst | 2 +- .../translations/it_IT/process/submit-checklist.rst | 2 +- Documentation/translations/ko_KR/memory-barriers.txt | 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/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 ++-- arch/powerpc/include/uapi/asm/kvm_para.h | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/gpu/drm/drm_ioctl.c | 2 +- drivers/hwtracing/coresight/Kconfig | 2 +- fs/fat/Kconfig | 8 ++++---- fs/fuse/Kconfig | 2 +- fs/fuse/dev.c | 2 +- fs/overlayfs/Kconfig | 6 +++--- include/linux/mm.h | 4 ++-- include/uapi/linux/ethtool_netlink.h | 2 +- include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +- mm/gup.c | 12 ++++++------ virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +- virt/kvm/arm/vgic/vgic.h | 4 ++-- 23 files changed, 36 insertions(+), 36 deletions(-)Documentation/memory-barriers.txt +1
-1@@ -620,7 +620,7 @@ because the CPUs that the Linux kernel supports don't do writes until they are certain (1) that the write will actually happen, (2) of the location of the write, and (3) of the value to be written. But please carefully read the "CONTROL DEPENDENCIES" section and the -Documentation/RCU/rcu_dereference.txt file: The compiler can and does +Documentation/RCU/rcu_dereference.rst file: The compiler can and does break dependencies in a great many highly creative ways. CPU 1 CPU 2Documentation/process/submit-checklist.rst +1
-1@@ -107,7 +107,7 @@ and elsewhere regarding submitting Linux kernel patches. and why. 26) If any ioctl's are added by the patch, then also update - ``Documentation/ioctl/ioctl-number.rst``. + ``Documentation/userspace-api/ioctl/ioctl-number.rst``. 27) If your modified source code depends on or uses any of the kernel APIs or features that are related to the following ``Kconfig`` symbols,Documentation/translations/it_IT/process/submit-checklist.rst +1
-1@@ -117,7 +117,7 @@ sottomissione delle patch, in particolare sorgenti che ne spieghi la logica: cosa fanno e perché. 25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate - ``Documentation/ioctl/ioctl-number.rst``. + ``Documentation/userspace-api/ioctl/ioctl-number.rst``. 26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o funzionalità del kernel che è associata a uno dei seguenti simboliDocumentation/translations/ko_KR/memory-barriers.txt +1
-1@@ -641,7 +641,7 @@ P 는 짝수 번호 캐시 라인에 저장되어 있고, 변수 B 는 홀수 리눅스 커널이 지원하는 CPU 들은 (1) 쓰기가 정말로 일어날지, (2) 쓰기가 어디에 이루어질지, 그리고 (3) 쓰여질 값을 확실히 알기 전까지는 쓰기를 수행하지 않기 때문입니다. 하지만 "컨트롤 의존성" 섹션과 -Documentation/RCU/rcu_dereference.txt 파일을 주의 깊게 읽어 주시기 바랍니다: +Documentation/RCU/rcu_dereference.rst 파일을 주의 깊게 읽어 주시기 바랍니다: 컴파일러는 매우 창의적인 많은 방법으로 종속성을 깰 수 있습니다. CPU 1 CPU 2Documentation/translations/zh_CN/filesystems/sysfs.txt +1
-1@@ -281,7 +281,7 @@ drivers/ 包含了每个已为特定总线上的设备而挂载的驱动程序 假定驱动没有跨越多个总线类型)。 fs/ 包含了一个为文件系统设立的目录。现在每个想要导出属性的文件系统必须 -在 fs/ 下创建自己的层次结构(参见Documentation/filesystems/fuse.txt)。 +在 fs/ 下创建自己的层次结构(参见Documentation/filesystems/fuse.rst)。 dev/ 包含两个子目录: char/ 和 block/。在这两个子目录中,有以 <major>:<minor> 格式命名的符号链接。这些符号链接指向 sysfs 目录Documentation/translations/zh_CN/process/submit-checklist.rst +1
-1@@ -97,7 +97,7 @@ Linux内核补丁提交清单 24) 所有内存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要源代码中的注 释来解释它们正在执行的操作及其原因的逻辑。 -25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/ioctl/ioctl-number.rst`` +25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/userspace-api/ioctl/ioctl-number.rst`` 26) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或 功能,则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` (如果该选项可用)的情况Documentation/virt/kvm/arm/pvtime.rst +1
-1@@ -76,5 +76,5 @@ It is advisable that one or more 64k pages are set aside for the purpose of these structures and not used for other purposes, this enables the guest to map the region using 64k pages and avoids conflicting attributes with other memory. -For the user space interface see Documentation/virt/kvm/devices/vcpu.txt +For the user space interface see Documentation/virt/kvm/devices/vcpu.rst section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL".Documentation/virt/kvm/devices/vcpu.rst +1
-1@@ -110,5 +110,5 @@ Returns: Specifies the base address of the stolen time structure for this VCPU. The base address must be 64 byte aligned and exist within a valid guest memory -region. See Documentation/virt/kvm/arm/pvtime.txt for more information +region. See Documentation/virt/kvm/arm/pvtime.rst for more information including the layout of the stolen time structure.Documentation/virt/kvm/hypercalls.rst +2
-2@@ -22,7 +22,7 @@ S390: number in R1. For further information on the S390 diagnose call as supported by KVM, - refer to Documentation/virt/kvm/s390-diag.txt. + refer to Documentation/virt/kvm/s390-diag.rst. PowerPC: It uses R3-R10 and hypercall number in R11. R4-R11 are used as output registers.@@ -30,7 +30,7 @@ PowerPC: KVM hypercalls uses 4 byte opcode, that are patched with 'hypercall-instructions' property inside the device tree's /hypervisor node. - For more information refer to Documentation/virt/kvm/ppc-pv.txt + For more information refer to Documentation/virt/kvm/ppc-pv.rst MIPS: KVM hypercalls use the HYPCALL instruction with code 0 and the hypercallarch/powerpc/include/uapi/asm/kvm_para.h +1
-1@@ -31,7 +31,7 @@* Struct fields are always 32 or 64 bit aligned, depending on them being 32 * or 64 bit wide respectively. * -* See Documentation/virt/kvm/ppc-pv.txt +* See Documentation/virt/kvm/ppc-pv.rst */ struct kvm_vcpu_arch_shared {__u64 scratch1;drivers/gpu/drm/Kconfig +1
-1@@ -161,7 +161,7 @@ config DRM_LOAD_EDID_FIRMWARE monitor are unable to provide appropriate EDID data. Since this feature is provided as a workaround for broken hardware, the default case is N. Details and instructions how to build your own - EDID data are given in Documentation/driver-api/edid.rst. + EDID data are given in Documentation/admin-guide/edid.rst. config DRM_DP_CEC bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support"drivers/gpu/drm/drm_ioctl.c +1
-1@@ -741,7 +741,7 @@ static const struct drm_ioctl_desc drm_ioctls[] = {* }; * * Please make sure that you follow all the best practices from -* ``Documentation/ioctl/botching-up-ioctls.rst``. Note that drm_ioctl() +* ``Documentation/process/botching-up-ioctls.rst``. Note that drm_ioctl() * automatically zero-extends structures, hence make sure you can add more stuff * at the end, i.e. don't put a variable sized array there. * drivers/hwtracing/coresight/Kconfig +1
-1@@ -107,7 +107,7 @@ config CORESIGHT_CPU_DEBUG can quickly get to know program counter (PC), secure state, exception level, etc. Before use debugging functionality, platform needs to ensure the clock domain and power domain are enabled - properly, please refer Documentation/trace/coresight-cpu-debug.rst + properly, please refer Documentation/trace/coresight/coresight-cpu-debug.rst for detailed description and the example for usage. config CORESIGHT_CTIfs/fat/Kconfig +4
-4@@ -69,7 +69,7 @@ config VFAT_FS The VFAT support enlarges your kernel by about 10 KB and it only works if you said Y to the "DOS FAT fs support" above. Please read - the file <file:Documentation/filesystems/vfat.txt> for details. If + the file <file:Documentation/filesystems/vfat.rst> for details. If unsure, say Y. To compile this as a module, choose M here: the module will be called@@ -82,7 +82,7 @@ config FAT_DEFAULT_CODEPAGE help This option should be set to the codepage of your FAT filesystems. It can be overridden with the "codepage" mount option. - See <file:Documentation/filesystems/vfat.txt> for more information. + See <file:Documentation/filesystems/vfat.rst> for more information. config FAT_DEFAULT_IOCHARSET string "Default iocharset for FAT"@@ -96,7 +96,7 @@ config FAT_DEFAULT_IOCHARSET Note that "utf8" is not recommended for FAT filesystems. If unsure, you shouldn't set "utf8" here - select the next option instead if you would like to use UTF-8 encoded file names by default. - See <file:Documentation/filesystems/vfat.txt> for more information. + See <file:Documentation/filesystems/vfat.rst> for more information. Enable any character sets you need in File Systems/Native Language Support.@@ -114,4 +114,4 @@ config FAT_DEFAULT_UTF8 Say Y if you use UTF-8 encoding for file names, N otherwise. - See <file:Documentation/filesystems/vfat.txt> for more information. + See <file:Documentation/filesystems/vfat.rst> for more information.fs/fuse/Kconfig +1
-1@@ -12,7 +12,7 @@ config FUSE_FS although chances are your distribution already has that library installed if you've installed the "fuse" package itself. - See <file:Documentation/filesystems/fuse.txt> for more information. + See <file:Documentation/filesystems/fuse.rst> for more information. See <file:Documentation/Changes> for needed library/utility version. If you want to develop a userspace FS, or if you want to usefs/fuse/dev.c +1
-1@@ -2081,7 +2081,7 @@ static void end_polls(struct fuse_conn *fc)* The same effect is usually achievable through killing the filesystem daemon * and all users of the filesystem. The exception is the combination of an * asynchronous request and the tricky deadlock (see -* Documentation/filesystems/fuse.txt). +* Documentation/filesystems/fuse.rst). * * Aborting requests under I/O goes as follows: 1: Separate out unlocked * requests, they should be finished off immediately. Locked requests will be fs/overlayfs/Kconfig +3
-3@@ -9,7 +9,7 @@ config OVERLAY_FS 'lower' filesystem is either hidden or, in the case of directories, merged with the 'upper' object. - For more information see Documentation/filesystems/overlayfs.txt + For more information see Documentation/filesystems/overlayfs.rst config OVERLAY_FS_REDIRECT_DIR bool "Overlayfs: turn on redirect directory feature by default"@@ -38,7 +38,7 @@ config OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW If backward compatibility is not an issue, then it is safe and recommended to say N here. - For more information, see Documentation/filesystems/overlayfs.txt + For more information, see Documentation/filesystems/overlayfs.rst If unsure, say Y.@@ -103,7 +103,7 @@ config OVERLAY_FS_XINO_AUTO If compatibility with applications that expect 32bit inodes is not an issue, then it is safe and recommended to say Y here. - For more information, see Documentation/filesystems/overlayfs.txt + For more information, see Documentation/filesystems/overlayfs.rst If unsure, say N.include/linux/mm.h +2
-2@@ -1220,7 +1220,7 @@ void unpin_user_pages(struct page **pages, unsigned long npages);* used to track the pincount (instead using of the GUP_PIN_COUNTING_BIAS * scheme). * -* For more information, please see Documentation/vm/pin_user_pages.rst. +* For more information, please see Documentation/core-api/pin_user_pages.rst. * * @page: pointer to page to be queried. * @Return: True, if it is likely that the page has been "dma-pinned". @@ -2836,7 +2836,7 @@ struct page *follow_page(struct vm_area_struct *vma, unsigned long address,* releasing pages: get_user_pages*() pages must be released via put_page(), * while pin_user_pages*() pages must be released via unpin_user_page(). * -* Please see Documentation/vm/pin_user_pages.rst for more information. +* Please see Documentation/core-api/pin_user_pages.rst for more information. */ static inline int vm_fault_to_errno (vm_fault_t vm_fault,int foll_flags)include/uapi/linux/ethtool_netlink.h +1
-1@@ -2,7 +2,7 @@/* * include/uapi/linux/ethtool_netlink.h - netlink interface for ethtool * -* See Documentation/networking/ethtool-netlink.txt in kernel source tree for +* See Documentation/networking/ethtool-netlink.rst in kernel source tree for * doucumentation of the interface. */ include/uapi/rdma/rdma_user_ioctl_cmds.h +1
-1@@ -36,7 +36,7 @@#include <linux/types.h> #include <linux/ioctl.h> -/* Documentation/ioctl/ioctl-number.rst */ +/* Documentation/userspace-api/ioctl/ioctl-number.rst */ #define RDMA_IOCTL_MAGIC 0x1b#define RDMA_VERBS_IOCTL \ _IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)mm/gup.c +6
-6@@ -2840,9 +2840,9 @@ EXPORT_SYMBOL_GPL(get_user_pages_fast);* the arguments here are identical. * * FOLL_PIN means that the pages must be released via unpin_user_page(). Please -* see Documentation/vm/pin_user_pages.rst for further details. +* see Documentation/core-api/pin_user_pages.rst for further details. * -* This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It +* This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It * is NOT intended for Case 2 (RDMA: long-term pins). */ int pin_user_pages_fast(unsigned long start, int nr_pages,@@ -2880,9 +2880,9 @@ EXPORT_SYMBOL_GPL(pin_user_pages_fast);* the arguments here are identical. * * FOLL_PIN means that the pages must be released via unpin_user_page(). Please -* see Documentation/vm/pin_user_pages.rst for details. +* see Documentation/core-api/pin_user_pages.rst for details. * -* This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It +* This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It * is NOT intended for Case 2 (RDMA: long-term pins). */ long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,@@ -2916,9 +2916,9 @@ EXPORT_SYMBOL(pin_user_pages_remote);* FOLL_PIN is set. * * FOLL_PIN means that the pages must be released via unpin_user_page(). Please -* see Documentation/vm/pin_user_pages.rst for details. +* see Documentation/core-api/pin_user_pages.rst for details. * -* This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It +* This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It * is NOT intended for Case 2 (RDMA: long-term pins). */ long pin_user_pages(unsigned long start, unsigned long nr_pages,virt/kvm/arm/vgic/vgic-mmio-v3.c +1
-1@@ -301,7 +301,7 @@ static unsigned long vgic_v3_uaccess_read_pending(struct kvm_vcpu *vcpu,* pending state of interrupt is latched in pending_latch variable. * Userspace will save and restore pending state and line_level * separately. -* Refer to Documentation/virt/kvm/devices/arm-vgic-v3.txt +* Refer to Documentation/virt/kvm/devices/arm-vgic-v3.rst * for handling of ISPENDR and ICPENDR. */ for (i =0 ; i < len *8 ; i++) {virt/kvm/arm/vgic/vgic.h +2
-2@@ -42,7 +42,7 @@ VGIC_AFFINITY_LEVEL(val, 3))/* -* As per Documentation/virt/kvm/devices/arm-vgic-v3.txt, +* As per Documentation/virt/kvm/devices/arm-vgic-v3.rst, * below macros are defined for CPUREG encoding. */ #define KVM_REG_ARM_VGIC_SYSREG_OP0_MASK 0x000000000000c000@@ -63,7 +63,7 @@ KVM_REG_ARM_VGIC_SYSREG_OP2_MASK)/* -* As per Documentation/virt/kvm/devices/arm-vgic-its.txt, +* As per Documentation/virt/kvm/devices/arm-vgic-its.rst, * below macros are defined for ITS table entry encoding. */ #define KVM_ITS_CTE_VALID_SHIFT 63Signature · 1 line
2.25.2
Re: [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such
In reply to Mauro Carvalho ChehabQuoted 4 lines · Mauro Carvalho Chehab
The User API chapter contains two sub-chapters. Mark them as such.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thanks.
Though the other subsections in this file use ----- rather than ^^^^^, what's the difference?
Quoted 25 lines
--- Documentation/powerpc/cxl.rst | 2 ++ 1 file changed, 2 insertions(+)Documentation/powerpc/cxl.rst +2
-0@@ -133,6 +133,7 @@ User API ======== 1. AFU character devices +^^^^^^^^^^^^^^^^^^^^^^^^ For AFUs operating in AFU directed mode, two character device files will be created. /dev/cxl/afu0.0m will correspond to a@@ -395,6 +396,7 @@ read 2. Card character device (powerVM guest only) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In a powerVM guest, an extra character device is created for the card. The device is only used to write (flash) a new image on the
Signature · 2 lines
Andrew Donnellan OzLabs, ADL Canberra [email protected] IBM Australia Limited
Re: [PATCH 03/35] docs: fix broken references to text files
In reply to Mauro Carvalho ChehabQuoted 2 lines · Mauro Carvalho Chehab
.../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/process/submit-checklist.rst | 2 +-
It looks fine for me.
Re: [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such
In reply to Andrew DonnellanEm Thu, 9 Apr 2020 10:37:52 +1000
Andrew Donnellan <[email protected]> escreveu:
Quoted 10 lines · Mauro Carvalho Chehab
Quoted 4 lines
The User API chapter contains two sub-chapters. Mark them as such.
Signed-off-by Mauro Carvalho Chehab <[email protected]>Thanks.
Though the other subsections in this file use ----- rather than ^^^^^, what's the difference?
ReST syntax allows the usage of several different markup symbols for titles. It dynamically attributes the first one it finds as level 1, the second one as level 2 and so on.
As we added the "^^^^" markup before "-----", after this patch, it now has:
======= level 1 ======= level 2 ======= level 3 ^^^^^^^ level 4 -------
Quoted 22 lines
Acked-by Andrew Donnellan <[email protected]>Quoted 19 lines
--- Documentation/powerpc/cxl.rst | 2 ++ 1 file changed, 2 insertions(+)Documentation/powerpc/cxl.rst +1
-0@@ -133,6 +133,7 @@ User API ======== 1. AFU character devices +^^^^^^^^^^^^^^^^^^^^^^^^ For AFUs operating in AFU directed mode, two character device files will be created. /dev/cxl/afu0.0m will correspond to a@@ -395,6 +396,7 @@ read
Quoted 7 lines
Documentation/powerpc/cxl.rst read · line 402
Quoted 6 lines
Documentation/powerpc/cxl.rst +1
-02. Card character device (powerVM guest only) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In a powerVM guest, an extra character device is created for the card. The device is only used to write (flash) a new image on the
Thanks,
Mauro
Re: [PATCH 03/35] docs: fix broken references to text files
In reply to Mauro Carvalho ChehabQuoted 6 lines · CEST Mauro Carvalho Chehab
Several references got broken due to txt to ReST conversion.
Several of them can be automatically fixed with:
scripts/documentation-file-ref-check --fix
Quoted 7 lines
Reviewed-by Mathieu Poirier <[email protected]> #hwtracing/coresight/Kconfig Signed-off-by: Mauro Carvalho Chehab <[email protected]>
--- Documentation/memory-barriers.txt | 2 +- Documentation/process/submit-checklist.rst | 2 +- .../translations/it_IT/process/submit-checklist.rst | 2 +-
Re: [PATCH 28/35] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
In reply to Mauro Carvalho ChehabQuoting Mauro Carvalho Chehab (2020-04-08 08:46:20)
Quoted 6 lines
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")Signed-off-by Mauro Carvalho Chehab <[email protected]>---
Quoted 8 lines
Documentation/devicetree/bindings/usb/qcom,dwc3.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/devicetree/bindings/usb/qcom,dwc3.txt +0
-0
Documentation/devicetree/bindings/usb/qcom,dwc3.txt A child node must exist to represent the core DWC3 IP block. The name of · line 56
Quoted 7 lines
Documentation/devicetree/bindings/usb/qcom,dwc3.txt +2
-2@@ -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
It should probably be bindings/phy/<blah> so that when the bindings are taken out of the kernel context they'll still make sense, but that can be done later.
Re: [PATCH 03/35] docs: fix broken references to text files
In reply to Mauro Carvalho ChehabQuoted 4 lines · On Wed, 8 Apr 2020 17:45:55 +0200 Mauro Carvalho Chehab…
Several references got broken due to txt to ReST conversion.
Several of them can be automatically fixed with:
Quoted 8 lines
scripts/documentation-file-ref-check --fixSigned-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/virt/kvm/arm/pvtime.rst | 2 +- virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +- virt/kvm/arm/vgic/vgic.h | 4 ++--
M.
Signature · 1 line
Jazz is not dead. It just smells funny...
Re: [PATCH 30/35] docs: dt: fix a broken reference for a file converted to json
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
Changeset
32ced09d7903("dt-bindings: serial: Convert slave-device bindings to json-schema") moved a binding to json and updated the links. Yet, one link
was forgotten.Update this one too.
Fixes 32ced09d7903 ("dt-bindings: serial: Convert slave-device bindings to json-schema")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Yeah, Rob dropped that change from my patch to avoid a merge conflict.
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
Martin K. Petersen
AppliedRe: [PATCH 23/35] docs: fusion: mptbase.c: get rid of a doc build warning
In reply to Mauro Carvalho ChehabMauro,
Quoted 3 lines
Use a table for the enum list, to avoid this warning:
./drivers/message/fusion/mptbase.c:5058: WARNING: Definition list ends without a blank line; unexpected unindent.
Applied to 5.8/scsi-queue, thanks!
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering
Re: [PATCH 29/35] MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealView
In reply to Mauro Carvalho ChehabQuoted 5 lines · Mauro Carvalho Chehab
There's a conversion from a plain text binding file into 4 yaml ones. The old file got removed, causing this new warning:
Warning:
MAINTAINERSreferences a file that doesn't exist:Documentation/devicetree/bindings/arm/arm-boards
Quoted 8 lines
Address it by replacing the old reference by the new ones
Fixes 2d483550b6d2 ("dt-bindings: arm: Drop the non-YAML bindings")Fixes 33fbfb3eaf4e ("dt-bindings: arm: Add Integrator YAML schema")Fixes 4b900070d50d ("dt-bindings: arm: Add Versatile YAML schema")Fixes 7db625b9fa75 ("dt-bindings: arm: Add RealView YAML schema")Fixes 4fb00d9066c1 ("dt-bindings: arm: Add Versatile Express and Juno YAML schema")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Yours,
Linus Walleij
Re: [PATCH 29/35] MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealView
In reply to Mauro Carvalho ChehabQuoted 14 lines · Mauro Carvalho Chehab
There's a conversion from a plain text binding file into 4 yaml ones. The old file got removed, causing this new warning:
Warning:
MAINTAINERSreferences a file that doesn't exist:Documentation/devicetree/bindings/arm/arm-boardsAddress it by replacing the old reference by the new ones
Fixes 4b900070d50d ("dt-bindings: arm: Add Versatile YAML schema")Fixes 2d483550b6d2 ("dt-bindings: arm: Drop the non-YAML bindings")Fixes 7db625b9fa75 ("dt-bindings: arm: Add RealView YAML schema")Fixes 4fb00d9066c1 ("dt-bindings: arm: Add Versatile Express and Juno YAML schema")Fixes 33fbfb3eaf4e ("dt-bindings: arm: Add Integrator YAML schema")Signed-off-by Mauro Carvalho Chehab <[email protected]>Acked-by Linus Walleij <[email protected]>
Quoted 3 lines
--- MAINTAINERS | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
Applied.
Rob
Re: [PATCH 28/35] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
In reply to Mauro Carvalho ChehabQuoted 14 lines · Mauro Carvalho Chehab
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")Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/devicetree/bindings/usb/qcom,dwc3.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/devicetree/bindings/usb/qcom,dwc3.txt +0
-0
Documentation/devicetree/bindings/usb/qcom,dwc3.txt A child node must exist to represent the core DWC3 IP block. The name of · line 58
Quoted 9 lines
Documentation/devicetree/bindings/usb/qcom,dwc3.txt +2
-2@@ -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:
Should I take this or will it go via e.g. trivial?
In any case:
Signature · 1 line
balbi
Re: [PATCH 28/35] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
Quoted 25 lines · Felipe Balbi
Quoted 22 lines · Mauro Carvalho Chehab
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")Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/devicetree/bindings/usb/qcom,dwc3.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/devicetree/bindings/usb/qcom,dwc3.txt +2
-2@@ -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
Quoted 3 lines
Documentation/devicetree/bindings/usb/qcom,dwc3.txt A child node must exist to represent the core DWC3 IP block. The name of · line 58
Quoted 1 line
Documentation/devicetree/bindings/usb/qcom,dwc3.txt +0
-0Example device nodes:Should I take this or will it go via e.g. trivial?
I already queued up v2 of this.
Quoted 7 lines
In any case:
Acked-by Felipe Balbi <[email protected]>--
balbi