Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org> # hwtracing/coresight/Kconfig
Reviewed-by: Paul E. McKenney <paulmck@kernel.org> # memory-barrier.txt
Acked-by: Alex Shi <alex.shi@linux.alibaba.com> # translations/zh_CN
Acked-by: Federico Vaga <federico.vaga@vaga.pv.it> # translations/it_IT
Acked-by: Marc Zyngier <maz@kernel.org> # kvm/arm64
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/6f919ddb83a33b5f2a63b6b5f0575737bb2b36aa.1586881715.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
72ef5e52 f9faa908

+36 -36
+1 -1
Documentation/memory-barriers.txt
··· 620 620 until they are certain (1) that the write will actually happen, (2) 621 621 of the location of the write, and (3) of the value to be written. 622 622 But please carefully read the "CONTROL DEPENDENCIES" section and the 623 - Documentation/RCU/rcu_dereference.txt file: The compiler can and does 623 + Documentation/RCU/rcu_dereference.rst file: The compiler can and does 624 624 break dependencies in a great many highly creative ways. 625 625 626 626 CPU 1 CPU 2
+1 -1
Documentation/process/submit-checklist.rst
··· 107 107 and why. 108 108 109 109 26) If any ioctl's are added by the patch, then also update 110 - ``Documentation/ioctl/ioctl-number.rst``. 110 + ``Documentation/userspace-api/ioctl/ioctl-number.rst``. 111 111 112 112 27) If your modified source code depends on or uses any of the kernel 113 113 APIs or features that are related to the following ``Kconfig`` symbols,
+1 -1
Documentation/translations/it_IT/process/submit-checklist.rst
··· 117 117 sorgenti che ne spieghi la logica: cosa fanno e perché. 118 118 119 119 25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate 120 - ``Documentation/ioctl/ioctl-number.rst``. 120 + ``Documentation/userspace-api/ioctl/ioctl-number.rst``. 121 121 122 122 26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o 123 123 funzionalità del kernel che è associata a uno dei seguenti simboli
+1 -1
Documentation/translations/ko_KR/memory-barriers.txt
··· 641 641 리눅스 커널이 지원하는 CPU 들은 (1) 쓰기가 정말로 일어날지, (2) 쓰기가 어디에 642 642 이루어질지, 그리고 (3) 쓰여질 값을 확실히 알기 전까지는 쓰기를 수행하지 않기 643 643 때문입니다. 하지만 "컨트롤 의존성" 섹션과 644 - Documentation/RCU/rcu_dereference.txt 파일을 주의 깊게 읽어 주시기 바랍니다: 644 + Documentation/RCU/rcu_dereference.rst 파일을 주의 깊게 읽어 주시기 바랍니다: 645 645 컴파일러는 매우 창의적인 많은 방법으로 종속성을 깰 수 있습니다. 646 646 647 647 CPU 1 CPU 2
+1 -1
Documentation/translations/zh_CN/filesystems/sysfs.txt
··· 281 281 假定驱动没有跨越多个总线类型)。 282 282 283 283 fs/ 包含了一个为文件系统设立的目录。现在每个想要导出属性的文件系统必须 284 - 在 fs/ 下创建自己的层次结构(参见Documentation/filesystems/fuse.txt)。 284 + 在 fs/ 下创建自己的层次结构(参见Documentation/filesystems/fuse.rst)。 285 285 286 286 dev/ 包含两个子目录: char/ 和 block/。在这两个子目录中,有以 287 287 <major>:<minor> 格式命名的符号链接。这些符号链接指向 sysfs 目录
+1 -1
Documentation/translations/zh_CN/process/submit-checklist.rst
··· 97 97 24) 所有内存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要源代码中的注 98 98 释来解释它们正在执行的操作及其原因的逻辑。 99 99 100 - 25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/ioctl/ioctl-number.rst`` 100 + 25) 如果补丁添加了任何ioctl,那么也要更新 ``Documentation/userspace-api/ioctl/ioctl-number.rst`` 101 101 102 102 26) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或 103 103 功能,则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` (如果该选项可用)的情况
+1 -1
Documentation/virt/kvm/arm/pvtime.rst
··· 76 76 these structures and not used for other purposes, this enables the guest to map 77 77 the region using 64k pages and avoids conflicting attributes with other memory. 78 78 79 - For the user space interface see Documentation/virt/kvm/devices/vcpu.txt 79 + For the user space interface see Documentation/virt/kvm/devices/vcpu.rst 80 80 section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL".
+1 -1
Documentation/virt/kvm/devices/vcpu.rst
··· 110 110 111 111 Specifies the base address of the stolen time structure for this VCPU. The 112 112 base address must be 64 byte aligned and exist within a valid guest memory 113 - region. See Documentation/virt/kvm/arm/pvtime.txt for more information 113 + region. See Documentation/virt/kvm/arm/pvtime.rst for more information 114 114 including the layout of the stolen time structure.
+2 -2
Documentation/virt/kvm/hypercalls.rst
··· 22 22 number in R1. 23 23 24 24 For further information on the S390 diagnose call as supported by KVM, 25 - refer to Documentation/virt/kvm/s390-diag.txt. 25 + refer to Documentation/virt/kvm/s390-diag.rst. 26 26 27 27 PowerPC: 28 28 It uses R3-R10 and hypercall number in R11. R4-R11 are used as output registers. ··· 30 30 31 31 KVM hypercalls uses 4 byte opcode, that are patched with 'hypercall-instructions' 32 32 property inside the device tree's /hypervisor node. 33 - For more information refer to Documentation/virt/kvm/ppc-pv.txt 33 + For more information refer to Documentation/virt/kvm/ppc-pv.rst 34 34 35 35 MIPS: 36 36 KVM hypercalls use the HYPCALL instruction with code 0 and the hypercall
+1 -1
arch/powerpc/include/uapi/asm/kvm_para.h
··· 31 31 * Struct fields are always 32 or 64 bit aligned, depending on them being 32 32 32 * or 64 bit wide respectively. 33 33 * 34 - * See Documentation/virt/kvm/ppc-pv.txt 34 + * See Documentation/virt/kvm/ppc-pv.rst 35 35 */ 36 36 struct kvm_vcpu_arch_shared { 37 37 __u64 scratch1;
+1 -1
drivers/gpu/drm/Kconfig
··· 161 161 monitor are unable to provide appropriate EDID data. Since this 162 162 feature is provided as a workaround for broken hardware, the 163 163 default case is N. Details and instructions how to build your own 164 - EDID data are given in Documentation/driver-api/edid.rst. 164 + EDID data are given in Documentation/admin-guide/edid.rst. 165 165 166 166 config DRM_DP_CEC 167 167 bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support"
+1 -1
drivers/gpu/drm/drm_ioctl.c
··· 741 741 * }; 742 742 * 743 743 * Please make sure that you follow all the best practices from 744 - * ``Documentation/ioctl/botching-up-ioctls.rst``. Note that drm_ioctl() 744 + * ``Documentation/process/botching-up-ioctls.rst``. Note that drm_ioctl() 745 745 * automatically zero-extends structures, hence make sure you can add more stuff 746 746 * at the end, i.e. don't put a variable sized array there. 747 747 *
+1 -1
drivers/hwtracing/coresight/Kconfig
··· 107 107 can quickly get to know program counter (PC), secure state, 108 108 exception level, etc. Before use debugging functionality, platform 109 109 needs to ensure the clock domain and power domain are enabled 110 - properly, please refer Documentation/trace/coresight-cpu-debug.rst 110 + properly, please refer Documentation/trace/coresight/coresight-cpu-debug.rst 111 111 for detailed description and the example for usage. 112 112 113 113 config CORESIGHT_CTI
+4 -4
fs/fat/Kconfig
··· 69 69 70 70 The VFAT support enlarges your kernel by about 10 KB and it only 71 71 works if you said Y to the "DOS FAT fs support" above. Please read 72 - the file <file:Documentation/filesystems/vfat.txt> for details. If 72 + the file <file:Documentation/filesystems/vfat.rst> for details. If 73 73 unsure, say Y. 74 74 75 75 To compile this as a module, choose M here: the module will be called ··· 82 82 help 83 83 This option should be set to the codepage of your FAT filesystems. 84 84 It can be overridden with the "codepage" mount option. 85 - See <file:Documentation/filesystems/vfat.txt> for more information. 85 + See <file:Documentation/filesystems/vfat.rst> for more information. 86 86 87 87 config FAT_DEFAULT_IOCHARSET 88 88 string "Default iocharset for FAT" ··· 96 96 Note that "utf8" is not recommended for FAT filesystems. 97 97 If unsure, you shouldn't set "utf8" here - select the next option 98 98 instead if you would like to use UTF-8 encoded file names by default. 99 - See <file:Documentation/filesystems/vfat.txt> for more information. 99 + See <file:Documentation/filesystems/vfat.rst> for more information. 100 100 101 101 Enable any character sets you need in File Systems/Native Language 102 102 Support. ··· 114 114 115 115 Say Y if you use UTF-8 encoding for file names, N otherwise. 116 116 117 - See <file:Documentation/filesystems/vfat.txt> for more information. 117 + See <file:Documentation/filesystems/vfat.rst> for more information.
+1 -1
fs/fuse/Kconfig
··· 12 12 although chances are your distribution already has that library 13 13 installed if you've installed the "fuse" package itself. 14 14 15 - See <file:Documentation/filesystems/fuse.txt> for more information. 15 + See <file:Documentation/filesystems/fuse.rst> for more information. 16 16 See <file:Documentation/Changes> for needed library/utility version. 17 17 18 18 If you want to develop a userspace FS, or if you want to use
+1 -1
fs/fuse/dev.c
··· 2081 2081 * The same effect is usually achievable through killing the filesystem daemon 2082 2082 * and all users of the filesystem. The exception is the combination of an 2083 2083 * asynchronous request and the tricky deadlock (see 2084 - * Documentation/filesystems/fuse.txt). 2084 + * Documentation/filesystems/fuse.rst). 2085 2085 * 2086 2086 * Aborting requests under I/O goes as follows: 1: Separate out unlocked 2087 2087 * requests, they should be finished off immediately. Locked requests will be
+3 -3
fs/overlayfs/Kconfig
··· 9 9 'lower' filesystem is either hidden or, in the case of directories, 10 10 merged with the 'upper' object. 11 11 12 - For more information see Documentation/filesystems/overlayfs.txt 12 + For more information see Documentation/filesystems/overlayfs.rst 13 13 14 14 config OVERLAY_FS_REDIRECT_DIR 15 15 bool "Overlayfs: turn on redirect directory feature by default" ··· 38 38 If backward compatibility is not an issue, then it is safe and 39 39 recommended to say N here. 40 40 41 - For more information, see Documentation/filesystems/overlayfs.txt 41 + For more information, see Documentation/filesystems/overlayfs.rst 42 42 43 43 If unsure, say Y. 44 44 ··· 103 103 If compatibility with applications that expect 32bit inodes is not an 104 104 issue, then it is safe and recommended to say Y here. 105 105 106 - For more information, see Documentation/filesystems/overlayfs.txt 106 + For more information, see Documentation/filesystems/overlayfs.rst 107 107 108 108 If unsure, say N. 109 109
+2 -2
include/linux/mm.h
··· 1219 1219 * used to track the pincount (instead using of the GUP_PIN_COUNTING_BIAS 1220 1220 * scheme). 1221 1221 * 1222 - * For more information, please see Documentation/vm/pin_user_pages.rst. 1222 + * For more information, please see Documentation/core-api/pin_user_pages.rst. 1223 1223 * 1224 1224 * @page: pointer to page to be queried. 1225 1225 * @Return: True, if it is likely that the page has been "dma-pinned". ··· 2834 2834 * releasing pages: get_user_pages*() pages must be released via put_page(), 2835 2835 * while pin_user_pages*() pages must be released via unpin_user_page(). 2836 2836 * 2837 - * Please see Documentation/vm/pin_user_pages.rst for more information. 2837 + * Please see Documentation/core-api/pin_user_pages.rst for more information. 2838 2838 */ 2839 2839 2840 2840 static inline int vm_fault_to_errno(vm_fault_t vm_fault, int foll_flags)
+1 -1
include/uapi/linux/ethtool_netlink.h
··· 2 2 /* 3 3 * include/uapi/linux/ethtool_netlink.h - netlink interface for ethtool 4 4 * 5 - * See Documentation/networking/ethtool-netlink.txt in kernel source tree for 5 + * See Documentation/networking/ethtool-netlink.rst in kernel source tree for 6 6 * doucumentation of the interface. 7 7 */ 8 8
+1 -1
include/uapi/rdma/rdma_user_ioctl_cmds.h
··· 36 36 #include <linux/types.h> 37 37 #include <linux/ioctl.h> 38 38 39 - /* Documentation/ioctl/ioctl-number.rst */ 39 + /* Documentation/userspace-api/ioctl/ioctl-number.rst */ 40 40 #define RDMA_IOCTL_MAGIC 0x1b 41 41 #define RDMA_VERBS_IOCTL \ 42 42 _IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
+6 -6
mm/gup.c
··· 2843 2843 * the arguments here are identical. 2844 2844 * 2845 2845 * FOLL_PIN means that the pages must be released via unpin_user_page(). Please 2846 - * see Documentation/vm/pin_user_pages.rst for further details. 2846 + * see Documentation/core-api/pin_user_pages.rst for further details. 2847 2847 * 2848 - * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It 2848 + * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It 2849 2849 * is NOT intended for Case 2 (RDMA: long-term pins). 2850 2850 */ 2851 2851 int pin_user_pages_fast(unsigned long start, int nr_pages, ··· 2883 2883 * the arguments here are identical. 2884 2884 * 2885 2885 * FOLL_PIN means that the pages must be released via unpin_user_page(). Please 2886 - * see Documentation/vm/pin_user_pages.rst for details. 2886 + * see Documentation/core-api/pin_user_pages.rst for details. 2887 2887 * 2888 - * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It 2888 + * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It 2889 2889 * is NOT intended for Case 2 (RDMA: long-term pins). 2890 2890 */ 2891 2891 long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm, ··· 2919 2919 * FOLL_PIN is set. 2920 2920 * 2921 2921 * FOLL_PIN means that the pages must be released via unpin_user_page(). Please 2922 - * see Documentation/vm/pin_user_pages.rst for details. 2922 + * see Documentation/core-api/pin_user_pages.rst for details. 2923 2923 * 2924 - * This is intended for Case 1 (DIO) in Documentation/vm/pin_user_pages.rst. It 2924 + * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It 2925 2925 * is NOT intended for Case 2 (RDMA: long-term pins). 2926 2926 */ 2927 2927 long pin_user_pages(unsigned long start, unsigned long nr_pages,
+1 -1
virt/kvm/arm/vgic/vgic-mmio-v3.c
··· 301 301 * pending state of interrupt is latched in pending_latch variable. 302 302 * Userspace will save and restore pending state and line_level 303 303 * separately. 304 - * Refer to Documentation/virt/kvm/devices/arm-vgic-v3.txt 304 + * Refer to Documentation/virt/kvm/devices/arm-vgic-v3.rst 305 305 * for handling of ISPENDR and ICPENDR. 306 306 */ 307 307 for (i = 0; i < len * 8; i++) {
+2 -2
virt/kvm/arm/vgic/vgic.h
··· 42 42 VGIC_AFFINITY_LEVEL(val, 3)) 43 43 44 44 /* 45 - * As per Documentation/virt/kvm/devices/arm-vgic-v3.txt, 45 + * As per Documentation/virt/kvm/devices/arm-vgic-v3.rst, 46 46 * below macros are defined for CPUREG encoding. 47 47 */ 48 48 #define KVM_REG_ARM_VGIC_SYSREG_OP0_MASK 0x000000000000c000 ··· 63 63 KVM_REG_ARM_VGIC_SYSREG_OP2_MASK) 64 64 65 65 /* 66 - * As per Documentation/virt/kvm/devices/arm-vgic-its.txt, 66 + * As per Documentation/virt/kvm/devices/arm-vgic-its.rst, 67 67 * below macros are defined for ITS table entry encoding. 68 68 */ 69 69 #define KVM_ITS_CTE_VALID_SHIFT 63