From patchwork Tue Jun 18 21:05:25 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11002735 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id CF5A8112C for ; Tue, 18 Jun 2019 21:06:10 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BA49F212E8 for ; Tue, 18 Jun 2019 21:06:10 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id ABD5828A86; Tue, 18 Jun 2019 21:06:10 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED,WEIRD_PORT autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id A604A212E8 for ; Tue, 18 Jun 2019 21:06:00 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id AD8DD89FD4; Tue, 18 Jun 2019 21:05:57 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) by gabe.freedesktop.org (Postfix) with ESMTPS id 478CD89EBD for ; Tue, 18 Jun 2019 21:05:56 +0000 (UTC) Received: from 177.133.86.196.dynamic.adsl.gvt.net.br ([177.133.86.196] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hdLIc-0006yh-7n; Tue, 18 Jun 2019 21:05:52 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hdLIZ-0002Bk-Kr; Tue, 18 Jun 2019 18:05:47 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v1 01/22] docs: Documentation/*.txt: rename all ReST files to *.rst Date: Tue, 18 Jun 2019 18:05:25 -0300 Message-Id: <6b6b6db8d6de9b66223dd6d4b43eb60ead4c71d7.1560891322.git.mchehab+samsung@kernel.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: References: MIME-Version: 1.0 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc: To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=0Fd59qYHPeeoAztyC3BNaFmvhKSlCUBOd/6uerZbhRM=; b=NcWH33eQiz+NCf2Lwg00qXODSC Oh20oknzSq+1nnCh/4b8tnOP6VfFgO6sV9obgYj1rkgpLXXuUD/vZhkRx+ZC0TY1PjcORGTCaKqN7 Fb49IN0K5wvmZuXt+9kPngkbxiGrSi+29jBNsd6g+isw1mVCnBSvzYIpU6YEK6hg/ZJe2AmO2WSG1 F8g552zq/kvTEnYGNFW+TkxrqfQwvelk/Mh2dfAebgVzvZ1EQBGYugafKMVp6Yhb8lnE65710cyqk fDo0CjzeG2CeJ+uqnzTYrdsO+Mhoa/TL3vv5rub072QBsbZ8jfAjR+0HUABN9VSCilRgb/Lm2GFqa h5+UNbzA==; X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-fbdev@vger.kernel.org, linux-ia64@vger.kernel.org, kvm@vger.kernel.org, linux-sh@vger.kernel.org, linux-pci@vger.kernel.org, dri-devel@lists.freedesktop.org, platform-driver-x86@vger.kernel.org, Mauro Carvalho Chehab , kernel-hardening@lists.openwall.com, sparclinux@vger.kernel.org, linux-arch@vger.kernel.org, linux-s390@vger.kernel.org, Jonathan Corbet , x86@kernel.org, linux-security-module@vger.kernel.org, devicetree@vger.kernel.org, linux-watchdog@vger.kernel.org, Mauro Carvalho Chehab , linux-block@vger.kernel.org, linux-gpio@vger.kernel.org, openipmi-developer@lists.sourceforge.net, linux-arm-kernel@lists.infradead.org, linaro-mm-sig@lists.linaro.org, linux-parisc@vger.kernel.org, linux-mm@kvack.org, netdev@vger.kernel.org, linux-wireless@vger.kernel.org, linux-kernel@vger.kernel.org, iommu@lists.linux-foundation.org, linux-crypto@vger.kernel.org Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP Those files are actually at ReST format. Ok, currently, they don't belong to any place yet at the organized book series, but we don't want patches to break them as ReST files. So, rename them and add a :orphan: in order to shut up warning messages like those: ... Documentation/svga.rst: WARNING: document isn't included in any toctree Documentation/switchtec.rst: WARNING: document isn't included in any toctree ... Later patches will move them to a better place and remove the :orphan: markup. Signed-off-by: Mauro Carvalho Chehab Acked-by: Rob Herring --- I had to remove the long list of maintainers got by getpatch.pl, as it was too long. I opted to keep only the mailing lists. Documentation/ABI/removed/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-diskstats | 2 +- Documentation/ABI/testing/sysfs-block | 2 +- .../ABI/testing/sysfs-class-switchtec | 2 +- .../ABI/testing/sysfs-devices-system-cpu | 4 +- .../{DMA-API-HOWTO.txt => DMA-API-HOWTO.rst} | 2 + Documentation/{DMA-API.txt => DMA-API.rst} | 8 ++- .../{DMA-ISA-LPC.txt => DMA-ISA-LPC.rst} | 4 +- ...{DMA-attributes.txt => DMA-attributes.rst} | 2 + Documentation/{IPMI.txt => IPMI.rst} | 2 + .../{IRQ-affinity.txt => IRQ-affinity.rst} | 2 + .../{IRQ-domain.txt => IRQ-domain.rst} | 2 + Documentation/{IRQ.txt => IRQ.rst} | 2 + .../{Intel-IOMMU.txt => Intel-IOMMU.rst} | 2 + Documentation/PCI/pci.rst | 8 +-- Documentation/{SAK.txt => SAK.rst} | 3 +- Documentation/{SM501.txt => SM501.rst} | 2 + Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- .../admin-guide/kernel-parameters.txt | 4 +- .../{atomic_bitops.txt => atomic_bitops.rst} | 3 +- Documentation/block/biodoc.txt | 2 +- .../{bt8xxgpio.txt => bt8xxgpio.rst} | 3 +- Documentation/{btmrvl.txt => btmrvl.rst} | 2 + ...-mapping.txt => bus-virt-phys-mapping.rst} | 54 +++++++++--------- ...g-warn-once.txt => clearing-warn-once.rst} | 2 + Documentation/{cpu-load.txt => cpu-load.rst} | 2 + .../{cputopology.txt => cputopology.rst} | 2 + Documentation/{crc32.txt => crc32.rst} | 2 + Documentation/{dcdbas.txt => dcdbas.rst} | 2 + ...ging-modules.txt => debugging-modules.rst} | 2 + ...hci1394.txt => debugging-via-ohci1394.rst} | 2 + Documentation/{dell_rbu.txt => dell_rbu.rst} | 3 +- Documentation/device-mapper/statistics.rst | 4 +- .../devicetree/bindings/phy/phy-bindings.txt | 2 +- Documentation/{digsig.txt => digsig.rst} | 2 + Documentation/driver-api/usb/dma.rst | 6 +- Documentation/driver-model/device.rst | 2 +- Documentation/{efi-stub.txt => efi-stub.rst} | 2 + Documentation/{eisa.txt => eisa.rst} | 2 + Documentation/fb/vesafb.rst | 2 +- Documentation/filesystems/sysfs.txt | 2 +- ...ex-requeue-pi.txt => futex-requeue-pi.rst} | 2 + .../{gcc-plugins.txt => gcc-plugins.rst} | 2 + Documentation/gpu/drm-mm.rst | 2 +- Documentation/{highuid.txt => highuid.rst} | 4 +- .../{hw_random.txt => hw_random.rst} | 2 + .../{hwspinlock.txt => hwspinlock.rst} | 2 + Documentation/ia64/irq-redir.rst | 2 +- .../{intel_txt.txt => intel_txt.rst} | 2 + .../{io-mapping.txt => io-mapping.rst} | 2 + .../{io_ordering.txt => io_ordering.rst} | 2 + Documentation/{iostats.txt => iostats.rst} | 2 + ...flags-tracing.txt => irqflags-tracing.rst} | 3 +- Documentation/{isa.txt => isa.rst} | 2 + Documentation/{isapnp.txt => isapnp.rst} | 2 + ...hreads.txt => kernel-per-CPU-kthreads.rst} | 4 +- Documentation/{kobject.txt => kobject.rst} | 6 +- Documentation/{kprobes.txt => kprobes.rst} | 3 +- Documentation/{kref.txt => kref.rst} | 2 + Documentation/laptops/thinkpad-acpi.rst | 6 +- Documentation/{ldm.txt => ldm.rst} | 5 +- Documentation/locking/rt-mutex.rst | 2 +- ...kup-watchdogs.txt => lockup-watchdogs.rst} | 2 + Documentation/{lsm.txt => lsm.rst} | 2 + Documentation/{lzo.txt => lzo.rst} | 2 + Documentation/{mailbox.txt => mailbox.rst} | 2 + Documentation/memory-barriers.txt | 6 +- ...hameleon-bus.txt => men-chameleon-bus.rst} | 2 + Documentation/networking/scaling.rst | 4 +- .../{nommu-mmap.txt => nommu-mmap.rst} | 2 + Documentation/{ntb.txt => ntb.rst} | 2 + Documentation/{numastat.txt => numastat.rst} | 3 +- Documentation/{padata.txt => padata.rst} | 2 + ...port-lowlevel.txt => parport-lowlevel.rst} | 2 + ...-semaphore.txt => percpu-rw-semaphore.rst} | 2 + Documentation/{phy.txt => phy.rst} | 2 + Documentation/{pi-futex.txt => pi-futex.rst} | 2 + Documentation/{pnp.txt => pnp.rst} | 13 +++-- ...reempt-locking.txt => preempt-locking.rst} | 4 +- Documentation/{pwm.txt => pwm.rst} | 2 + Documentation/{rbtree.txt => rbtree.rst} | 54 +++++++++--------- .../{remoteproc.txt => remoteproc.rst} | 4 +- Documentation/{rfkill.txt => rfkill.rst} | 2 + ...ust-futex-ABI.txt => robust-futex-ABI.rst} | 2 + ...{robust-futexes.txt => robust-futexes.rst} | 2 + Documentation/{rpmsg.txt => rpmsg.rst} | 2 + Documentation/{rtc.txt => rtc.rst} | 8 ++- Documentation/s390/vfio-ccw.rst | 6 +- Documentation/{sgi-ioc4.txt => sgi-ioc4.rst} | 2 + Documentation/{siphash.txt => siphash.rst} | 2 + .../{smsc_ece1099.txt => smsc_ece1099.rst} | 2 + .../{speculation.txt => speculation.rst} | 2 + .../{static-keys.txt => static-keys.rst} | 2 + Documentation/{svga.txt => svga.rst} | 2 + .../{switchtec.txt => switchtec.rst} | 4 +- .../{sync_file.txt => sync_file.rst} | 2 + Documentation/sysctl/kernel.txt | 4 +- Documentation/sysctl/vm.txt | 2 +- Documentation/{tee.txt => tee.rst} | 2 + .../{this_cpu_ops.txt => this_cpu_ops.rst} | 2 + Documentation/trace/kprobetrace.rst | 2 +- .../translations/ko_KR/memory-barriers.txt | 6 +- Documentation/translations/zh_CN/IRQ.txt | 4 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/io_ordering.txt | 4 +- ...access.txt => unaligned-memory-access.rst} | 2 + ...ed-device.txt => vfio-mediated-device.rst} | 4 +- Documentation/{vfio.txt => vfio.rst} | 2 + .../{video-output.txt => video-output.rst} | 3 +- Documentation/watchdog/hpwdt.rst | 2 +- Documentation/x86/topology.rst | 2 +- Documentation/{xillybus.txt => xillybus.rst} | 2 + Documentation/{xz.txt => xz.rst} | 2 + Documentation/{zorro.txt => zorro.rst} | 7 ++- MAINTAINERS | 56 +++++++++---------- arch/Kconfig | 4 +- arch/arm/Kconfig | 2 +- arch/ia64/hp/common/sba_iommu.c | 12 ++-- arch/ia64/sn/pci/pci_dma.c | 4 +- arch/parisc/Kconfig | 2 +- arch/parisc/kernel/pci-dma.c | 2 +- arch/sh/Kconfig | 2 +- arch/sparc/Kconfig | 2 +- arch/unicore32/include/asm/io.h | 2 +- arch/x86/Kconfig | 4 +- arch/x86/include/asm/dma-mapping.h | 4 +- arch/x86/kernel/amd_gart_64.c | 2 +- block/partitions/Kconfig | 2 +- drivers/base/core.c | 2 +- drivers/char/Kconfig | 4 +- drivers/char/hw_random/core.c | 2 +- drivers/char/ipmi/Kconfig | 2 +- drivers/char/ipmi/ipmi_si_hotmod.c | 2 +- drivers/char/ipmi/ipmi_si_intf.c | 2 +- drivers/dma-buf/Kconfig | 2 +- drivers/gpio/Kconfig | 2 +- drivers/parisc/sba_iommu.c | 16 +++--- drivers/pci/switch/Kconfig | 2 +- drivers/platform/x86/Kconfig | 4 +- drivers/platform/x86/dcdbas.c | 2 +- drivers/platform/x86/dell_rbu.c | 2 +- drivers/pnp/isapnp/Kconfig | 2 +- drivers/vfio/Kconfig | 2 +- drivers/vfio/mdev/Kconfig | 2 +- include/asm-generic/bitops/atomic.h | 2 +- include/linux/dma-mapping.h | 2 +- include/linux/hw_random.h | 2 +- include/linux/io-mapping.h | 2 +- include/linux/jump_label.h | 2 +- include/linux/kobject.h | 2 +- include/linux/kobject_ns.h | 2 +- include/linux/rbtree.h | 2 +- include/linux/rbtree_augmented.h | 2 +- include/media/videobuf-dma-sg.h | 2 +- init/Kconfig | 2 +- kernel/dma/debug.c | 2 +- kernel/padata.c | 2 +- lib/Kconfig | 2 +- lib/Kconfig.debug | 2 +- lib/crc32.c | 2 +- lib/kobject.c | 4 +- lib/lzo/lzo1x_decompress_safe.c | 2 +- lib/xz/Kconfig | 2 +- mm/Kconfig | 2 +- mm/nommu.c | 2 +- samples/kprobes/kprobe_example.c | 2 +- samples/kprobes/kretprobe_example.c | 2 +- scripts/gcc-plugins/Kconfig | 2 +- security/Kconfig | 2 +- tools/include/linux/rbtree.h | 2 +- tools/include/linux/rbtree_augmented.h | 2 +- 173 files changed, 397 insertions(+), 242 deletions(-) rename Documentation/{DMA-API-HOWTO.txt => DMA-API-HOWTO.rst} (99%) rename Documentation/{DMA-API.txt => DMA-API.rst} (99%) rename Documentation/{DMA-ISA-LPC.txt => DMA-ISA-LPC.rst} (98%) rename Documentation/{DMA-attributes.txt => DMA-attributes.rst} (99%) rename Documentation/{IPMI.txt => IPMI.rst} (99%) rename Documentation/{IRQ-affinity.txt => IRQ-affinity.rst} (99%) rename Documentation/{IRQ-domain.txt => IRQ-domain.rst} (99%) rename Documentation/{IRQ.txt => IRQ.rst} (99%) rename Documentation/{Intel-IOMMU.txt => Intel-IOMMU.rst} (99%) rename Documentation/{SAK.txt => SAK.rst} (99%) rename Documentation/{SM501.txt => SM501.rst} (99%) rename Documentation/{atomic_bitops.txt => atomic_bitops.rst} (99%) rename Documentation/{bt8xxgpio.txt => bt8xxgpio.rst} (99%) rename Documentation/{btmrvl.txt => btmrvl.rst} (99%) rename Documentation/{bus-virt-phys-mapping.txt => bus-virt-phys-mapping.rst} (93%) rename Documentation/{clearing-warn-once.txt => clearing-warn-once.rst} (96%) rename Documentation/{cpu-load.txt => cpu-load.rst} (99%) rename Documentation/{cputopology.txt => cputopology.rst} (99%) rename Documentation/{crc32.txt => crc32.rst} (99%) rename Documentation/{dcdbas.txt => dcdbas.rst} (99%) rename Documentation/{debugging-modules.txt => debugging-modules.rst} (98%) rename Documentation/{debugging-via-ohci1394.txt => debugging-via-ohci1394.rst} (99%) rename Documentation/{dell_rbu.txt => dell_rbu.rst} (99%) rename Documentation/{digsig.txt => digsig.rst} (99%) rename Documentation/{efi-stub.txt => efi-stub.rst} (99%) rename Documentation/{eisa.txt => eisa.rst} (99%) rename Documentation/{futex-requeue-pi.txt => futex-requeue-pi.rst} (99%) rename Documentation/{gcc-plugins.txt => gcc-plugins.rst} (99%) rename Documentation/{highuid.txt => highuid.rst} (99%) rename Documentation/{hw_random.txt => hw_random.rst} (99%) rename Documentation/{hwspinlock.txt => hwspinlock.rst} (99%) rename Documentation/{intel_txt.txt => intel_txt.rst} (99%) rename Documentation/{io-mapping.txt => io-mapping.rst} (99%) rename Documentation/{io_ordering.txt => io_ordering.rst} (99%) rename Documentation/{iostats.txt => iostats.rst} (99%) rename Documentation/{irqflags-tracing.txt => irqflags-tracing.rst} (99%) rename Documentation/{isa.txt => isa.rst} (99%) rename Documentation/{isapnp.txt => isapnp.rst} (98%) rename Documentation/{kernel-per-CPU-kthreads.txt => kernel-per-CPU-kthreads.rst} (99%) rename Documentation/{kobject.txt => kobject.rst} (99%) rename Documentation/{kprobes.txt => kprobes.rst} (99%) rename Documentation/{kref.txt => kref.rst} (99%) rename Documentation/{ldm.txt => ldm.rst} (98%) rename Documentation/{lockup-watchdogs.txt => lockup-watchdogs.rst} (99%) rename Documentation/{lsm.txt => lsm.rst} (99%) rename Documentation/{lzo.txt => lzo.rst} (99%) rename Documentation/{mailbox.txt => mailbox.rst} (99%) rename Documentation/{men-chameleon-bus.txt => men-chameleon-bus.rst} (99%) rename Documentation/{nommu-mmap.txt => nommu-mmap.rst} (99%) rename Documentation/{ntb.txt => ntb.rst} (99%) rename Documentation/{numastat.txt => numastat.rst} (99%) rename Documentation/{padata.txt => padata.rst} (99%) rename Documentation/{parport-lowlevel.txt => parport-lowlevel.rst} (99%) rename Documentation/{percpu-rw-semaphore.txt => percpu-rw-semaphore.rst} (99%) rename Documentation/{phy.txt => phy.rst} (99%) rename Documentation/{pi-futex.txt => pi-futex.rst} (99%) rename Documentation/{pnp.txt => pnp.rst} (98%) rename Documentation/{preempt-locking.txt => preempt-locking.rst} (99%) rename Documentation/{pwm.txt => pwm.rst} (99%) rename Documentation/{rbtree.txt => rbtree.rst} (94%) rename Documentation/{remoteproc.txt => remoteproc.rst} (99%) rename Documentation/{rfkill.txt => rfkill.rst} (99%) rename Documentation/{robust-futex-ABI.txt => robust-futex-ABI.rst} (99%) rename Documentation/{robust-futexes.txt => robust-futexes.rst} (99%) rename Documentation/{rpmsg.txt => rpmsg.rst} (99%) rename Documentation/{rtc.txt => rtc.rst} (99%) rename Documentation/{sgi-ioc4.txt => sgi-ioc4.rst} (99%) rename Documentation/{siphash.txt => siphash.rst} (99%) rename Documentation/{smsc_ece1099.txt => smsc_ece1099.rst} (99%) rename Documentation/{speculation.txt => speculation.rst} (99%) rename Documentation/{static-keys.txt => static-keys.rst} (99%) rename Documentation/{svga.txt => svga.rst} (99%) rename Documentation/{switchtec.txt => switchtec.rst} (98%) rename Documentation/{sync_file.txt => sync_file.rst} (99%) rename Documentation/{tee.txt => tee.rst} (99%) rename Documentation/{this_cpu_ops.txt => this_cpu_ops.rst} (99%) rename Documentation/{unaligned-memory-access.txt => unaligned-memory-access.rst} (99%) rename Documentation/{vfio-mediated-device.txt => vfio-mediated-device.rst} (99%) rename Documentation/{vfio.txt => vfio.rst} (99%) rename Documentation/{video-output.txt => video-output.rst} (99%) rename Documentation/{xillybus.txt => xillybus.rst} (99%) rename Documentation/{xz.txt => xz.rst} (99%) rename Documentation/{zorro.txt => zorro.rst} (99%) diff --git a/Documentation/ABI/removed/sysfs-class-rfkill b/Documentation/ABI/removed/sysfs-class-rfkill index 3ce6231f20b2..1652b2381dda 100644 --- a/Documentation/ABI/removed/sysfs-class-rfkill +++ b/Documentation/ABI/removed/sysfs-class-rfkill @@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.txt. +For details to this subsystem look at Documentation/rfkill.rst. What: /sys/class/rfkill/rfkill[0-9]+/claim Date: 09-Jul-2007 diff --git a/Documentation/ABI/stable/sysfs-class-rfkill b/Documentation/ABI/stable/sysfs-class-rfkill index 80151a409d67..68fd0afdad0d 100644 --- a/Documentation/ABI/stable/sysfs-class-rfkill +++ b/Documentation/ABI/stable/sysfs-class-rfkill @@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.txt. +For details to this subsystem look at Documentation/rfkill.rst. For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in Documentation/ABI/removed/sysfs-class-rfkill. diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index f7ce68fbd4b9..de1d022c0864 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -61,7 +61,7 @@ Date: October 2002 Contact: Linux Memory Management list Description: The node's hit/miss statistics, in units of pages. - See Documentation/numastat.txt + See Documentation/numastat.rst What: /sys/devices/system/node/nodeX/distance Date: October 2002 diff --git a/Documentation/ABI/testing/procfs-diskstats b/Documentation/ABI/testing/procfs-diskstats index abac31d216de..26661dd5188b 100644 --- a/Documentation/ABI/testing/procfs-diskstats +++ b/Documentation/ABI/testing/procfs-diskstats @@ -29,4 +29,4 @@ Description: 17 - sectors discarded 18 - time spent discarding - For more details refer to Documentation/iostats.txt + For more details refer to Documentation/iostats.rst diff --git a/Documentation/ABI/testing/sysfs-block b/Documentation/ABI/testing/sysfs-block index dfad7427817c..d300a6b9d17c 100644 --- a/Documentation/ABI/testing/sysfs-block +++ b/Documentation/ABI/testing/sysfs-block @@ -15,7 +15,7 @@ Description: 9 - I/Os currently in progress 10 - time spent doing I/Os (ms) 11 - weighted time spent doing I/Os (ms) - For more details refer Documentation/iostats.txt + For more details refer Documentation/iostats.rst What: /sys/block///stat diff --git a/Documentation/ABI/testing/sysfs-class-switchtec b/Documentation/ABI/testing/sysfs-class-switchtec index 48cb4c15e430..c8d80db1e32c 100644 --- a/Documentation/ABI/testing/sysfs-class-switchtec +++ b/Documentation/ABI/testing/sysfs-class-switchtec @@ -1,6 +1,6 @@ switchtec - Microsemi Switchtec PCI Switch Management Endpoint -For details on this subsystem look at Documentation/switchtec.txt. +For details on this subsystem look at Documentation/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017 diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu index 87478ac6c2af..1a2653f5261f 100644 --- a/Documentation/ABI/testing/sysfs-devices-system-cpu +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu @@ -34,7 +34,7 @@ Description: CPU topology files that describe kernel limits related to present: cpus that have been identified as being present in the system. - See Documentation/cputopology.txt for more information. + See Documentation/cputopology.rst for more information. What: /sys/devices/system/cpu/probe @@ -103,7 +103,7 @@ Description: CPU topology files that describe a logical CPU's relationship thread_siblings_list: human-readable list of cpu#'s hardware threads within the same core as cpu# - See Documentation/cputopology.txt for more information. + See Documentation/cputopology.rst for more information. What: /sys/devices/system/cpu/cpuidle/current_driver diff --git a/Documentation/DMA-API-HOWTO.txt b/Documentation/DMA-API-HOWTO.rst similarity index 99% rename from Documentation/DMA-API-HOWTO.txt rename to Documentation/DMA-API-HOWTO.rst index 358d495456d1..db9f8fcebe1f 100644 --- a/Documentation/DMA-API-HOWTO.txt +++ b/Documentation/DMA-API-HOWTO.rst @@ -1,3 +1,5 @@ +:orphan: + ========================= Dynamic DMA mapping Guide ========================= diff --git a/Documentation/DMA-API.txt b/Documentation/DMA-API.rst similarity index 99% rename from Documentation/DMA-API.txt rename to Documentation/DMA-API.rst index e47c63bd4887..2f26857f97ff 100644 --- a/Documentation/DMA-API.txt +++ b/Documentation/DMA-API.rst @@ -1,3 +1,5 @@ +:orphan: + ============================================ Dynamic DMA mapping using the generic device ============================================ @@ -5,7 +7,7 @@ Dynamic DMA mapping using the generic device :Author: James E.J. Bottomley This document describes the DMA API. For a more gentle introduction -of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt. +of the API (and actual examples), see Documentation/DMA-API-HOWTO.rst. This API is split into two pieces. Part I describes the basic API. Part II describes extensions for supporting non-consistent memory @@ -463,7 +465,7 @@ without the _attrs suffixes, except that they pass an optional dma_attrs. The interpretation of DMA attributes is architecture-specific, and -each attribute should be documented in Documentation/DMA-attributes.txt. +each attribute should be documented in Documentation/DMA-attributes.rst. If dma_attrs are 0, the semantics of each of these functions is identical to those of the corresponding function @@ -476,7 +478,7 @@ for DMA:: #include /* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and - * documented in Documentation/DMA-attributes.txt */ + * documented in Documentation/DMA-attributes.rst */ ... unsigned long attr; diff --git a/Documentation/DMA-ISA-LPC.txt b/Documentation/DMA-ISA-LPC.rst similarity index 98% rename from Documentation/DMA-ISA-LPC.txt rename to Documentation/DMA-ISA-LPC.rst index b1ec7b16c21f..205a379c2d62 100644 --- a/Documentation/DMA-ISA-LPC.txt +++ b/Documentation/DMA-ISA-LPC.rst @@ -1,3 +1,5 @@ +:orphan: + ============================ DMA with ISA and LPC devices ============================ @@ -17,7 +19,7 @@ To do ISA style DMA you need to include two headers:: #include The first is the generic DMA API used to convert virtual addresses to -bus addresses (see Documentation/DMA-API.txt for details). +bus addresses (see Documentation/DMA-API.rst for details). The second contains the routines specific to ISA DMA transfers. Since this is not present on all platforms make sure you construct your diff --git a/Documentation/DMA-attributes.txt b/Documentation/DMA-attributes.rst similarity index 99% rename from Documentation/DMA-attributes.txt rename to Documentation/DMA-attributes.rst index 8f8d97f65d73..471c5c38f9d9 100644 --- a/Documentation/DMA-attributes.txt +++ b/Documentation/DMA-attributes.rst @@ -1,3 +1,5 @@ +:orphan: + ============== DMA attributes ============== diff --git a/Documentation/IPMI.txt b/Documentation/IPMI.rst similarity index 99% rename from Documentation/IPMI.txt rename to Documentation/IPMI.rst index 5ef1047e2e66..f6c2d11710fe 100644 --- a/Documentation/IPMI.txt +++ b/Documentation/IPMI.rst @@ -1,3 +1,5 @@ +:orphan: + ===================== The Linux IPMI Driver ===================== diff --git a/Documentation/IRQ-affinity.txt b/Documentation/IRQ-affinity.rst similarity index 99% rename from Documentation/IRQ-affinity.txt rename to Documentation/IRQ-affinity.rst index 29da5000836a..49ba271349d6 100644 --- a/Documentation/IRQ-affinity.txt +++ b/Documentation/IRQ-affinity.rst @@ -1,3 +1,5 @@ +:orphan: + ================ SMP IRQ affinity ================ diff --git a/Documentation/IRQ-domain.txt b/Documentation/IRQ-domain.rst similarity index 99% rename from Documentation/IRQ-domain.txt rename to Documentation/IRQ-domain.rst index 507775cce753..a610a8ea9a92 100644 --- a/Documentation/IRQ-domain.txt +++ b/Documentation/IRQ-domain.rst @@ -1,3 +1,5 @@ +:orphan: + =============================================== The irq_domain interrupt number mapping library =============================================== diff --git a/Documentation/IRQ.txt b/Documentation/IRQ.rst similarity index 99% rename from Documentation/IRQ.txt rename to Documentation/IRQ.rst index 4273806a606b..a9f3e192c2cb 100644 --- a/Documentation/IRQ.txt +++ b/Documentation/IRQ.rst @@ -1,3 +1,5 @@ +:orphan: + =============== What is an IRQ? =============== diff --git a/Documentation/Intel-IOMMU.txt b/Documentation/Intel-IOMMU.rst similarity index 99% rename from Documentation/Intel-IOMMU.txt rename to Documentation/Intel-IOMMU.rst index 9dae6b47e398..b001104c25c8 100644 --- a/Documentation/Intel-IOMMU.txt +++ b/Documentation/Intel-IOMMU.rst @@ -1,3 +1,5 @@ +:orphan: + =================== Linux IOMMU Support =================== diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst index 6864f9a70f5f..840cbf5f37a7 100644 --- a/Documentation/PCI/pci.rst +++ b/Documentation/PCI/pci.rst @@ -239,7 +239,7 @@ from the PCI device config space. Use the values in the pci_dev structure as the PCI "bus address" might have been remapped to a "host physical" address by the arch/chip-set specific kernel support. -See Documentation/io-mapping.txt for how to access device registers +See Documentation/io-mapping.rst for how to access device registers or device memory. The device driver needs to call pci_request_region() to verify @@ -265,7 +265,7 @@ Set the DMA mask size --------------------- .. note:: If anything below doesn't make sense, please refer to - Documentation/DMA-API.txt. This section is just a reminder that + Documentation/DMA-API.rst. This section is just a reminder that drivers need to indicate DMA capabilities of the device and is not an authoritative source for DMA interfaces. @@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are Setup shared control data ------------------------- Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) -memory. See Documentation/DMA-API.txt for a full description of +memory. See Documentation/DMA-API.rst for a full description of the DMA APIs. This section is just a reminder that it needs to be done before enabling DMA on the device. @@ -421,7 +421,7 @@ owners if there is one. Then clean up "consistent" buffers which contain the control data. -See Documentation/DMA-API.txt for details on unmapping interfaces. +See Documentation/DMA-API.rst for details on unmapping interfaces. Unregister from other subsystems diff --git a/Documentation/SAK.txt b/Documentation/SAK.rst similarity index 99% rename from Documentation/SAK.txt rename to Documentation/SAK.rst index 260e1d3687bd..73dd10fa4337 100644 --- a/Documentation/SAK.txt +++ b/Documentation/SAK.rst @@ -1,3 +1,5 @@ +:orphan: + ========================================= Linux Secure Attention Key (SAK) handling ========================================= @@ -88,4 +90,3 @@ And that's it! Only the superuser may reprogram the SAK key. /dev/console. So SAK kills them all. A workaround is to simply delete these lines, but this may cause system management applications to malfunction - test everything well. - diff --git a/Documentation/SM501.txt b/Documentation/SM501.rst similarity index 99% rename from Documentation/SM501.txt rename to Documentation/SM501.rst index 882507453ba4..772a9b5c7d49 100644 --- a/Documentation/SM501.txt +++ b/Documentation/SM501.rst @@ -1,3 +1,5 @@ +:orphan: + .. include:: ============ diff --git a/Documentation/admin-guide/hw-vuln/l1tf.rst b/Documentation/admin-guide/hw-vuln/l1tf.rst index 656aee262e23..5668fc2013ce 100644 --- a/Documentation/admin-guide/hw-vuln/l1tf.rst +++ b/Documentation/admin-guide/hw-vuln/l1tf.rst @@ -268,7 +268,7 @@ Guest mitigation mechanisms /proc/irq/$NR/smp_affinity[_list] files. Limited documentation is available at: - https://www.kernel.org/doc/Documentation/IRQ-affinity.txt + https://www.kernel.org/doc/Documentation/IRQ-affinity.rst .. _smt_control: diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index 7abe677f8c5e..873062810484 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -3162,7 +3162,7 @@ See Documentation/sysctl/vm.txt for details. ohci1394_dma=early [HW] enable debugging via the ohci1394 driver. - See Documentation/debugging-via-ohci1394.txt for more + See Documentation/debugging-via-ohci1394.rst for more info. olpc_ec_timeout= [OLPC] ms delay when issuing EC commands @@ -5075,7 +5075,7 @@ vga= [BOOT,X86-32] Select a particular video mode See Documentation/x86/boot.rst and - Documentation/svga.txt. + Documentation/svga.rst. Use vga=ask for menu. This is actually a boot loader parameter; the value is passed to the kernel using a special protocol. diff --git a/Documentation/atomic_bitops.txt b/Documentation/atomic_bitops.rst similarity index 99% rename from Documentation/atomic_bitops.txt rename to Documentation/atomic_bitops.rst index 093cdaefdb37..b683bcb71185 100644 --- a/Documentation/atomic_bitops.txt +++ b/Documentation/atomic_bitops.rst @@ -1,3 +1,5 @@ +:orphan: + ============= Atomic bitops ============= @@ -68,4 +70,3 @@ clear_bit_unlock() which has RELEASE semantics. Since a platform only has a single means of achieving atomic operations the same barriers as for atomic_t are used, see atomic_t.txt. - diff --git a/Documentation/block/biodoc.txt b/Documentation/block/biodoc.txt index ac18b488cb5e..ac504de0cb93 100644 --- a/Documentation/block/biodoc.txt +++ b/Documentation/block/biodoc.txt @@ -184,7 +184,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address do not have a corresponding kernel virtual address space mapping) and low-memory pages. -Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion +Note: Please refer to Documentation/DMA-API-HOWTO.rst for a discussion on PCI high mem DMA aspects and mapping of scatter gather lists, and support for 64 bit PCI. diff --git a/Documentation/bt8xxgpio.txt b/Documentation/bt8xxgpio.rst similarity index 99% rename from Documentation/bt8xxgpio.txt rename to Documentation/bt8xxgpio.rst index a845feb074de..093875e1b0aa 100644 --- a/Documentation/bt8xxgpio.txt +++ b/Documentation/bt8xxgpio.rst @@ -1,3 +1,5 @@ +:orphan: + =================================================================== A driver for a selfmade cheap BT8xx based PCI GPIO-card (bt8xxgpio) =================================================================== @@ -59,4 +61,3 @@ The GPIO pins are marked with G00-G23:: | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ^ This is pin 1 - diff --git a/Documentation/btmrvl.txt b/Documentation/btmrvl.rst similarity index 99% rename from Documentation/btmrvl.txt rename to Documentation/btmrvl.rst index ec57740ead0c..e6dd1c96e842 100644 --- a/Documentation/btmrvl.txt +++ b/Documentation/btmrvl.rst @@ -1,3 +1,5 @@ +:orphan: + ============= btmrvl driver ============= diff --git a/Documentation/bus-virt-phys-mapping.txt b/Documentation/bus-virt-phys-mapping.rst similarity index 93% rename from Documentation/bus-virt-phys-mapping.txt rename to Documentation/bus-virt-phys-mapping.rst index 4bb07c2f3e7d..eefb0ae99ba8 100644 --- a/Documentation/bus-virt-phys-mapping.txt +++ b/Documentation/bus-virt-phys-mapping.rst @@ -1,3 +1,5 @@ +:orphan: + ========================================================== How to access I/O mapped memory from within device drivers ========================================================== @@ -8,7 +10,7 @@ How to access I/O mapped memory from within device drivers The virt_to_bus() and bus_to_virt() functions have been superseded by the functionality provided by the PCI DMA interface - (see Documentation/DMA-API-HOWTO.txt). They continue + (see Documentation/DMA-API-HOWTO.rst). They continue to be documented below for historical purposes, but new code must not use them. --davidm 00/12/12 @@ -19,35 +21,35 @@ How to access I/O mapped memory from within device drivers The AHA-1542 is a bus-master device, and your patch makes the driver give the controller the physical address of the buffers, which is correct on x86 -(because all bus master devices see the physical memory mappings directly). +(because all bus master devices see the physical memory mappings directly). However, on many setups, there are actually **three** different ways of looking at memory addresses, and in this case we actually want the third, the -so-called "bus address". +so-called "bus address". Essentially, the three ways of addressing memory are (this is "real memory", -that is, normal RAM--see later about other details): +that is, normal RAM--see later about other details): - - CPU untranslated. This is the "physical" address. Physical address + - CPU untranslated. This is the "physical" address. Physical address 0 is what the CPU sees when it drives zeroes on the memory bus. - - CPU translated address. This is the "virtual" address, and is + - CPU translated address. This is the "virtual" address, and is completely internal to the CPU itself with the CPU doing the appropriate - translations into "CPU untranslated". + translations into "CPU untranslated". - - bus address. This is the address of memory as seen by OTHER devices, - not the CPU. Now, in theory there could be many different bus + - bus address. This is the address of memory as seen by OTHER devices, + not the CPU. Now, in theory there could be many different bus addresses, with each device seeing memory in some device-specific way, but happily most hardware designers aren't actually actively trying to make - things any more complex than necessary, so you can assume that all - external hardware sees the memory the same way. + things any more complex than necessary, so you can assume that all + external hardware sees the memory the same way. Now, on normal PCs the bus address is exactly the same as the physical address, and things are very simple indeed. However, they are that simple because the memory and the devices share the same address space, and that is -not generally necessarily true on other PCI/ISA setups. +not generally necessarily true on other PCI/ISA setups. -Now, just as an example, on the PReP (PowerPC Reference Platform), the +Now, just as an example, on the PReP (PowerPC Reference Platform), the CPU sees a memory map something like this (this is from memory):: 0-2 GB "real memory" @@ -58,17 +60,17 @@ Now, that looks simple enough. However, when you look at the same thing from the viewpoint of the devices, you have the reverse, and the physical memory address 0 actually shows up as address 2 GB for any IO master. -So when the CPU wants any bus master to write to physical memory 0, it +So when the CPU wants any bus master to write to physical memory 0, it has to give the master address 0x80000000 as the memory address. -So, for example, depending on how the kernel is actually mapped on the +So, for example, depending on how the kernel is actually mapped on the PPC, you can end up with a setup like this:: physical address: 0 virtual address: 0xC0000000 bus address: 0x80000000 -where all the addresses actually point to the same thing. It's just seen +where all the addresses actually point to the same thing. It's just seen through different translations.. Similarly, on the Alpha, the normal translation is:: @@ -78,7 +80,7 @@ Similarly, on the Alpha, the normal translation is:: bus address: 0x40000000 (but there are also Alphas where the physical address and the bus address -are the same). +are the same). Anyway, the way to look up all these translations, you do:: @@ -113,7 +115,7 @@ pointer from the kernel. So you can have something like this:: case STATUS_OK: ... -on the other hand, you want the bus address when you have a buffer that +on the other hand, you want the bus address when you have a buffer that you want to give to the controller:: /* ask the controller to read the sense status into "sense_buffer" */ @@ -124,7 +126,7 @@ you want to give to the controller:: And you generally **never** want to use the physical address, because you can't use that from the CPU (the CPU only uses translated virtual addresses), and -you can't use it from the bus master. +you can't use it from the bus master. So why do we care about the physical address at all? We do need the physical address in some cases, it's just not very often in normal code. The physical @@ -142,7 +144,7 @@ shouldn't need to know about "bus addresses" etc). There is a completely different type of memory too, and that's the "shared memory" on the PCI or ISA bus. That's generally not RAM (although in the case of a video graphics card it can be normal DRAM that is just used for a frame -buffer), but can be things like a packet buffer in a network card etc. +buffer), but can be things like a packet buffer in a network card etc. This memory is called "PCI memory" or "shared memory" or "IO memory" or whatever, and there is only one way to access it: the readb/writeb and @@ -151,7 +153,7 @@ there is really nothing you can do with such an address: it's not conceptually in the same memory space as "real memory" at all, so you cannot just dereference a pointer. (Sadly, on x86 it **is** in the same memory space, so on x86 it actually works to just deference a pointer, but it's not -portable). +portable). For such memory, you can do things like: @@ -197,19 +199,19 @@ Note that kernel versions 2.0.x (and earlier) mistakenly called the ioremap() function "vremap()". ioremap() is the proper name, but I didn't think straight when I wrote it originally. People who have to support both can do something like:: - + /* support old naming silliness */ #if LINUX_VERSION_CODE < 0x020100 #define ioremap vremap - #define iounmap vfree + #define iounmap vfree #endif - + at the top of their source files, and then they can use the right names -even on 2.0.x systems. +even on 2.0.x systems. And the above sounds worse than it really is. Most real drivers really don't do all that complex things (or rather: the complexity is not so -much in the actual IO accesses as in error handling and timeouts etc). +much in the actual IO accesses as in error handling and timeouts etc). It's generally not hard to fix drivers, and in many cases the code actually looks better afterwards:: diff --git a/Documentation/clearing-warn-once.txt b/Documentation/clearing-warn-once.rst similarity index 96% rename from Documentation/clearing-warn-once.txt rename to Documentation/clearing-warn-once.rst index 211fd926cf00..cdfa892c7fdf 100644 --- a/Documentation/clearing-warn-once.txt +++ b/Documentation/clearing-warn-once.rst @@ -1,3 +1,5 @@ +:orphan: + Clearing WARN_ONCE ------------------ diff --git a/Documentation/cpu-load.txt b/Documentation/cpu-load.rst similarity index 99% rename from Documentation/cpu-load.txt rename to Documentation/cpu-load.rst index 2d01ce43d2a2..6b2815b78683 100644 --- a/Documentation/cpu-load.txt +++ b/Documentation/cpu-load.rst @@ -1,3 +1,5 @@ +:orphan: + ======== CPU load ======== diff --git a/Documentation/cputopology.txt b/Documentation/cputopology.rst similarity index 99% rename from Documentation/cputopology.txt rename to Documentation/cputopology.rst index b90dafcc8237..ef1e6b105957 100644 --- a/Documentation/cputopology.txt +++ b/Documentation/cputopology.rst @@ -1,3 +1,5 @@ +:orphan: + =========================================== How CPU topology info is exported via sysfs =========================================== diff --git a/Documentation/crc32.txt b/Documentation/crc32.rst similarity index 99% rename from Documentation/crc32.txt rename to Documentation/crc32.rst index 8a6860f33b4e..f7c73d713a35 100644 --- a/Documentation/crc32.txt +++ b/Documentation/crc32.rst @@ -1,3 +1,5 @@ +:orphan: + ================================= brief tutorial on CRC computation ================================= diff --git a/Documentation/dcdbas.txt b/Documentation/dcdbas.rst similarity index 99% rename from Documentation/dcdbas.txt rename to Documentation/dcdbas.rst index 309cc57a7c1c..abbc2bfd58a7 100644 --- a/Documentation/dcdbas.txt +++ b/Documentation/dcdbas.rst @@ -1,3 +1,5 @@ +:orphan: + =================================== Dell Systems Management Base Driver =================================== diff --git a/Documentation/debugging-modules.txt b/Documentation/debugging-modules.rst similarity index 98% rename from Documentation/debugging-modules.txt rename to Documentation/debugging-modules.rst index 172ad4aec493..994f4b021a81 100644 --- a/Documentation/debugging-modules.txt +++ b/Documentation/debugging-modules.rst @@ -1,3 +1,5 @@ +:orphan: + Debugging Modules after 2.6.3 ----------------------------- diff --git a/Documentation/debugging-via-ohci1394.txt b/Documentation/debugging-via-ohci1394.rst similarity index 99% rename from Documentation/debugging-via-ohci1394.txt rename to Documentation/debugging-via-ohci1394.rst index 981ad4f89fd3..ead0196d94b7 100644 --- a/Documentation/debugging-via-ohci1394.txt +++ b/Documentation/debugging-via-ohci1394.rst @@ -1,3 +1,5 @@ +:orphan: + =========================================================================== Using physical DMA provided by OHCI-1394 FireWire controllers for debugging =========================================================================== diff --git a/Documentation/dell_rbu.txt b/Documentation/dell_rbu.rst similarity index 99% rename from Documentation/dell_rbu.txt rename to Documentation/dell_rbu.rst index 5d1ce7bcd04d..45cd18abd98f 100644 --- a/Documentation/dell_rbu.txt +++ b/Documentation/dell_rbu.rst @@ -1,3 +1,5 @@ +:orphan: + ============================================================= Usage of the new open sourced rbu (Remote BIOS Update) driver ============================================================= @@ -125,4 +127,3 @@ read back the image downloaded. code which sends the BIOS update request to the BIOS. So on the next reboot the BIOS knows about the new image downloaded and it updates itself. Also don't unload the rbu driver if the image has to be updated. - diff --git a/Documentation/device-mapper/statistics.rst b/Documentation/device-mapper/statistics.rst index 3d80a9f850cc..39f74af35abb 100644 --- a/Documentation/device-mapper/statistics.rst +++ b/Documentation/device-mapper/statistics.rst @@ -13,7 +13,7 @@ the range specified. The I/O statistics counters for each step-sized area of a region are in the same format as `/sys/block/*/stat` or `/proc/diskstats` (see: -Documentation/iostats.txt). But two extra counters (12 and 13) are +Documentation/iostats.rst). But two extra counters (12 and 13) are provided: total time spent reading and writing. When the histogram argument is used, the 14th parameter is reported that represents the histogram of latencies. All these counters may be accessed by sending @@ -151,7 +151,7 @@ Messages The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. - Please refer to Documentation/iostats.txt for details. + Please refer to Documentation/iostats.rst for details. 1. the number of reads completed 2. the number of reads merged diff --git a/Documentation/devicetree/bindings/phy/phy-bindings.txt b/Documentation/devicetree/bindings/phy/phy-bindings.txt index a403b81d0679..5e2a53bcba0e 100644 --- a/Documentation/devicetree/bindings/phy/phy-bindings.txt +++ b/Documentation/devicetree/bindings/phy/phy-bindings.txt @@ -1,5 +1,5 @@ This document explains only the device tree data binding. For general -information about PHY subsystem refer to Documentation/phy.txt +information about PHY subsystem refer to Documentation/phy.rst PHY device node =============== diff --git a/Documentation/digsig.txt b/Documentation/digsig.rst similarity index 99% rename from Documentation/digsig.txt rename to Documentation/digsig.rst index f6a8902d3ef7..3597711d0df1 100644 --- a/Documentation/digsig.txt +++ b/Documentation/digsig.rst @@ -1,3 +1,5 @@ +:orphan: + ================================== Digital Signature Verification API ================================== diff --git a/Documentation/driver-api/usb/dma.rst b/Documentation/driver-api/usb/dma.rst index 59d5aee89e37..12955a77c7fe 100644 --- a/Documentation/driver-api/usb/dma.rst +++ b/Documentation/driver-api/usb/dma.rst @@ -10,7 +10,7 @@ API overview The big picture is that USB drivers can continue to ignore most DMA issues, though they still must provide DMA-ready buffers (see -``Documentation/DMA-API-HOWTO.txt``). That's how they've worked through +``Documentation/DMA-API-HOWTO.rst``). That's how they've worked through the 2.4 (and earlier) kernels, or they can now be DMA-aware. DMA-aware usb drivers: @@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties. force a consistent memory access ordering by using memory barriers. It's not using a streaming DMA mapping, so it's good for small transfers on systems where the I/O would otherwise thrash an IOMMU mapping. (See - ``Documentation/DMA-API-HOWTO.txt`` for definitions of "coherent" and + ``Documentation/DMA-API-HOWTO.rst`` for definitions of "coherent" and "streaming" DMA mappings.) Asking for 1/Nth of a page (as well as asking for N pages) is reasonably @@ -91,7 +91,7 @@ Working with existing buffers Existing buffers aren't usable for DMA without first being mapped into the DMA address space of the device. However, most buffers passed to your driver can safely be used with such DMA mapping. (See the first section -of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?") +of Documentation/DMA-API-HOWTO.rst, titled "What memory is DMA-able?") - When you're using scatterlists, you can map everything at once. On some systems, this kicks in an IOMMU and turns the scatterlists into single diff --git a/Documentation/driver-model/device.rst b/Documentation/driver-model/device.rst index 2b868d49d349..17bcc483c4b1 100644 --- a/Documentation/driver-model/device.rst +++ b/Documentation/driver-model/device.rst @@ -53,7 +53,7 @@ Attributes of devices can be exported by a device driver through sysfs. Please see Documentation/filesystems/sysfs.txt for more information on how sysfs works. -As explained in Documentation/kobject.txt, device attributes must be +As explained in Documentation/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. diff --git a/Documentation/efi-stub.txt b/Documentation/efi-stub.rst similarity index 99% rename from Documentation/efi-stub.txt rename to Documentation/efi-stub.rst index 833edb0d0bc4..29256cad8af3 100644 --- a/Documentation/efi-stub.txt +++ b/Documentation/efi-stub.rst @@ -1,3 +1,5 @@ +:orphan: + ================= The EFI Boot Stub ================= diff --git a/Documentation/eisa.txt b/Documentation/eisa.rst similarity index 99% rename from Documentation/eisa.txt rename to Documentation/eisa.rst index f388545a85a7..d98949908405 100644 --- a/Documentation/eisa.txt +++ b/Documentation/eisa.rst @@ -1,3 +1,5 @@ +:orphan: + ================ EISA bus support ================ diff --git a/Documentation/fb/vesafb.rst b/Documentation/fb/vesafb.rst index 2ed0dfb661cf..a0b658091b07 100644 --- a/Documentation/fb/vesafb.rst +++ b/Documentation/fb/vesafb.rst @@ -30,7 +30,7 @@ How to use it? ============== Switching modes is done using the vga=... boot parameter. Read -Documentation/svga.txt for details. +Documentation/svga.rst for details. You should compile in both vgacon (for text mode) and vesafb (for graphics mode). Which of them takes over the console depends on diff --git a/Documentation/filesystems/sysfs.txt b/Documentation/filesystems/sysfs.txt index 5b5311f9358d..d159826c5cf3 100644 --- a/Documentation/filesystems/sysfs.txt +++ b/Documentation/filesystems/sysfs.txt @@ -16,7 +16,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/kobject.rst for more information concerning the kobject interface. diff --git a/Documentation/futex-requeue-pi.txt b/Documentation/futex-requeue-pi.rst similarity index 99% rename from Documentation/futex-requeue-pi.txt rename to Documentation/futex-requeue-pi.rst index 14ab5787b9a7..a90dbff26629 100644 --- a/Documentation/futex-requeue-pi.txt +++ b/Documentation/futex-requeue-pi.rst @@ -1,3 +1,5 @@ +:orphan: + ================ Futex Requeue PI ================ diff --git a/Documentation/gcc-plugins.txt b/Documentation/gcc-plugins.rst similarity index 99% rename from Documentation/gcc-plugins.txt rename to Documentation/gcc-plugins.rst index 8502f24396fb..e08d013c6de2 100644 --- a/Documentation/gcc-plugins.txt +++ b/Documentation/gcc-plugins.rst @@ -1,3 +1,5 @@ +:orphan: + ========================= GCC plugin infrastructure ========================= diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst index c8ebd4f66a6a..fa30dfcfc3c8 100644 --- a/Documentation/gpu/drm-mm.rst +++ b/Documentation/gpu/drm-mm.rst @@ -320,7 +320,7 @@ struct :c:type:`struct file_operations ` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.txt +Documentation/nommu-mmap.rst Memory Coherency ---------------- diff --git a/Documentation/highuid.txt b/Documentation/highuid.rst similarity index 99% rename from Documentation/highuid.txt rename to Documentation/highuid.rst index 6ee70465c0ea..d1cbc71a59a2 100644 --- a/Documentation/highuid.txt +++ b/Documentation/highuid.rst @@ -1,3 +1,5 @@ +:orphan: + =================================================== Notes on the change from 16-bit UIDs to 32-bit UIDs =================================================== @@ -19,7 +21,7 @@ What's left to be done for 32-bit UIDs on all Linux architectures: underlying filesystem, because quota records are written at offsets corresponding to the UID in question. Further investigation is needed to see if the quota system can cope - properly with huge UIDs. If it can deal with 64-bit file offsets on all + properly with huge UIDs. If it can deal with 64-bit file offsets on all architectures, this should not be a problem. - Decide whether or not to keep backwards compatibility with the system diff --git a/Documentation/hw_random.txt b/Documentation/hw_random.rst similarity index 99% rename from Documentation/hw_random.txt rename to Documentation/hw_random.rst index 121de96e395e..fb5e32fae384 100644 --- a/Documentation/hw_random.txt +++ b/Documentation/hw_random.rst @@ -1,3 +1,5 @@ +:orphan: + ========================================================== Linux support for random number generator in i8xx chipsets ========================================================== diff --git a/Documentation/hwspinlock.txt b/Documentation/hwspinlock.rst similarity index 99% rename from Documentation/hwspinlock.txt rename to Documentation/hwspinlock.rst index ed640a278185..68297473647c 100644 --- a/Documentation/hwspinlock.txt +++ b/Documentation/hwspinlock.rst @@ -1,3 +1,5 @@ +:orphan: + =========================== Hardware Spinlock Framework =========================== diff --git a/Documentation/ia64/irq-redir.rst b/Documentation/ia64/irq-redir.rst index 39bf94484a15..0abc7b35f6c0 100644 --- a/Documentation/ia64/irq-redir.rst +++ b/Documentation/ia64/irq-redir.rst @@ -7,7 +7,7 @@ IRQ affinity on IA64 platforms By writing to /proc/irq/IRQ#/smp_affinity the interrupt routing can be controlled. The behavior on IA64 platforms is slightly different from -that described in Documentation/IRQ-affinity.txt for i386 systems. +that described in Documentation/IRQ-affinity.rst for i386 systems. Because of the usage of SAPIC mode and physical destination mode the IRQ target is one particular CPU and cannot be a mask of several diff --git a/Documentation/intel_txt.txt b/Documentation/intel_txt.rst similarity index 99% rename from Documentation/intel_txt.txt rename to Documentation/intel_txt.rst index d83c1a2122c9..5a55007ecf08 100644 --- a/Documentation/intel_txt.txt +++ b/Documentation/intel_txt.rst @@ -1,3 +1,5 @@ +:orphan: + ===================== Intel(R) TXT Overview ===================== diff --git a/Documentation/io-mapping.txt b/Documentation/io-mapping.rst similarity index 99% rename from Documentation/io-mapping.txt rename to Documentation/io-mapping.rst index a966239f04e4..82a2cacf9a29 100644 --- a/Documentation/io-mapping.txt +++ b/Documentation/io-mapping.rst @@ -1,3 +1,5 @@ +:orphan: + ======================== The io_mapping functions ======================== diff --git a/Documentation/io_ordering.txt b/Documentation/io_ordering.rst similarity index 99% rename from Documentation/io_ordering.txt rename to Documentation/io_ordering.rst index 2ab303ce9a0d..18ef889c100e 100644 --- a/Documentation/io_ordering.txt +++ b/Documentation/io_ordering.rst @@ -1,3 +1,5 @@ +:orphan: + ============================================== Ordering I/O writes to memory-mapped addresses ============================================== diff --git a/Documentation/iostats.txt b/Documentation/iostats.rst similarity index 99% rename from Documentation/iostats.txt rename to Documentation/iostats.rst index 5d63b18bd6d1..f4d37d812c30 100644 --- a/Documentation/iostats.txt +++ b/Documentation/iostats.rst @@ -1,3 +1,5 @@ +:orphan: + ===================== I/O statistics fields ===================== diff --git a/Documentation/irqflags-tracing.txt b/Documentation/irqflags-tracing.rst similarity index 99% rename from Documentation/irqflags-tracing.txt rename to Documentation/irqflags-tracing.rst index bdd208259fb3..a2fbbb1a62b9 100644 --- a/Documentation/irqflags-tracing.txt +++ b/Documentation/irqflags-tracing.rst @@ -1,3 +1,5 @@ +:orphan: + ======================= IRQ-flags state tracing ======================= @@ -49,4 +51,3 @@ turn itself off. I.e. the lock validator will still be reliable. There should be no crashes due to irq-tracing bugs. (except if the assembly changes break other code by modifying conditions or registers that shouldn't be) - diff --git a/Documentation/isa.txt b/Documentation/isa.rst similarity index 99% rename from Documentation/isa.txt rename to Documentation/isa.rst index def4a7b690b5..f3a412d266b0 100644 --- a/Documentation/isa.txt +++ b/Documentation/isa.rst @@ -1,3 +1,5 @@ +:orphan: + =========== ISA Drivers =========== diff --git a/Documentation/isapnp.txt b/Documentation/isapnp.rst similarity index 98% rename from Documentation/isapnp.txt rename to Documentation/isapnp.rst index 8d0840ac847b..136a5e92be27 100644 --- a/Documentation/isapnp.txt +++ b/Documentation/isapnp.rst @@ -1,3 +1,5 @@ +:orphan: + ========================================================== ISA Plug & Play support by Jaroslav Kysela ========================================================== diff --git a/Documentation/kernel-per-CPU-kthreads.txt b/Documentation/kernel-per-CPU-kthreads.rst similarity index 99% rename from Documentation/kernel-per-CPU-kthreads.txt rename to Documentation/kernel-per-CPU-kthreads.rst index 5623b9916411..765c7b9bd7fd 100644 --- a/Documentation/kernel-per-CPU-kthreads.txt +++ b/Documentation/kernel-per-CPU-kthreads.rst @@ -1,3 +1,5 @@ +:orphan: + ========================================== Reducing OS jitter due to per-cpu kthreads ========================================== @@ -10,7 +12,7 @@ them to a "housekeeping" CPU dedicated to such work. References ========== -- Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs. +- Documentation/IRQ-affinity.rst: Binding interrupts to sets of CPUs. - Documentation/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. diff --git a/Documentation/kobject.txt b/Documentation/kobject.rst similarity index 99% rename from Documentation/kobject.txt rename to Documentation/kobject.rst index ff4c25098119..6117192bf3e6 100644 --- a/Documentation/kobject.txt +++ b/Documentation/kobject.rst @@ -1,3 +1,5 @@ +:orphan: + ===================================================================== Everything you never wanted to know about kobjects, ksets, and ktypes ===================================================================== @@ -210,7 +212,7 @@ statically and will warn the developer of this improper usage. If all that you want to use a kobject for is to provide a reference counter for your structure, please use the struct kref instead; a kobject would be overkill. For more information on how to use struct kref, please see the -file Documentation/kref.txt in the Linux kernel source tree. +file Documentation/kref.rst in the Linux kernel source tree. Creating "simple" kobjects @@ -270,7 +272,7 @@ such a method has a form like:: void my_object_release(struct kobject *kobj) { - struct my_object *mine = container_of(kobj, struct my_object, kobj); + struct my_object *mine = container_of(kobj, struct my_object, kobj); /* Perform any additional cleanup on this object, then... */ kfree(mine); diff --git a/Documentation/kprobes.txt b/Documentation/kprobes.rst similarity index 99% rename from Documentation/kprobes.txt rename to Documentation/kprobes.rst index 8baab8832c5b..6c0011755e68 100644 --- a/Documentation/kprobes.txt +++ b/Documentation/kprobes.rst @@ -1,3 +1,5 @@ +:orphan: + ======================= Kernel Probes (Kprobes) ======================= @@ -798,4 +800,3 @@ unoptimized, and any new probes registered after that will not be optimized. Note that this knob *changes* the optimized state. This means that optimized probes (marked [OPTIMIZED]) will be unoptimized ([OPTIMIZED] tag will be removed). If the knob is turned on, they will be optimized again. - diff --git a/Documentation/kref.txt b/Documentation/kref.rst similarity index 99% rename from Documentation/kref.txt rename to Documentation/kref.rst index 3af384156d7e..470e3c1bacdc 100644 --- a/Documentation/kref.txt +++ b/Documentation/kref.rst @@ -1,3 +1,5 @@ +:orphan: + =================================================== Adding reference counters (krefs) to kernel objects =================================================== diff --git a/Documentation/laptops/thinkpad-acpi.rst b/Documentation/laptops/thinkpad-acpi.rst index 19d52fc3c5e9..d0f0d16c21b9 100644 --- a/Documentation/laptops/thinkpad-acpi.rst +++ b/Documentation/laptops/thinkpad-acpi.rst @@ -643,7 +643,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_bluetooth_sw": refer to - Documentation/rfkill.txt for details. + Documentation/rfkill.rst for details. Video output control -- /proc/acpi/ibm/video @@ -1406,7 +1406,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_wwan_sw": refer to - Documentation/rfkill.txt for details. + Documentation/rfkill.rst for details. EXPERIMENTAL: UWB @@ -1426,7 +1426,7 @@ Sysfs notes ^^^^^^^^^^^ rfkill controller switch "tpacpi_uwb_sw": refer to - Documentation/rfkill.txt for details. + Documentation/rfkill.rst for details. Adaptive keyboard ----------------- diff --git a/Documentation/ldm.txt b/Documentation/ldm.rst similarity index 98% rename from Documentation/ldm.txt rename to Documentation/ldm.rst index 12c571368e73..1e8739669541 100644 --- a/Documentation/ldm.txt +++ b/Documentation/ldm.rst @@ -1,3 +1,5 @@ +:orphan: + ========================================== LDM - Logical Disk Manager (Dynamic Disks) ========================================== @@ -75,7 +77,7 @@ When Linux boots, you will see something like:: Compiling LDM Support --------------------- -To enable LDM, choose the following two options: +To enable LDM, choose the following two options: - "Advanced partition selection" CONFIG_PARTITION_ADVANCED - "Windows Logical Disk Manager (Dynamic Disk) support" CONFIG_LDM_PARTITION @@ -118,4 +120,3 @@ me. Cheers, FlatCap - Richard Russon ldm@flatcap.org - diff --git a/Documentation/locking/rt-mutex.rst b/Documentation/locking/rt-mutex.rst index c365dc302081..6e3dcff802f9 100644 --- a/Documentation/locking/rt-mutex.rst +++ b/Documentation/locking/rt-mutex.rst @@ -4,7 +4,7 @@ RT-mutex subsystem with PI support RT-mutexes with priority inheritance are used to support PI-futexes, which enable pthread_mutex_t priority inheritance attributes -(PTHREAD_PRIO_INHERIT). [See Documentation/pi-futex.txt for more details +(PTHREAD_PRIO_INHERIT). [See Documentation/pi-futex.rst for more details about PI-futexes.] This technology was developed in the -rt tree and streamlined for diff --git a/Documentation/lockup-watchdogs.txt b/Documentation/lockup-watchdogs.rst similarity index 99% rename from Documentation/lockup-watchdogs.txt rename to Documentation/lockup-watchdogs.rst index 290840c160af..a60598bfd50f 100644 --- a/Documentation/lockup-watchdogs.txt +++ b/Documentation/lockup-watchdogs.rst @@ -1,3 +1,5 @@ +:orphan: + =============================================================== Softlockup detector and hardlockup detector (aka nmi_watchdog) =============================================================== diff --git a/Documentation/lsm.txt b/Documentation/lsm.rst similarity index 99% rename from Documentation/lsm.txt rename to Documentation/lsm.rst index ad4dfd020e0d..4f0b1a6ea76c 100644 --- a/Documentation/lsm.txt +++ b/Documentation/lsm.rst @@ -1,3 +1,5 @@ +:orphan: + ======================================================== Linux Security Modules: General Security Hooks for Linux ======================================================== diff --git a/Documentation/lzo.txt b/Documentation/lzo.rst similarity index 99% rename from Documentation/lzo.txt rename to Documentation/lzo.rst index ca983328976b..36965db785af 100644 --- a/Documentation/lzo.txt +++ b/Documentation/lzo.rst @@ -1,3 +1,5 @@ +:orphan: + =========================================================== LZO stream format as understood by Linux's LZO decompressor =========================================================== diff --git a/Documentation/mailbox.txt b/Documentation/mailbox.rst similarity index 99% rename from Documentation/mailbox.txt rename to Documentation/mailbox.rst index 0ed95009cc30..02e754db3567 100644 --- a/Documentation/mailbox.txt +++ b/Documentation/mailbox.rst @@ -1,3 +1,5 @@ +:orphan: + ============================ The Common Mailbox Framework ============================ diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt index f4170aae1d75..4a44f00478db 100644 --- a/Documentation/memory-barriers.txt +++ b/Documentation/memory-barriers.txt @@ -549,8 +549,8 @@ There are certain things that the Linux kernel memory barriers do not guarantee: [*] For information on bus mastering DMA and coherency please read: Documentation/PCI/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/DMA-API-HOWTO.rst + Documentation/DMA-API.rst DATA DEPENDENCY BARRIERS (HISTORICAL) @@ -1933,7 +1933,7 @@ There are some more advanced barrier functions: here. See the subsection "Kernel I/O barrier effects" for more information on - relaxed I/O accessors and the Documentation/DMA-API.txt file for more + relaxed I/O accessors and the Documentation/DMA-API.rst file for more information on consistent memory. diff --git a/Documentation/men-chameleon-bus.txt b/Documentation/men-chameleon-bus.rst similarity index 99% rename from Documentation/men-chameleon-bus.txt rename to Documentation/men-chameleon-bus.rst index 1b1f048aa748..2d6175229e58 100644 --- a/Documentation/men-chameleon-bus.txt +++ b/Documentation/men-chameleon-bus.rst @@ -1,3 +1,5 @@ +:orphan: + ================= MEN Chameleon Bus ================= diff --git a/Documentation/networking/scaling.rst b/Documentation/networking/scaling.rst index f78d7bf27ff5..05f0feb99320 100644 --- a/Documentation/networking/scaling.rst +++ b/Documentation/networking/scaling.rst @@ -81,7 +81,7 @@ of queues to IRQs can be determined from /proc/interrupts. By default, an IRQ may be handled on any CPU. Because a non-negligible part of packet processing takes place in receive interrupt handling, it is advantageous to spread receive interrupts between CPUs. To manually adjust the IRQ -affinity of each interrupt see Documentation/IRQ-affinity.txt. Some systems +affinity of each interrupt see Documentation/IRQ-affinity.rst. Some systems will be running irqbalance, a daemon that dynamically optimizes IRQ assignments and as a result may override any manual settings. @@ -160,7 +160,7 @@ can be configured for each receive queue using a sysfs file entry:: This file implements a bitmap of CPUs. RPS is disabled when it is zero (the default), in which case packets are processed on the interrupting -CPU. Documentation/IRQ-affinity.txt explains how CPUs are assigned to +CPU. Documentation/IRQ-affinity.rst explains how CPUs are assigned to the bitmap. diff --git a/Documentation/nommu-mmap.txt b/Documentation/nommu-mmap.rst similarity index 99% rename from Documentation/nommu-mmap.txt rename to Documentation/nommu-mmap.rst index 530fed08de2c..f7f75813dc9c 100644 --- a/Documentation/nommu-mmap.txt +++ b/Documentation/nommu-mmap.rst @@ -1,3 +1,5 @@ +:orphan: + ============================= No-MMU memory mapping support ============================= diff --git a/Documentation/ntb.txt b/Documentation/ntb.rst similarity index 99% rename from Documentation/ntb.txt rename to Documentation/ntb.rst index 87d1372da879..a25e7814b898 100644 --- a/Documentation/ntb.txt +++ b/Documentation/ntb.rst @@ -1,3 +1,5 @@ +:orphan: + =========== NTB Drivers =========== diff --git a/Documentation/numastat.txt b/Documentation/numastat.rst similarity index 99% rename from Documentation/numastat.txt rename to Documentation/numastat.rst index aaf1667489f8..762925cfe882 100644 --- a/Documentation/numastat.txt +++ b/Documentation/numastat.rst @@ -1,3 +1,5 @@ +:orphan: + =============================== Numa policy hit/miss statistics =============================== @@ -27,4 +29,3 @@ interleave_hit Interleaving wanted to allocate from this node For easier reading you can use the numastat utility from the numactl package (http://oss.sgi.com/projects/libnuma/). Note that it only works well right now on machines with a small number of CPUs. - diff --git a/Documentation/padata.txt b/Documentation/padata.rst similarity index 99% rename from Documentation/padata.txt rename to Documentation/padata.rst index b103d0c82000..f8369d18c846 100644 --- a/Documentation/padata.txt +++ b/Documentation/padata.rst @@ -1,3 +1,5 @@ +:orphan: + ======================================= The padata parallel execution mechanism ======================================= diff --git a/Documentation/parport-lowlevel.txt b/Documentation/parport-lowlevel.rst similarity index 99% rename from Documentation/parport-lowlevel.txt rename to Documentation/parport-lowlevel.rst index 0633d70ffda7..b8574d83d328 100644 --- a/Documentation/parport-lowlevel.txt +++ b/Documentation/parport-lowlevel.rst @@ -1,3 +1,5 @@ +:orphan: + =============================== PARPORT interface documentation =============================== diff --git a/Documentation/percpu-rw-semaphore.txt b/Documentation/percpu-rw-semaphore.rst similarity index 99% rename from Documentation/percpu-rw-semaphore.txt rename to Documentation/percpu-rw-semaphore.rst index 247de6410855..5c39c88d3719 100644 --- a/Documentation/percpu-rw-semaphore.txt +++ b/Documentation/percpu-rw-semaphore.rst @@ -1,3 +1,5 @@ +:orphan: + ==================== Percpu rw semaphores ==================== diff --git a/Documentation/phy.txt b/Documentation/phy.rst similarity index 99% rename from Documentation/phy.txt rename to Documentation/phy.rst index 457c3e0f86d6..129a45ccc857 100644 --- a/Documentation/phy.txt +++ b/Documentation/phy.rst @@ -1,3 +1,5 @@ +:orphan: + ============= PHY subsystem ============= diff --git a/Documentation/pi-futex.txt b/Documentation/pi-futex.rst similarity index 99% rename from Documentation/pi-futex.txt rename to Documentation/pi-futex.rst index c33ba2befbf8..884ba7f2aa10 100644 --- a/Documentation/pi-futex.txt +++ b/Documentation/pi-futex.rst @@ -1,3 +1,5 @@ +:orphan: + ====================== Lightweight PI-futexes ====================== diff --git a/Documentation/pnp.txt b/Documentation/pnp.rst similarity index 98% rename from Documentation/pnp.txt rename to Documentation/pnp.rst index bab2d10631f0..ef84f35a9b47 100644 --- a/Documentation/pnp.txt +++ b/Documentation/pnp.rst @@ -1,3 +1,5 @@ +:orphan: + ================================= Linux Plug and Play Documentation ================================= @@ -10,7 +12,7 @@ Overview -------- Plug and Play provides a means of detecting and setting resources for legacy or -otherwise unconfigurable devices. The Linux Plug and Play Layer provides these +otherwise unconfigurable devices. The Linux Plug and Play Layer provides these services to compatible drivers. @@ -18,7 +20,7 @@ The User Interface ------------------ The Linux Plug and Play user interface provides a means to activate PnP devices -for legacy and user level drivers that do not support Linux Plug and Play. The +for legacy and user level drivers that do not support Linux Plug and Play. The user interface is integrated into sysfs. In addition to the standard sysfs file the following are created in each @@ -113,9 +115,9 @@ The Unified Plug and Play Layer ------------------------------- All Plug and Play drivers, protocols, and services meet at a central location -called the Plug and Play Layer. This layer is responsible for the exchange of -information between PnP drivers and PnP protocols. Thus it automatically -forwards commands to the proper protocol. This makes writing PnP drivers +called the Plug and Play Layer. This layer is responsible for the exchange of +information between PnP drivers and PnP protocols. Thus it automatically +forwards commands to the proper protocol. This makes writing PnP drivers significantly easier. The following functions are available from the Plug and Play Layer: @@ -289,4 +291,3 @@ They are as follows:: unsigned short vendor, unsigned short function, struct pnp_dev *from) - diff --git a/Documentation/preempt-locking.txt b/Documentation/preempt-locking.rst similarity index 99% rename from Documentation/preempt-locking.txt rename to Documentation/preempt-locking.rst index dce336134e54..4dfa1512a75b 100644 --- a/Documentation/preempt-locking.txt +++ b/Documentation/preempt-locking.rst @@ -1,3 +1,5 @@ +:orphan: + =========================================================================== Proper Locking Under a Preemptible Kernel: Keeping Kernel Code Preempt-Safe =========================================================================== @@ -16,7 +18,7 @@ requires explicit additional locking for very few additional situations. This document is for all kernel hackers. Developing code in the kernel requires protecting these situations. - + RULE #1: Per-CPU data structures need explicit protection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Documentation/pwm.txt b/Documentation/pwm.rst similarity index 99% rename from Documentation/pwm.txt rename to Documentation/pwm.rst index 8fbf0aa3ba2d..78d06b7f5427 100644 --- a/Documentation/pwm.txt +++ b/Documentation/pwm.rst @@ -1,3 +1,5 @@ +:orphan: + ====================================== Pulse Width Modulation (PWM) interface ====================================== diff --git a/Documentation/rbtree.txt b/Documentation/rbtree.rst similarity index 94% rename from Documentation/rbtree.txt rename to Documentation/rbtree.rst index 523d54b60087..c0cbda408050 100644 --- a/Documentation/rbtree.txt +++ b/Documentation/rbtree.rst @@ -1,3 +1,5 @@ +:orphan: + ================================= Red-black Trees (rbtree) in Linux ================================= @@ -62,8 +64,8 @@ Creating a new rbtree Data nodes in an rbtree tree are structures containing a struct rb_node member:: struct mytype { - struct rb_node node; - char *keystring; + struct rb_node node; + char *keystring; }; When dealing with a pointer to the embedded struct rb_node, the containing data @@ -85,20 +87,20 @@ Example:: struct mytype *my_search(struct rb_root *root, char *string) { - struct rb_node *node = root->rb_node; + struct rb_node *node = root->rb_node; - while (node) { - struct mytype *data = container_of(node, struct mytype, node); + while (node) { + struct mytype *data = container_of(node, struct mytype, node); int result; result = strcmp(string, data->keystring); if (result < 0) - node = node->rb_left; + node = node->rb_left; else if (result > 0) - node = node->rb_right; + node = node->rb_right; else - return data; + return data; } return NULL; } @@ -117,25 +119,25 @@ Example:: int my_insert(struct rb_root *root, struct mytype *data) { - struct rb_node **new = &(root->rb_node), *parent = NULL; + struct rb_node **new = &(root->rb_node), *parent = NULL; - /* Figure out where to put new node */ - while (*new) { - struct mytype *this = container_of(*new, struct mytype, node); - int result = strcmp(data->keystring, this->keystring); + /* Figure out where to put new node */ + while (*new) { + struct mytype *this = container_of(*new, struct mytype, node); + int result = strcmp(data->keystring, this->keystring); parent = *new; - if (result < 0) - new = &((*new)->rb_left); - else if (result > 0) - new = &((*new)->rb_right); - else - return FALSE; - } + if (result < 0) + new = &((*new)->rb_left); + else if (result > 0) + new = &((*new)->rb_right); + else + return FALSE; + } - /* Add new node and rebalance tree. */ - rb_link_node(&data->node, parent, new); - rb_insert_color(&data->node, root); + /* Add new node and rebalance tree. */ + rb_link_node(&data->node, parent, new); + rb_insert_color(&data->node, root); return TRUE; } @@ -152,14 +154,14 @@ Example:: struct mytype *data = mysearch(&mytree, "walrus"); if (data) { - rb_erase(&data->node, &mytree); - myfree(data); + rb_erase(&data->node, &mytree); + myfree(data); } To replace an existing node in a tree with a new one with the same key, call:: void rb_replace_node(struct rb_node *old, struct rb_node *new, - struct rb_root *tree); + struct rb_root *tree); Replacing a node this way does not re-sort the tree: If the new node doesn't have the same key as the old node, the rbtree will probably become corrupted. diff --git a/Documentation/remoteproc.txt b/Documentation/remoteproc.rst similarity index 99% rename from Documentation/remoteproc.txt rename to Documentation/remoteproc.rst index 77fb03acdbb4..71eb7728fcf3 100644 --- a/Documentation/remoteproc.txt +++ b/Documentation/remoteproc.rst @@ -1,3 +1,5 @@ +:orphan: + ========================== Remote Processor Framework ========================== @@ -22,7 +24,7 @@ for remote processors that supports this kind of communication. This way, platform-specific remoteproc drivers only need to provide a few low-level handlers, and then all rpmsg drivers will then just work (for more information about the virtio-based rpmsg bus and its drivers, -please read Documentation/rpmsg.txt). +please read Documentation/rpmsg.rst). Registration of other types of virtio devices is now also possible. Firmwares just need to publish what kind of virtio devices do they support, and then remoteproc will add those devices. This makes it possible to reuse the diff --git a/Documentation/rfkill.txt b/Documentation/rfkill.rst similarity index 99% rename from Documentation/rfkill.txt rename to Documentation/rfkill.rst index 7d3684e81df6..4da9994e9bb4 100644 --- a/Documentation/rfkill.txt +++ b/Documentation/rfkill.rst @@ -1,3 +1,5 @@ +:orphan: + =============================== rfkill - RF kill switch support =============================== diff --git a/Documentation/robust-futex-ABI.txt b/Documentation/robust-futex-ABI.rst similarity index 99% rename from Documentation/robust-futex-ABI.txt rename to Documentation/robust-futex-ABI.rst index 8a5d34abf726..6d359b46610c 100644 --- a/Documentation/robust-futex-ABI.txt +++ b/Documentation/robust-futex-ABI.rst @@ -1,3 +1,5 @@ +:orphan: + ==================== The robust futex ABI ==================== diff --git a/Documentation/robust-futexes.txt b/Documentation/robust-futexes.rst similarity index 99% rename from Documentation/robust-futexes.txt rename to Documentation/robust-futexes.rst index 6361fb01c9c1..20beef77597a 100644 --- a/Documentation/robust-futexes.txt +++ b/Documentation/robust-futexes.rst @@ -1,3 +1,5 @@ +:orphan: + ======================================== A description of what robust futexes are ======================================== diff --git a/Documentation/rpmsg.txt b/Documentation/rpmsg.rst similarity index 99% rename from Documentation/rpmsg.txt rename to Documentation/rpmsg.rst index 24b7a9e1a5f9..ad53931f3e43 100644 --- a/Documentation/rpmsg.txt +++ b/Documentation/rpmsg.rst @@ -1,3 +1,5 @@ +:orphan: + ============================================ Remote Processor Messaging (rpmsg) Framework ============================================ diff --git a/Documentation/rtc.txt b/Documentation/rtc.rst similarity index 99% rename from Documentation/rtc.txt rename to Documentation/rtc.rst index 688c95b11919..6893bb5cf0ef 100644 --- a/Documentation/rtc.txt +++ b/Documentation/rtc.rst @@ -1,3 +1,5 @@ +:orphan: + ======================================= Real Time Clock (RTC) Drivers for Linux ======================================= @@ -86,9 +88,9 @@ a different value to /proc/sys/dev/rtc/max-user-freq. Note that the interrupt handler is only a few lines of code to minimize any possibility of this effect. -Also, if the kernel time is synchronized with an external source, the -kernel will write the time back to the CMOS clock every 11 minutes. In -the process of doing this, the kernel briefly turns off RTC periodic +Also, if the kernel time is synchronized with an external source, the +kernel will write the time back to the CMOS clock every 11 minutes. In +the process of doing this, the kernel briefly turns off RTC periodic interrupts, so be aware of this if you are doing serious work. If you don't synchronize the kernel time with an external source (via ntp or whatever) then the kernel will keep its hands off the RTC, allowing you diff --git a/Documentation/s390/vfio-ccw.rst b/Documentation/s390/vfio-ccw.rst index 1f6d0b56d53e..87b5bb49b2f3 100644 --- a/Documentation/s390/vfio-ccw.rst +++ b/Documentation/s390/vfio-ccw.rst @@ -38,7 +38,7 @@ every detail. More information/reference could be found here: qemu/hw/s390x/css.c For vfio mediated device framework: -- Documentation/vfio-mediated-device.txt +- Documentation/vfio-mediated-device.rst Motivation of vfio-ccw ---------------------- @@ -322,5 +322,5 @@ Reference 2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204) 3. https://en.wikipedia.org/wiki/Channel_I/O 4. Documentation/s390/cds.rst -5. Documentation/vfio.txt -6. Documentation/vfio-mediated-device.txt +5. Documentation/vfio.rst +6. Documentation/vfio-mediated-device.rst diff --git a/Documentation/sgi-ioc4.txt b/Documentation/sgi-ioc4.rst similarity index 99% rename from Documentation/sgi-ioc4.txt rename to Documentation/sgi-ioc4.rst index 72709222d3c0..e6ed2e9b055b 100644 --- a/Documentation/sgi-ioc4.txt +++ b/Documentation/sgi-ioc4.rst @@ -1,3 +1,5 @@ +:orphan: + ==================================== SGI IOC4 PCI (multi function) device ==================================== diff --git a/Documentation/siphash.txt b/Documentation/siphash.rst similarity index 99% rename from Documentation/siphash.txt rename to Documentation/siphash.rst index 9965821ab333..833eef3a7956 100644 --- a/Documentation/siphash.txt +++ b/Documentation/siphash.rst @@ -1,3 +1,5 @@ +:orphan: + =========================== SipHash - a short input PRF =========================== diff --git a/Documentation/smsc_ece1099.txt b/Documentation/smsc_ece1099.rst similarity index 99% rename from Documentation/smsc_ece1099.txt rename to Documentation/smsc_ece1099.rst index 079277421eaf..a403fcd7c64d 100644 --- a/Documentation/smsc_ece1099.txt +++ b/Documentation/smsc_ece1099.rst @@ -1,3 +1,5 @@ +:orphan: + ================================================= Msc Keyboard Scan Expansion/GPIO Expansion device ================================================= diff --git a/Documentation/speculation.txt b/Documentation/speculation.rst similarity index 99% rename from Documentation/speculation.txt rename to Documentation/speculation.rst index 50d7ea857cff..e240f01b0983 100644 --- a/Documentation/speculation.txt +++ b/Documentation/speculation.rst @@ -1,3 +1,5 @@ +:orphan: + This document explains potential effects of speculation, and how undesirable effects can be mitigated portably using common APIs. diff --git a/Documentation/static-keys.txt b/Documentation/static-keys.rst similarity index 99% rename from Documentation/static-keys.txt rename to Documentation/static-keys.rst index 9803e14639bf..bdf545e3a37f 100644 --- a/Documentation/static-keys.txt +++ b/Documentation/static-keys.rst @@ -1,3 +1,5 @@ +:orphan: + =========== Static Keys =========== diff --git a/Documentation/svga.txt b/Documentation/svga.rst similarity index 99% rename from Documentation/svga.txt rename to Documentation/svga.rst index b6c2f9acca92..1bfd54d9fb59 100644 --- a/Documentation/svga.txt +++ b/Documentation/svga.rst @@ -1,3 +1,5 @@ +:orphan: + .. include:: ================================= diff --git a/Documentation/switchtec.txt b/Documentation/switchtec.rst similarity index 98% rename from Documentation/switchtec.txt rename to Documentation/switchtec.rst index 30d6a64e53f7..6879c92de8e2 100644 --- a/Documentation/switchtec.txt +++ b/Documentation/switchtec.rst @@ -1,3 +1,5 @@ +:orphan: + ======================== Linux Switchtec Support ======================== @@ -97,6 +99,6 @@ the following configuration settings: NT EP BAR 2 will be dynamically configured as a Direct Window, and the configuration file does not need to configure it explicitly. -Please refer to Documentation/ntb.txt in Linux source tree for an overall +Please refer to Documentation/ntb.rst in Linux source tree for an overall understanding of the Linux NTB stack. ntb_hw_switchtec works as an NTB Hardware Driver in this stack. diff --git a/Documentation/sync_file.txt b/Documentation/sync_file.rst similarity index 99% rename from Documentation/sync_file.txt rename to Documentation/sync_file.rst index 496fb2c3b3e6..a65a67cc06fa 100644 --- a/Documentation/sync_file.txt +++ b/Documentation/sync_file.rst @@ -1,3 +1,5 @@ +:orphan: + =================== Sync File API Guide =================== diff --git a/Documentation/sysctl/kernel.txt b/Documentation/sysctl/kernel.txt index 92f7f34b021a..e6139d88f819 100644 --- a/Documentation/sysctl/kernel.txt +++ b/Documentation/sysctl/kernel.txt @@ -44,7 +44,7 @@ show up in /proc/sys/kernel: - kexec_load_disabled - kptr_restrict - l2cr [ PPC only ] -- modprobe ==> Documentation/debugging-modules.txt +- modprobe ==> Documentation/debugging-modules.rst - modules_disabled - msg_next_id [ sysv ipc ] - msgmax @@ -327,7 +327,7 @@ when a hard lockup is detected. 0 - don't panic on hard lockup 1 - panic on hard lockup -See Documentation/lockup-watchdogs.txt for more information. This can +See Documentation/lockup-watchdogs.rst for more information. This can also be set using the nmi_watchdog kernel parameter. ============================================================== diff --git a/Documentation/sysctl/vm.txt b/Documentation/sysctl/vm.txt index c5f0d44433a2..046691580ba6 100644 --- a/Documentation/sysctl/vm.txt +++ b/Documentation/sysctl/vm.txt @@ -566,7 +566,7 @@ trimming of allocations is initiated. The default value is 1. -See Documentation/nommu-mmap.txt for more information. +See Documentation/nommu-mmap.rst for more information. ============================================================== diff --git a/Documentation/tee.txt b/Documentation/tee.rst similarity index 99% rename from Documentation/tee.txt rename to Documentation/tee.rst index afacdf2fd1de..5eacffb823b5 100644 --- a/Documentation/tee.txt +++ b/Documentation/tee.rst @@ -1,3 +1,5 @@ +:orphan: + ============= TEE subsystem ============= diff --git a/Documentation/this_cpu_ops.txt b/Documentation/this_cpu_ops.rst similarity index 99% rename from Documentation/this_cpu_ops.txt rename to Documentation/this_cpu_ops.rst index 5cb8b883ae83..a489d25ff549 100644 --- a/Documentation/this_cpu_ops.txt +++ b/Documentation/this_cpu_ops.rst @@ -1,3 +1,5 @@ +:orphan: + =================== this_cpu operations =================== diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst index 89ba487d4399..74f698affea1 100644 --- a/Documentation/trace/kprobetrace.rst +++ b/Documentation/trace/kprobetrace.rst @@ -40,7 +40,7 @@ Synopsis of kprobe_events MEMADDR : Address where the probe is inserted. MAXACTIVE : Maximum number of instances of the specified function that can be probed simultaneously, or 0 for the default value - as defined in Documentation/kprobes.txt section 1.3.1. + as defined in Documentation/kprobes.rst section 1.3.1. FETCHARGS : Arguments. Each probe can have up to 128 args. %REG : Fetch register REG diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt index 07725b1df002..03c06a7800c3 100644 --- a/Documentation/translations/ko_KR/memory-barriers.txt +++ b/Documentation/translations/ko_KR/memory-barriers.txt @@ -570,8 +570,8 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE [*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다: Documentation/PCI/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/DMA-API-HOWTO.rst + Documentation/DMA-API.rst 데이터 의존성 배리어 (역사적) @@ -1904,7 +1904,7 @@ Mandatory 배리어들은 SMP 시스템에서도 UP 시스템에서도 SMP 효 writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는 "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을 - 위해선 Documentation/DMA-API.txt 문서를 참고하세요. + 위해선 Documentation/DMA-API.rst 문서를 참고하세요. MMIO 쓰기 배리어 diff --git a/Documentation/translations/zh_CN/IRQ.txt b/Documentation/translations/zh_CN/IRQ.txt index 956026d5cf82..0d9ec142e185 100644 --- a/Documentation/translations/zh_CN/IRQ.txt +++ b/Documentation/translations/zh_CN/IRQ.txt @@ -1,4 +1,4 @@ -Chinese translated version of Documentation/IRQ.txt +Chinese translated version of Documentation/IRQ.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem @@ -9,7 +9,7 @@ or if there is a problem with the translation. Maintainer: Eric W. Biederman Chinese maintainer: Fu Wei --------------------------------------------------------------------- -Documentation/IRQ.txt 的中文翻译 +Documentation/IRQ.rst 的中文翻译 如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 diff --git a/Documentation/translations/zh_CN/filesystems/sysfs.txt b/Documentation/translations/zh_CN/filesystems/sysfs.txt index 452271dda141..f5482e082399 100644 --- a/Documentation/translations/zh_CN/filesystems/sysfs.txt +++ b/Documentation/translations/zh_CN/filesystems/sysfs.txt @@ -40,7 +40,7 @@ sysfs 是一个最初基于 ramfs 且位于内存的文件系统。它提供导 数据结构及其属性，以及它们之间的关联到用户空间的方法。 sysfs 始终与 kobject 的底层结构紧密相关。请阅读 -Documentation/kobject.txt 文档以获得更多关于 kobject 接口的 +Documentation/kobject.rst 文档以获得更多关于 kobject 接口的 信息。 diff --git a/Documentation/translations/zh_CN/io_ordering.txt b/Documentation/translations/zh_CN/io_ordering.txt index 1f8127bdd415..4e9727990c10 100644 --- a/Documentation/translations/zh_CN/io_ordering.txt +++ b/Documentation/translations/zh_CN/io_ordering.txt @@ -1,4 +1,4 @@ -Chinese translated version of Documentation/io_ordering.txt +Chinese translated version of Documentation/io_ordering.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem @@ -8,7 +8,7 @@ or if there is a problem with the translation. Chinese maintainer: Lin Yongting --------------------------------------------------------------------- -Documentation/io_ordering.txt 的中文翻译 +Documentation/io_ordering.rst 的中文翻译 如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 diff --git a/Documentation/unaligned-memory-access.txt b/Documentation/unaligned-memory-access.rst similarity index 99% rename from Documentation/unaligned-memory-access.txt rename to Documentation/unaligned-memory-access.rst index 1ee82419d8aa..848013a8bc10 100644 --- a/Documentation/unaligned-memory-access.txt +++ b/Documentation/unaligned-memory-access.rst @@ -1,3 +1,5 @@ +:orphan: + ========================= Unaligned Memory Accesses ========================= diff --git a/Documentation/vfio-mediated-device.txt b/Documentation/vfio-mediated-device.rst similarity index 99% rename from Documentation/vfio-mediated-device.txt rename to Documentation/vfio-mediated-device.rst index c3f69bcaf96e..0ea57427e7e6 100644 --- a/Documentation/vfio-mediated-device.txt +++ b/Documentation/vfio-mediated-device.rst @@ -1,3 +1,5 @@ +:orphan: + .. include:: ===================== @@ -408,7 +410,7 @@ card. References ========== -1. See Documentation/vfio.txt for more information on VFIO. +1. See Documentation/vfio.rst for more information on VFIO. 2. struct mdev_driver in include/linux/mdev.h 3. struct mdev_parent_ops in include/linux/mdev.h 4. struct vfio_iommu_driver_ops in include/linux/vfio.h diff --git a/Documentation/vfio.txt b/Documentation/vfio.rst similarity index 99% rename from Documentation/vfio.txt rename to Documentation/vfio.rst index f1a4d3c3ba0b..8a3fbd7d96f0 100644 --- a/Documentation/vfio.txt +++ b/Documentation/vfio.rst @@ -1,3 +1,5 @@ +:orphan: + ================================== VFIO - "Virtual Function I/O" [1]_ ================================== diff --git a/Documentation/video-output.txt b/Documentation/video-output.rst similarity index 99% rename from Documentation/video-output.txt rename to Documentation/video-output.rst index 56d6fa2e2368..9095c4be45e5 100644 --- a/Documentation/video-output.txt +++ b/Documentation/video-output.rst @@ -1,3 +1,5 @@ +:orphan: + Video Output Switcher Control ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -31,4 +33,3 @@ method for 'state' with output sysfs class. The user interface under sysfs is:: |-- state |-- subsystem -> ../../../class/video_output `-- uevent - diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst index 94a96371113e..f4ba329f011f 100644 --- a/Documentation/watchdog/hpwdt.rst +++ b/Documentation/watchdog/hpwdt.rst @@ -44,7 +44,7 @@ Last reviewed: 08/20/2018 NOTE: More information about watchdog drivers in general, including the ioctl interface to /dev/watchdog can be found in - Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.txt. + Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.rst. Due to limitations in the iLO hardware, the NMI pretimeout if enabled, can only be set to 9 seconds. Attempts to set pretimeout to other diff --git a/Documentation/x86/topology.rst b/Documentation/x86/topology.rst index 8e9704f61017..b06d895becce 100644 --- a/Documentation/x86/topology.rst +++ b/Documentation/x86/topology.rst @@ -9,7 +9,7 @@ representation in the kernel. Update/change when doing changes to the respective code. The architecture-agnostic topology definitions are in -Documentation/cputopology.txt. This file holds x86-specific +Documentation/cputopology.rst. This file holds x86-specific differences/specialities which must not necessarily apply to the generic definitions. Thus, the way to read up on Linux topology on x86 is to start with the generic one and look at this one in parallel for the x86 specifics. diff --git a/Documentation/xillybus.txt b/Documentation/xillybus.rst similarity index 99% rename from Documentation/xillybus.txt rename to Documentation/xillybus.rst index 2446ee303c09..d99f4a37e8b6 100644 --- a/Documentation/xillybus.txt +++ b/Documentation/xillybus.rst @@ -1,3 +1,5 @@ +:orphan: + ========================================== Xillybus driver for generic FPGA interface ========================================== diff --git a/Documentation/xz.txt b/Documentation/xz.rst similarity index 99% rename from Documentation/xz.txt rename to Documentation/xz.rst index b2220d03aa50..205edc6646d5 100644 --- a/Documentation/xz.txt +++ b/Documentation/xz.rst @@ -1,3 +1,5 @@ +:orphan: + ============================ XZ data compression in Linux ============================ diff --git a/Documentation/zorro.txt b/Documentation/zorro.rst similarity index 99% rename from Documentation/zorro.txt rename to Documentation/zorro.rst index 664072b017e3..7cd509f31d57 100644 --- a/Documentation/zorro.txt +++ b/Documentation/zorro.rst @@ -1,3 +1,5 @@ +:orphan: + ======================================== Writing Device Drivers for Zorro Devices ======================================== @@ -77,7 +79,7 @@ The treatment of these regions depends on the type of Zorro space: - Zorro II address space is always mapped and does not have to be mapped explicitly using z_ioremap(). - + Conversion from bus/physical Zorro II addresses to kernel virtual addresses and vice versa is done using:: @@ -86,7 +88,7 @@ The treatment of these regions depends on the type of Zorro space: - Zorro III address space must be mapped explicitly using z_ioremap() first before it can be accessed:: - + virt_addr = z_ioremap(bus_addr, size); ... z_iounmap(virt_addr); @@ -101,4 +103,3 @@ References #. linux/arch/m68k/include/asm/zorro.h #. linux/drivers/zorro #. /proc/bus/zorro - diff --git a/MAINTAINERS b/MAINTAINERS index 58e103015dea..d9e214f68e52 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4588,7 +4588,7 @@ DELL SYSTEMS MANAGEMENT BASE DRIVER (dcdbas) M: Stuart Hayes L: platform-driver-x86@vger.kernel.org S: Maintained -F: Documentation/dcdbas.txt +F: Documentation/dcdbas.rst F: drivers/platform/x86/dcdbas.* DELL WMI NOTIFICATIONS DRIVER @@ -4966,7 +4966,7 @@ M: Greg Kroah-Hartman R: "Rafael J. Wysocki" T: git git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core.git S: Supported -F: Documentation/kobject.txt +F: Documentation/kobject.rst F: drivers/base/ F: fs/debugfs/ F: fs/sysfs/ @@ -6038,7 +6038,7 @@ M: Ard Biesheuvel L: linux-efi@vger.kernel.org T: git git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi.git S: Maintained -F: Documentation/efi-stub.txt +F: Documentation/efi-stub.rst F: arch/*/kernel/efi.c F: arch/x86/boot/compressed/eboot.[ch] F: arch/*/include/asm/efi.h @@ -6594,7 +6594,7 @@ S: Maintained F: scripts/gcc-plugins/ F: scripts/gcc-plugin.sh F: scripts/Makefile.gcc-plugins -F: Documentation/gcc-plugins.txt +F: Documentation/gcc-plugins.rst GASKET DRIVER FRAMEWORK M: Rob Springer @@ -7006,7 +7006,7 @@ M: Herbert Xu L: linux-crypto@vger.kernel.org S: Odd fixes F: Documentation/devicetree/bindings/rng/ -F: Documentation/hw_random.txt +F: Documentation/hw_random.rst F: drivers/char/hw_random/ F: include/linux/hw_random.h @@ -7022,7 +7022,7 @@ L: linux-remoteproc@vger.kernel.org S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/ohad/hwspinlock.git F: Documentation/devicetree/bindings/hwlock/ -F: Documentation/hwspinlock.txt +F: Documentation/hwspinlock.rst F: drivers/hwspinlock/ F: include/linux/hwspinlock.h @@ -8208,7 +8208,7 @@ L: tboot-devel@lists.sourceforge.net W: http://tboot.sourceforge.net T: hg http://tboot.hg.sourceforge.net:8000/hgroot/tboot/tboot S: Supported -F: Documentation/intel_txt.txt +F: Documentation/intel_txt.rst F: include/linux/tboot.h F: arch/x86/kernel/tboot.c @@ -8292,7 +8292,7 @@ L: openipmi-developer@lists.sourceforge.net (moderated for non-subscribers) W: http://openipmi.sourceforge.net/ S: Supported F: Documentation/devicetree/bindings/ipmi/ -F: Documentation/IPMI.txt +F: Documentation/IPMI.rst F: drivers/char/ipmi/ F: include/linux/ipmi* F: include/uapi/linux/ipmi* @@ -8333,7 +8333,7 @@ IRQ DOMAINS (IRQ NUMBER MAPPING LIBRARY) M: Marc Zyngier S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git irq/core -F: Documentation/IRQ-domain.txt +F: Documentation/IRQ-domain.rst F: include/linux/irqdomain.h F: kernel/irq/irqdomain.c F: kernel/irq/msi.c @@ -8358,7 +8358,7 @@ F: drivers/irqchip/ ISA M: William Breathitt Gray S: Maintained -F: Documentation/isa.txt +F: Documentation/isa.rst F: drivers/base/isa.c F: include/linux/isa.h @@ -8373,7 +8373,7 @@ F: drivers/media/radio/radio-isa* ISAPNP M: Jaroslav Kysela S: Maintained -F: Documentation/isapnp.txt +F: Documentation/isapnp.rst F: drivers/pnp/isapnp/ F: include/linux/isapnp.h @@ -8823,7 +8823,7 @@ M: Anil S Keshavamurthy M: "David S. Miller" M: Masami Hiramatsu S: Maintained -F: Documentation/kprobes.txt +F: Documentation/kprobes.rst F: include/linux/kprobes.h F: include/asm-generic/kprobes.h F: kernel/kprobes.c @@ -9182,7 +9182,7 @@ L: linux-arch@vger.kernel.org S: Supported T: git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git dev F: tools/memory-model/ -F: Documentation/atomic_bitops.txt +F: Documentation/atomic_bitops.rst F: Documentation/atomic_t.txt F: Documentation/core-api/atomic_ops.rst F: Documentation/core-api/refcount-vs-atomic.rst @@ -9296,7 +9296,7 @@ M: "Richard Russon (FlatCap)" L: linux-ntfs-dev@lists.sourceforge.net W: http://www.linux-ntfs.org/content/view/19/37/ S: Maintained -F: Documentation/ldm.txt +F: Documentation/ldm.rst F: block/partitions/ldm.* LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI) @@ -10240,7 +10240,7 @@ M: Johannes Thumshirn S: Maintained F: drivers/mcb/ F: include/linux/mcb.h -F: Documentation/men-chameleon-bus.txt +F: Documentation/men-chameleon-bus.rst MEN F21BMC (Board Management Controller) M: Andreas Werner @@ -11923,7 +11923,7 @@ L: linux-crypto@vger.kernel.org S: Maintained F: kernel/padata.c F: include/linux/padata.h -F: Documentation/padata.txt +F: Documentation/padata.rst PANASONIC LAPTOP ACPI EXTRAS DRIVER M: Harald Welte @@ -11947,7 +11947,7 @@ F: drivers/parport/ F: include/linux/parport*.h F: drivers/char/ppdev.c F: include/uapi/linux/ppdev.h -F: Documentation/parport*.txt +F: Documentation/parport*.rst PARAVIRT_OPS INTERFACE M: Juergen Gross @@ -12122,7 +12122,7 @@ M: Kurt Schwemmer M: Logan Gunthorpe L: linux-pci@vger.kernel.org S: Maintained -F: Documentation/switchtec.txt +F: Documentation/switchtec.rst F: Documentation/ABI/testing/sysfs-class-switchtec F: drivers/pci/switch/switchtec* F: include/uapi/linux/switchtec_ioctl.h @@ -12884,7 +12884,7 @@ M: Thierry Reding L: linux-pwm@vger.kernel.org S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/thierry.reding/linux-pwm.git -F: Documentation/pwm.txt +F: Documentation/pwm.rst F: Documentation/devicetree/bindings/pwm/ F: include/linux/pwm.h F: drivers/pwm/ @@ -13354,7 +13354,7 @@ Q: http://patchwork.ozlabs.org/project/rtc-linux/list/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux.git S: Maintained F: Documentation/devicetree/bindings/rtc/ -F: Documentation/rtc.txt +F: Documentation/rtc.rst F: drivers/rtc/ F: include/linux/rtc.h F: include/uapi/linux/rtc.h @@ -13405,7 +13405,7 @@ T: git git://git.kernel.org/pub/scm/linux/kernel/git/ohad/remoteproc.git S: Maintained F: Documentation/devicetree/bindings/remoteproc/ F: Documentation/ABI/testing/sysfs-class-remoteproc -F: Documentation/remoteproc.txt +F: Documentation/remoteproc.rst F: drivers/remoteproc/ F: include/linux/remoteproc.h F: include/linux/remoteproc/ @@ -13417,7 +13417,7 @@ L: linux-remoteproc@vger.kernel.org T: git git://git.kernel.org/pub/scm/linux/kernel/git/ohad/rpmsg.git S: Maintained F: drivers/rpmsg/ -F: Documentation/rpmsg.txt +F: Documentation/rpmsg.rst F: Documentation/ABI/testing/sysfs-bus-rpmsg F: include/linux/rpmsg.h F: include/linux/rpmsg/ @@ -13503,7 +13503,7 @@ W: http://wireless.kernel.org/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git S: Maintained -F: Documentation/rfkill.txt +F: Documentation/rfkill.rst F: Documentation/ABI/stable/sysfs-class-rfkill F: net/rfkill/ F: include/linux/rfkill.h @@ -15174,7 +15174,7 @@ SVGA HANDLING M: Martin Mares L: linux-video@atrey.karlin.mff.cuni.cz S: Maintained -F: Documentation/svga.txt +F: Documentation/svga.rst F: arch/x86/boot/video* SWIOTLB SUBSYSTEM @@ -15211,7 +15211,7 @@ F: drivers/dma-buf/dma-fence* F: drivers/dma-buf/sw_sync.c F: include/linux/sync_file.h F: include/uapi/linux/sync_file.h -F: Documentation/sync_file.txt +F: Documentation/sync_file.rst T: git git://anongit.freedesktop.org/drm/drm-misc SYNOPSYS ARC ARCHITECTURE @@ -15537,7 +15537,7 @@ S: Maintained F: include/linux/tee_drv.h F: include/uapi/linux/tee.h F: drivers/tee/ -F: Documentation/tee.txt +F: Documentation/tee.rst TEGRA ARCHITECTURE SUPPORT M: Thierry Reding @@ -16706,7 +16706,7 @@ R: Cornelia Huck L: kvm@vger.kernel.org T: git git://github.com/awilliam/linux-vfio.git S: Maintained -F: Documentation/vfio.txt +F: Documentation/vfio.rst F: drivers/vfio/ F: include/linux/vfio.h F: include/uapi/linux/vfio.h @@ -16715,7 +16715,7 @@ VFIO MEDIATED DEVICE DRIVERS M: Kirti Wankhede L: kvm@vger.kernel.org S: Maintained -F: Documentation/vfio-mediated-device.txt +F: Documentation/vfio-mediated-device.rst F: drivers/vfio/mdev/ F: include/linux/mdev.h F: samples/vfio-mdev/ diff --git a/arch/Kconfig b/arch/Kconfig index e8d19c3cb91f..c2f2bee5b17b 100644 --- a/arch/Kconfig +++ b/arch/Kconfig @@ -141,7 +141,7 @@ config HAVE_64BIT_ALIGNED_ACCESS accesses are required to be 64 bit aligned in this way even though it is not a 64 bit architecture. - See Documentation/unaligned-memory-access.txt for more + See Documentation/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config HAVE_EFFICIENT_UNALIGNED_ACCESS @@ -160,7 +160,7 @@ config HAVE_EFFICIENT_UNALIGNED_ACCESS problems with received packets if doing so would not help much. - See Documentation/unaligned-memory-access.txt for more + See Documentation/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config ARCH_USE_BUILTIN_BSWAP diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig index 71b35159b4ce..2d0a14a4286c 100644 --- a/arch/arm/Kconfig +++ b/arch/arm/Kconfig @@ -1266,7 +1266,7 @@ config SMP will run faster if you say N here. See also , - and the SMP-HOWTO available at + and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/ia64/hp/common/sba_iommu.c b/arch/ia64/hp/common/sba_iommu.c index 3d24cc43385b..8f97d42316e8 100644 --- a/arch/ia64/hp/common/sba_iommu.c +++ b/arch/ia64/hp/common/sba_iommu.c @@ -912,7 +912,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt) * @dir: dma direction * @attrs: optional dma attributes * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static dma_addr_t sba_map_page(struct device *dev, struct page *page, unsigned long poff, size_t size, @@ -1033,7 +1033,7 @@ sba_mark_clean(struct ioc *ioc, dma_addr_t iova, size_t size) * @dir: R/W or both. * @attrs: optional dma attributes * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size, enum dma_data_direction dir, unsigned long attrs) @@ -1110,7 +1110,7 @@ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size, * @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void * sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle, @@ -1167,7 +1167,7 @@ sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle, * @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void sba_free_coherent(struct device *dev, size_t size, void *vaddr, dma_addr_t dma_handle, unsigned long attrs) @@ -1430,7 +1430,7 @@ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist, * @dir: R/W or both. * @attrs: optional dma attributes * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir, @@ -1529,7 +1529,7 @@ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist, * @dir: R/W or both. * @attrs: optional dma attributes * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir, diff --git a/arch/ia64/sn/pci/pci_dma.c b/arch/ia64/sn/pci/pci_dma.c index b7d42e4edc1f..f475fccea152 100644 --- a/arch/ia64/sn/pci/pci_dma.c +++ b/arch/ia64/sn/pci/pci_dma.c @@ -5,7 +5,7 @@ * * Copyright (C) 2000,2002-2005 Silicon Graphics, Inc. All rights reserved. * - * Routines for PCI DMA mapping. See Documentation/DMA-API.txt for + * Routines for PCI DMA mapping. See Documentation/DMA-API.rst for * a description of how these routines should be used. */ @@ -72,7 +72,7 @@ EXPORT_SYMBOL(sn_dma_set_mask); * that @dma_handle will have the %PCIIO_DMA_CMD flag set. * * This interface is usually used for "command" streams (e.g. the command - * queue for a SCSI controller). See Documentation/DMA-API.txt for + * queue for a SCSI controller). See Documentation/DMA-API.rst for * more information. */ static void *sn_dma_alloc_coherent(struct device *dev, size_t size, diff --git a/arch/parisc/Kconfig b/arch/parisc/Kconfig index 4860efa91d7b..188fdf4f5080 100644 --- a/arch/parisc/Kconfig +++ b/arch/parisc/Kconfig @@ -275,7 +275,7 @@ config SMP machines, but will use only one CPU of a multiprocessor machine. On a uniprocessor machine, the kernel will run faster if you say N. - See also and the SMP-HOWTO + See also and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/parisc/kernel/pci-dma.c b/arch/parisc/kernel/pci-dma.c index 239162355b58..2bb63062f6c3 100644 --- a/arch/parisc/kernel/pci-dma.c +++ b/arch/parisc/kernel/pci-dma.c @@ -3,7 +3,7 @@ ** PARISC 1.1 Dynamic DMA mapping support. ** This implementation is for PA-RISC platforms that do not support ** I/O TLBs (aka DMA address translation hardware). -** See Documentation/DMA-API-HOWTO.txt for interface definitions. +** See Documentation/DMA-API-HOWTO.rst for interface definitions. ** ** (c) Copyright 1999,2000 Hewlett-Packard Company ** (c) Copyright 2000 Grant Grundler diff --git a/arch/sh/Kconfig b/arch/sh/Kconfig index c7c99e18d5ff..669adef94507 100644 --- a/arch/sh/Kconfig +++ b/arch/sh/Kconfig @@ -677,7 +677,7 @@ config SMP People using multiprocessor machines who say Y here should also say Y to "Enhanced Real Time Clock Support", below. - See also and the SMP-HOWTO + See also and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/sparc/Kconfig b/arch/sparc/Kconfig index 8fc95c7809ef..04a3b2246a2a 100644 --- a/arch/sparc/Kconfig +++ b/arch/sparc/Kconfig @@ -179,7 +179,7 @@ config SMP Y to "Enhanced Real Time Clock Support", below. The "Advanced Power Management" code will be disabled if you say Y here. - See also and the SMP-HOWTO + See also and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/unicore32/include/asm/io.h b/arch/unicore32/include/asm/io.h index cb1d8fd2b16b..86877df4b1ee 100644 --- a/arch/unicore32/include/asm/io.h +++ b/arch/unicore32/include/asm/io.h @@ -31,7 +31,7 @@ extern void __uc32_iounmap(volatile void __iomem *addr); * ioremap and friends. * * ioremap takes a PCI memory address, as specified in - * Documentation/io-mapping.txt. + * Documentation/io-mapping.rst. * */ #define ioremap(cookie, size) __uc32_ioremap(cookie, size) diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig index a5bee44cfb9d..0d5f0710347c 100644 --- a/arch/x86/Kconfig +++ b/arch/x86/Kconfig @@ -397,7 +397,7 @@ config SMP Management" code will be disabled if you say Y here. See also , - and the SMP-HOWTO available at + and the SMP-HOWTO available at . If you don't know what to do here, say N. @@ -1954,7 +1954,7 @@ config EFI_STUB This kernel feature allows a bzImage to be loaded directly by EFI firmware without the use of a bootloader. - See Documentation/efi-stub.txt for more information. + See Documentation/efi-stub.rst for more information. config EFI_MIXED bool "EFI mixed-mode support" diff --git a/arch/x86/include/asm/dma-mapping.h b/arch/x86/include/asm/dma-mapping.h index 6b15a24930e0..dfa443fe17c2 100644 --- a/arch/x86/include/asm/dma-mapping.h +++ b/arch/x86/include/asm/dma-mapping.h @@ -3,8 +3,8 @@ #define _ASM_X86_DMA_MAPPING_H /* - * IOMMU interface. See Documentation/DMA-API-HOWTO.txt and - * Documentation/DMA-API.txt for documentation. + * IOMMU interface. See Documentation/DMA-API-HOWTO.rst and + * Documentation/DMA-API.rst for documentation. */ #include diff --git a/arch/x86/kernel/amd_gart_64.c b/arch/x86/kernel/amd_gart_64.c index a585ea6f686a..03108de30105 100644 --- a/arch/x86/kernel/amd_gart_64.c +++ b/arch/x86/kernel/amd_gart_64.c @@ -6,7 +6,7 @@ * This allows to use PCI devices that only support 32bit addresses on systems * with more than 4GB. * - * See Documentation/DMA-API-HOWTO.txt for the interface specification. + * See Documentation/DMA-API-HOWTO.rst for the interface specification. * * Copyright 2002 Andi Kleen, SuSE Labs. */ diff --git a/block/partitions/Kconfig b/block/partitions/Kconfig index 37b9710cc80a..51b28e1e225d 100644 --- a/block/partitions/Kconfig +++ b/block/partitions/Kconfig @@ -194,7 +194,7 @@ config LDM_PARTITION Normal partitions are now called Basic Disks under Windows 2000, XP, and Vista. - For a fuller description read . + For a fuller description read . If unsure, say N. diff --git a/drivers/base/core.c b/drivers/base/core.c index b4c64528f13c..f98b33e9ec19 100644 --- a/drivers/base/core.c +++ b/drivers/base/core.c @@ -1063,7 +1063,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/kobject.rst.\n", dev_name(dev)); kfree(p); } diff --git a/drivers/char/Kconfig b/drivers/char/Kconfig index bb734066075f..ba90034f5b8f 100644 --- a/drivers/char/Kconfig +++ b/drivers/char/Kconfig @@ -291,7 +291,7 @@ config RTC and set the RTC in an SMP compatible fashion. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read + sampling), then say Y here, and read for details. To compile this driver as a module, choose M here: the @@ -313,7 +313,7 @@ config JS_RTC /dev/rtc. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read + sampling), then say Y here, and read for details. To compile this driver as a module, choose M here: the diff --git a/drivers/char/hw_random/core.c b/drivers/char/hw_random/core.c index 95be7228f327..41acde92bedc 100644 --- a/drivers/char/hw_random/core.c +++ b/drivers/char/hw_random/core.c @@ -4,7 +4,7 @@ * Copyright 2006 Michael Buesch * Copyright 2005 (c) MontaVista Software, Inc. * - * Please read Documentation/hw_random.txt for details on use. + * Please read Documentation/hw_random.rst for details on use. * * This software may be used and distributed according to the terms * of the GNU General Public License, incorporated herein by reference. diff --git a/drivers/char/ipmi/Kconfig b/drivers/char/ipmi/Kconfig index 4bad0614109b..e59ee81bc22f 100644 --- a/drivers/char/ipmi/Kconfig +++ b/drivers/char/ipmi/Kconfig @@ -14,7 +14,7 @@ menuconfig IPMI_HANDLER IPMI is a standard for managing sensors (temperature, voltage, etc.) in a system. - See for more details on the driver. + See for more details on the driver. If unsure, say N. diff --git a/drivers/char/ipmi/ipmi_si_hotmod.c b/drivers/char/ipmi/ipmi_si_hotmod.c index 42a925f8cf69..2032f4ac52ac 100644 --- a/drivers/char/ipmi/ipmi_si_hotmod.c +++ b/drivers/char/ipmi/ipmi_si_hotmod.c @@ -18,7 +18,7 @@ static int hotmod_handler(const char *val, const struct kernel_param *kp); module_param_call(hotmod, hotmod_handler, NULL, NULL, 0200); MODULE_PARM_DESC(hotmod, "Add and remove interfaces. See" - " Documentation/IPMI.txt in the kernel sources for the" + " Documentation/IPMI.rst in the kernel sources for the" " gory details."); /* diff --git a/drivers/char/ipmi/ipmi_si_intf.c b/drivers/char/ipmi/ipmi_si_intf.c index da5b6723329a..7f729609979c 100644 --- a/drivers/char/ipmi/ipmi_si_intf.c +++ b/drivers/char/ipmi/ipmi_si_intf.c @@ -977,7 +977,7 @@ static inline int ipmi_thread_busy_wait(enum si_sm_result smi_result, * that are not BT and do not have interrupts. It starts spinning * when an operation is complete or until max_busy tells it to stop * (if that is enabled). See the paragraph on kimid_max_busy_us in - * Documentation/IPMI.txt for details. + * Documentation/IPMI.rst for details. */ static int ipmi_thread(void *data) { diff --git a/drivers/dma-buf/Kconfig b/drivers/dma-buf/Kconfig index d5f915830b68..9afc7bb638c3 100644 --- a/drivers/dma-buf/Kconfig +++ b/drivers/dma-buf/Kconfig @@ -15,7 +15,7 @@ config SYNC_FILE associated with a buffer. When a job is submitted to the GPU a fence is attached to the buffer and is transferred via userspace, using Sync Files fds, to the DRM driver for example. More details at - Documentation/sync_file.txt. + Documentation/sync_file.rst. config SW_SYNC bool "Sync File Validation Framework" diff --git a/drivers/gpio/Kconfig b/drivers/gpio/Kconfig index c377c989000c..85cecf58bcf5 100644 --- a/drivers/gpio/Kconfig +++ b/drivers/gpio/Kconfig @@ -1300,7 +1300,7 @@ config GPIO_BT8XX The card needs to be physically altered for using it as a GPIO card. For more information on how to build a GPIO card from a BT8xx TV card, see the documentation file at - Documentation/bt8xxgpio.txt + Documentation/bt8xxgpio.rst If unsure, say N. diff --git a/drivers/parisc/sba_iommu.c b/drivers/parisc/sba_iommu.c index 296668caf7e5..267ceb5f7838 100644 --- a/drivers/parisc/sba_iommu.c +++ b/drivers/parisc/sba_iommu.c @@ -666,7 +666,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt) * @dev: instance of PCI owned by the driver that's asking * @mask: number of address bits this PCI device can handle * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static int sba_dma_supported( struct device *dev, u64 mask) { @@ -678,7 +678,7 @@ static int sba_dma_supported( struct device *dev, u64 mask) return(0); } - /* Documentation/DMA-API-HOWTO.txt tells drivers to try 64-bit + /* Documentation/DMA-API-HOWTO.rst tells drivers to try 64-bit * first, then fall back to 32-bit if that fails. * We are just "encouraging" 32-bit DMA masks here since we can * never allow IOMMU bypass unless we add special support for ZX1. @@ -706,7 +706,7 @@ static int sba_dma_supported( struct device *dev, u64 mask) * @size: number of bytes to map in driver buffer. * @direction: R/W or both. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static dma_addr_t sba_map_single(struct device *dev, void *addr, size_t size, @@ -796,7 +796,7 @@ sba_map_page(struct device *dev, struct page *page, unsigned long offset, * @size: number of bytes mapped in driver buffer. * @direction: R/W or both. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size, @@ -875,7 +875,7 @@ sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size, * @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle, gfp_t gfp, unsigned long attrs) @@ -906,7 +906,7 @@ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle * @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void sba_free(struct device *hwdev, size_t size, void *vaddr, @@ -941,7 +941,7 @@ int dump_run_sg = 0; * @nents: number of entries in list * @direction: R/W or both. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static int sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents, @@ -1025,7 +1025,7 @@ sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents, * @nents: number of entries in list * @direction: R/W or both. * - * See Documentation/DMA-API-HOWTO.txt + * See Documentation/DMA-API-HOWTO.rst */ static void sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents, diff --git a/drivers/pci/switch/Kconfig b/drivers/pci/switch/Kconfig index aee28a5bb98f..c1f5226cd0e5 100644 --- a/drivers/pci/switch/Kconfig +++ b/drivers/pci/switch/Kconfig @@ -9,7 +9,7 @@ config PCI_SW_SWITCHTEC Enables support for the management interface for the MicroSemi Switchtec series of PCIe switches. Supports userspace access to submit MRPC commands to the switch via /dev/switchtecX - devices. See for more + devices. See for more information. endmenu diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig index abae73f72e75..6cd4a620115d 100644 --- a/drivers/platform/x86/Kconfig +++ b/drivers/platform/x86/Kconfig @@ -118,7 +118,7 @@ config DCDBAS Interrupts (SMIs) and Host Control Actions (system power cycle or power off after OS shutdown) on certain Dell systems. - See for more details on the driver + See for more details on the driver and the Dell systems on which Dell systems management software makes use of this driver. @@ -259,7 +259,7 @@ config DELL_RBU DELL system. Note you need a Dell OpenManage or Dell Update package (DUP) supporting application to communicate with the BIOS regarding the new image for the image update to take effect. - See for more details on the driver. + See for more details on the driver. config FUJITSU_LAPTOP diff --git a/drivers/platform/x86/dcdbas.c b/drivers/platform/x86/dcdbas.c index 12cf9475ac85..ba8dff3511ec 100644 --- a/drivers/platform/x86/dcdbas.c +++ b/drivers/platform/x86/dcdbas.c @@ -7,7 +7,7 @@ * and Host Control Actions (power cycle or power off after OS shutdown) on * Dell systems. * - * See Documentation/dcdbas.txt for more information. + * See Documentation/dcdbas.rst for more information. * * Copyright (C) 1995-2006 Dell Inc. */ diff --git a/drivers/platform/x86/dell_rbu.c b/drivers/platform/x86/dell_rbu.c index a58fc10293ee..18400bb38e09 100644 --- a/drivers/platform/x86/dell_rbu.c +++ b/drivers/platform/x86/dell_rbu.c @@ -24,7 +24,7 @@ * on every time the packet data is written. This driver requires an * application to break the BIOS image in to fixed sized packet chunks. * - * See Documentation/dell_rbu.txt for more info. + * See Documentation/dell_rbu.rst for more info. */ #include #include diff --git a/drivers/pnp/isapnp/Kconfig b/drivers/pnp/isapnp/Kconfig index 4b58a3dcb52b..c4ddf41c7fb8 100644 --- a/drivers/pnp/isapnp/Kconfig +++ b/drivers/pnp/isapnp/Kconfig @@ -7,6 +7,6 @@ config ISAPNP depends on ISA || COMPILE_TEST help Say Y here if you would like support for ISA Plug and Play devices. - Some information is in . + Some information is in . If unsure, say Y. diff --git a/drivers/vfio/Kconfig b/drivers/vfio/Kconfig index e5a7a454fe17..5d6151392571 100644 --- a/drivers/vfio/Kconfig +++ b/drivers/vfio/Kconfig @@ -25,7 +25,7 @@ menuconfig VFIO select VFIO_IOMMU_TYPE1 if (X86 || S390 || ARM || ARM64) help VFIO provides a framework for secure userspace device drivers. - See Documentation/vfio.txt for more details. + See Documentation/vfio.rst for more details. If you don't know what to do here, say N. diff --git a/drivers/vfio/mdev/Kconfig b/drivers/vfio/mdev/Kconfig index ba94a076887f..10ec404acbfc 100644 --- a/drivers/vfio/mdev/Kconfig +++ b/drivers/vfio/mdev/Kconfig @@ -6,7 +6,7 @@ config VFIO_MDEV default n help Provides a framework to virtualize devices. - See Documentation/vfio-mediated-device.txt for more details. + See Documentation/vfio-mediated-device.rst for more details. If you don't know what do here, say N. diff --git a/include/asm-generic/bitops/atomic.h b/include/asm-generic/bitops/atomic.h index dd90c9792909..6ee11717bb65 100644 --- a/include/asm-generic/bitops/atomic.h +++ b/include/asm-generic/bitops/atomic.h @@ -8,7 +8,7 @@ /* * Implementation of atomic bitops using atomic-fetch ops. - * See Documentation/atomic_bitops.txt for details. + * See Documentation/atomic_bitops.rst for details. */ static inline void set_bit(unsigned int nr, volatile unsigned long *p) diff --git a/include/linux/dma-mapping.h b/include/linux/dma-mapping.h index 6309a721394b..7ff3fcd73cec 100644 --- a/include/linux/dma-mapping.h +++ b/include/linux/dma-mapping.h @@ -14,7 +14,7 @@ /** * List of possible attributes associated with a DMA mapping. The semantics - * of each attribute should be defined in Documentation/DMA-attributes.txt. + * of each attribute should be defined in Documentation/DMA-attributes.rst. * * DMA_ATTR_WRITE_BARRIER: DMA to a memory region with this attribute * forces all pending DMA writes to complete. diff --git a/include/linux/hw_random.h b/include/linux/hw_random.h index c0b93e0ff0c0..e533eac9942b 100644 --- a/include/linux/hw_random.h +++ b/include/linux/hw_random.h @@ -1,7 +1,7 @@ /* Hardware Random Number Generator - Please read Documentation/hw_random.txt for details on use. + Please read Documentation/hw_random.rst for details on use. ---------------------------------------------------------- This software may be used and distributed according to the terms diff --git a/include/linux/io-mapping.h b/include/linux/io-mapping.h index 58df02bd93c9..b90c540696a4 100644 --- a/include/linux/io-mapping.h +++ b/include/linux/io-mapping.h @@ -28,7 +28,7 @@ * The io_mapping mechanism provides an abstraction for mapping * individual pages from an io device to the CPU in an efficient fashion. * - * See Documentation/io-mapping.txt + * See Documentation/io-mapping.rst */ struct io_mapping { diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h index 3e113a1fa0f1..c3947cab2d27 100644 --- a/include/linux/jump_label.h +++ b/include/linux/jump_label.h @@ -68,7 +68,7 @@ * Lacking toolchain and or architecture support, static keys fall back to a * simple conditional branch. * - * Additional babbling in: Documentation/static-keys.txt + * Additional babbling in: Documentation/static-keys.rst */ #ifndef __ASSEMBLY__ diff --git a/include/linux/kobject.h b/include/linux/kobject.h index e2ca0a292e21..16f66fe28ec2 100644 --- a/include/linux/kobject.h +++ b/include/linux/kobject.h @@ -7,7 +7,7 @@ * Copyright (c) 2006-2008 Greg Kroah-Hartman * Copyright (c) 2006-2008 Novell Inc. * - * Please read Documentation/kobject.txt before using the kobject + * Please read Documentation/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */ diff --git a/include/linux/kobject_ns.h b/include/linux/kobject_ns.h index 069aa2ebef90..8c86c4641739 100644 --- a/include/linux/kobject_ns.h +++ b/include/linux/kobject_ns.h @@ -8,7 +8,7 @@ * * Split from kobject.h by David Howells (dhowells@redhat.com) * - * Please read Documentation/kobject.txt before using the kobject + * Please read Documentation/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */ diff --git a/include/linux/rbtree.h b/include/linux/rbtree.h index e6337fce08f2..2c579b6000a5 100644 --- a/include/linux/rbtree.h +++ b/include/linux/rbtree.h @@ -11,7 +11,7 @@ I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... - See Documentation/rbtree.txt for documentation and samples. + See Documentation/rbtree.rst for documentation and samples. */ #ifndef _LINUX_RBTREE_H diff --git a/include/linux/rbtree_augmented.h b/include/linux/rbtree_augmented.h index 0f902ccb48b0..b3f64a2935ae 100644 --- a/include/linux/rbtree_augmented.h +++ b/include/linux/rbtree_augmented.h @@ -21,7 +21,7 @@ * rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * - * See Documentation/rbtree.txt for documentation and samples. + * See Documentation/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks { diff --git a/include/media/videobuf-dma-sg.h b/include/media/videobuf-dma-sg.h index 01bd142b979d..50a549e5b477 100644 --- a/include/media/videobuf-dma-sg.h +++ b/include/media/videobuf-dma-sg.h @@ -34,7 +34,7 @@ * does memory allocation too using vmalloc_32(). * * videobuf_dma_*() - * see Documentation/DMA-API-HOWTO.txt, these functions to + * see Documentation/DMA-API-HOWTO.rst, these functions to * basically the same. The map function does also build a * scatterlist for the buffer (and unmap frees it ...) * diff --git a/init/Kconfig b/init/Kconfig index 1707cf0802a7..501126df6336 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -1807,7 +1807,7 @@ config MMAP_ALLOW_UNINITIALIZED userspace. Since that isn't generally a problem on no-MMU systems, it is normally safe to say Y here. - See Documentation/nommu-mmap.txt for more information. + See Documentation/nommu-mmap.rst for more information. config SYSTEM_DATA_VERIFICATION def_bool n diff --git a/kernel/dma/debug.c b/kernel/dma/debug.c index 099002d84f46..616919c774a5 100644 --- a/kernel/dma/debug.c +++ b/kernel/dma/debug.c @@ -1069,7 +1069,7 @@ static void check_unmap(struct dma_debug_entry *ref) /* * Drivers should use dma_mapping_error() to check the returned * addresses of dma_map_single() and dma_map_page(). - * If not, print this warning message. See Documentation/DMA-API.txt. + * If not, print this warning message. See Documentation/DMA-API.rst. */ if (entry->map_err_type == MAP_ERR_NOT_CHECKED) { err_printk(ref->dev, entry, diff --git a/kernel/padata.c b/kernel/padata.c index 2d2fddbb7a4c..a567973bb1ba 100644 --- a/kernel/padata.c +++ b/kernel/padata.c @@ -2,7 +2,7 @@ /* * padata.c - generic interface to process data streams in parallel * - * See Documentation/padata.txt for an api documentation. + * See Documentation/padata.rst for an api documentation. * * Copyright (C) 2008, 2009 secunet Security Networks AG * Copyright (C) 2008, 2009 Steffen Klassert diff --git a/lib/Kconfig b/lib/Kconfig index 90623a0e1942..58e9dae6f424 100644 --- a/lib/Kconfig +++ b/lib/Kconfig @@ -420,7 +420,7 @@ config INTERVAL_TREE See: - Documentation/rbtree.txt + Documentation/rbtree.rst for more information. diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index 45c37f5c96ea..ce47efa5f4e4 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -1682,7 +1682,7 @@ config PROVIDE_OHCI1394_DMA_INIT This code (~1k) is freed after boot. By then, the firewire stack in charge of the OHCI-1394 controllers should be used instead. - See Documentation/debugging-via-ohci1394.txt for more information. + See Documentation/debugging-via-ohci1394.rst for more information. menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing" diff --git a/lib/crc32.c b/lib/crc32.c index 4a20455d1f61..0de37ccc70dd 100644 --- a/lib/crc32.c +++ b/lib/crc32.c @@ -24,7 +24,7 @@ * Version 2. See the file COPYING for more details. */ -/* see: Documentation/crc32.txt for a description of algorithms */ +/* see: Documentation/crc32.rst for a description of algorithms */ #include #include diff --git a/lib/kobject.c b/lib/kobject.c index f2ccdbac8ed9..03157ff88495 100644 --- a/lib/kobject.c +++ b/lib/kobject.c @@ -6,7 +6,7 @@ * Copyright (c) 2006-2007 Greg Kroah-Hartman * Copyright (c) 2006-2007 Novell Inc. * - * Please see the file Documentation/kobject.txt for critical information + * Please see the file Documentation/kobject.rst for critical information * about using the kobject interface. */ @@ -668,7 +668,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/kobject.rst.\n", kobject_name(kobj), kobj); /* send "remove" if the caller did not do it but sent "add" */ diff --git a/lib/lzo/lzo1x_decompress_safe.c b/lib/lzo/lzo1x_decompress_safe.c index 2717c7963acd..1642c28e6627 100644 --- a/lib/lzo/lzo1x_decompress_safe.c +++ b/lib/lzo/lzo1x_decompress_safe.c @@ -32,7 +32,7 @@ * depending on the base count. Since the base count is taken from a u8 * and a few bits, it is safe to assume that it will always be lower than * or equal to 2*255, thus we can always prevent any overflow by accepting - * two less 255 steps. See Documentation/lzo.txt for more information. + * two less 255 steps. See Documentation/lzo.rst for more information. */ #define MAX_255_COUNT ((((size_t)~0) / 255) - 2) diff --git a/lib/xz/Kconfig b/lib/xz/Kconfig index 22528743d4ce..314a89c13545 100644 --- a/lib/xz/Kconfig +++ b/lib/xz/Kconfig @@ -5,7 +5,7 @@ config XZ_DEC help LZMA2 compression algorithm and BCJ filters are supported using the .xz file format as the container. For integrity checking, - CRC32 is supported. See Documentation/xz.txt for more information. + CRC32 is supported. See Documentation/xz.rst for more information. if XZ_DEC diff --git a/mm/Kconfig b/mm/Kconfig index 7c41d2300e07..ed5fe68590f4 100644 --- a/mm/Kconfig +++ b/mm/Kconfig @@ -369,7 +369,7 @@ config NOMMU_INITIAL_TRIM_EXCESS This option specifies the initial value of this option. The default of 1 says that all excess pages should be trimmed. - See Documentation/nommu-mmap.txt for more information. + See Documentation/nommu-mmap.rst for more information. config TRANSPARENT_HUGEPAGE bool "Transparent Hugepage Support" diff --git a/mm/nommu.c b/mm/nommu.c index b2823519f8cd..30a071ba838d 100644 --- a/mm/nommu.c +++ b/mm/nommu.c @@ -5,7 +5,7 @@ * Replacement code for mm functions to support CPU's that don't * have any form of memory management unit (thus no virtual memory). * - * See Documentation/nommu-mmap.txt + * See Documentation/nommu-mmap.rst * * Copyright (c) 2004-2008 David Howells * Copyright (c) 2000-2003 David McCullough diff --git a/samples/kprobes/kprobe_example.c b/samples/kprobes/kprobe_example.c index d693c23a85e8..d76fd05304a5 100644 --- a/samples/kprobes/kprobe_example.c +++ b/samples/kprobes/kprobe_example.c @@ -5,7 +5,7 @@ * stack trace and selected registers when _do_fork() is called. * * For more information on theory of operation of kprobes, see - * Documentation/kprobes.txt + * Documentation/kprobes.rst * * You will see the trace data in /var/log/messages and on the console * whenever _do_fork() is invoked to create a new process. diff --git a/samples/kprobes/kretprobe_example.c b/samples/kprobes/kretprobe_example.c index 186315ca88b3..9a2234ae0286 100644 --- a/samples/kprobes/kretprobe_example.c +++ b/samples/kprobes/kretprobe_example.c @@ -11,7 +11,7 @@ * If no func_name is specified, _do_fork is instrumented * * For more information on theory of operation of kretprobes, see - * Documentation/kprobes.txt + * Documentation/kprobes.rst * * Build and insert the kernel module as done in the kprobe example. * You will see the trace data in /var/log/messages and on the console diff --git a/scripts/gcc-plugins/Kconfig b/scripts/gcc-plugins/Kconfig index e9c677a53c74..b4dc5b116bfe 100644 --- a/scripts/gcc-plugins/Kconfig +++ b/scripts/gcc-plugins/Kconfig @@ -23,7 +23,7 @@ config GCC_PLUGINS GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis. - See Documentation/gcc-plugins.txt for details. + See Documentation/gcc-plugins.rst for details. menu "GCC plugins" depends on GCC_PLUGINS diff --git a/security/Kconfig b/security/Kconfig index 06a30851511a..4da0d09c3e49 100644 --- a/security/Kconfig +++ b/security/Kconfig @@ -121,7 +121,7 @@ config INTEL_TXT See for more information about Intel(R) TXT. See for more information about tboot. - See Documentation/intel_txt.txt for a description of how to enable + See Documentation/intel_txt.rst for a description of how to enable Intel TXT support in a kernel boot. If you are unsure as to whether this is required, answer N. diff --git a/tools/include/linux/rbtree.h b/tools/include/linux/rbtree.h index d83763a5327c..e96d7120ce2b 100644 --- a/tools/include/linux/rbtree.h +++ b/tools/include/linux/rbtree.h @@ -11,7 +11,7 @@ I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... - See Documentation/rbtree.txt for documentation and samples. + See Documentation/rbtree.rst for documentation and samples. */ #ifndef __TOOLS_LINUX_PERF_RBTREE_H diff --git a/tools/include/linux/rbtree_augmented.h b/tools/include/linux/rbtree_augmented.h index ddd01006ece5..c251bb16f2e9 100644 --- a/tools/include/linux/rbtree_augmented.h +++ b/tools/include/linux/rbtree_augmented.h @@ -23,7 +23,7 @@ * rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * - * See Documentation/rbtree.txt for documentation and samples. + * See Documentation/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks { From patchwork Tue Jun 18 21:05:27 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11002737 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id DAF4E924 for ; Tue, 18 Jun 2019 21:06:11 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C54DF212E8 for ; Tue, 18 Jun 2019 21:06:11 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B8BE628A5A; Tue, 18 Jun 2019 21:06:11 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 25C4922F3E for ; Tue, 18 Jun 2019 21:06:05 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id B3F2B6E22D; Tue, 18 Jun 2019 21:06:02 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) by gabe.freedesktop.org (Postfix) with ESMTPS id 502E76E267 for ; Tue, 18 Jun 2019 21:06:01 +0000 (UTC) Received: from 177.133.86.196.dynamic.adsl.gvt.net.br ([177.133.86.196] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hdLIb-0006yT-RO; Tue, 18 Jun 2019 21:05:51 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hdLIZ-0002Bs-Ms; Tue, 18 Jun 2019 18:05:47 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v1 03/22] docs: ioctl: convert to ReST Date: Tue, 18 Jun 2019 18:05:27 -0300 Message-Id: X-Mailer: git-send-email 2.21.0 In-Reply-To: References: MIME-Version: 1.0 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Sender:Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Reply-To:Content-Type:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=4HBasmsN5lLahF9Y3qtSr9SrMx7wx9HvEGFEgWxANgs=; b=kMBnQ29PPcbN7Zp92NI/H0dbJT WqbAQJPSrZTWc9bgDOfOsvPW0lwguonpb1y8X8wSiNbzGO9hk5aXhMpGL+XTZqeM+p+QrgQE/7hMQ 4ZVQVFgC6QCTlgA/1uoNTBsp2A152xycJnFE58UFSVasr1cokUBVzI6s1f/mkWeDpdFDHvsB/VMoX GVptJucqk3pYV5tidhjWYYjtA7j64yafZs/5YOFnMiwEcYvP/0JFbAiCAW9L5k7rdy3ZKG2k3ZWh5 olipDmnP31m/JwnHAndORZe7GqOgts9UlbhnzUNdLU8nVoVN1aHxHDsOGdYhbrBw0L0iq2iTefZi5 smXHJLOw==; X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Jonathan Corbet , Maxime Ripard , linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Mauro Carvalho Chehab , David Airlie , Mauro Carvalho Chehab , Sean Paul Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP Rename the iio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. The cdrom.txt and hdio.txt have their own particular syntax. In order to speedup the conversion, I used a small ancillary perl script: my $d; $d .= $_ while(<>); $d =~ s/(\nCDROM\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\nHDIO\S+)\s+(\w[^\n]*)/$1\n\t$2\n/g; $d =~ s/(\n\s*usage:)[\s\n]*(\w[^\n]*)/$1:\n\n\t $2\n/g; $d =~ s/(\n\s*)(E\w+[\s\n]*\w[^\n]*)/$1- $2/g; $d =~ s/(\n\s*)(inputs|outputs|notes):\s*(\w[^\n]*)/$1$2:\n\t\t$3\n/g; print $d; It basically add blank lines on a few interesting places. The script is not perfect: still several things require manual work, but it saved quite some time doing some obvious stuff. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab --- ...g-up-ioctls.txt => botching-up-ioctls.rst} | 1 + Documentation/ioctl/{cdrom.txt => cdrom.rst} | 908 +++++++++++------- Documentation/ioctl/{hdio.txt => hdio.rst} | 835 ++++++++++------ Documentation/ioctl/index.rst | 16 + ...{ioctl-decoding.txt => ioctl-decoding.rst} | 13 +- drivers/gpu/drm/drm_ioctl.c | 2 +- 6 files changed, 1168 insertions(+), 607 deletions(-) rename Documentation/ioctl/{botching-up-ioctls.txt => botching-up-ioctls.rst} (99%) rename Documentation/ioctl/{cdrom.txt => cdrom.rst} (39%) rename Documentation/ioctl/{hdio.txt => hdio.rst} (54%) create mode 100644 Documentation/ioctl/index.rst rename Documentation/ioctl/{ioctl-decoding.txt => ioctl-decoding.rst} (54%) diff --git a/Documentation/ioctl/botching-up-ioctls.txt b/Documentation/ioctl/botching-up-ioctls.rst similarity index 99% rename from Documentation/ioctl/botching-up-ioctls.txt rename to Documentation/ioctl/botching-up-ioctls.rst index 883fb034bd04..ac697fef3545 100644 --- a/Documentation/ioctl/botching-up-ioctls.txt +++ b/Documentation/ioctl/botching-up-ioctls.rst @@ -1,3 +1,4 @@ +================================= (How to avoid) Botching up ioctls ================================= diff --git a/Documentation/ioctl/cdrom.txt b/Documentation/ioctl/cdrom.rst similarity index 39% rename from Documentation/ioctl/cdrom.txt rename to Documentation/ioctl/cdrom.rst index a4d62a9d6771..3b4c0506de46 100644 --- a/Documentation/ioctl/cdrom.txt +++ b/Documentation/ioctl/cdrom.rst @@ -1,9 +1,10 @@ - Summary of CDROM ioctl calls. - ============================ +============================ +Summary of CDROM ioctl calls +============================ - Edward A. Falk +- Edward A. Falk - November, 2004 +November, 2004 This document attempts to describe the ioctl(2) calls supported by the CDROM layer. These are by-and-large implemented (as of Linux 2.6) @@ -12,6 +13,7 @@ in drivers/cdrom/cdrom.c and drivers/block/scsi_ioctl.c ioctl values are listed in . As of this writing, they are as follows: + ====================== =============================================== CDROMPAUSE Pause Audio Operation CDROMRESUME Resume paused Audio Operation CDROMPLAYMSF Play Audio MSF (struct cdrom_msf) @@ -24,22 +26,22 @@ are as follows: CDROMVOLCTRL Control output volume (struct cdrom_volctrl) CDROMSUBCHNL Read subchannel data (struct cdrom_subchnl) CDROMREADMODE2 Read CDROM mode 2 data (2336 Bytes) - (struct cdrom_read) + (struct cdrom_read) CDROMREADMODE1 Read CDROM mode 1 data (2048 Bytes) - (struct cdrom_read) + (struct cdrom_read) CDROMREADAUDIO (struct cdrom_read_audio) CDROMEJECT_SW enable(1)/disable(0) auto-ejecting CDROMMULTISESSION Obtain the start-of-last-session - address of multi session disks - (struct cdrom_multisession) + address of multi session disks + (struct cdrom_multisession) CDROM_GET_MCN Obtain the "Universal Product Code" - if available (struct cdrom_mcn) + if available (struct cdrom_mcn) CDROM_GET_UPC Deprecated, use CDROM_GET_MCN instead. CDROMRESET hard-reset the drive CDROMVOLREAD Get the drive's volume setting - (struct cdrom_volctrl) + (struct cdrom_volctrl) CDROMREADRAW read data in raw mode (2352 Bytes) - (struct cdrom_read) + (struct cdrom_read) CDROMREADCOOKED read data in cooked mode CDROMSEEK seek msf address CDROMPLAYBLK scsi-cd only, (struct cdrom_blk) @@ -65,16 +67,13 @@ are as follows: CDROM_SEND_PACKET send a packet to the drive CDROM_NEXT_WRITABLE get next writable block CDROM_LAST_WRITTEN get last block written on disc + ====================== =============================================== The information that follows was determined from reading kernel source code. It is likely that some corrections will be made over time. - - - - - +------------------------------------------------------------------------------ General: @@ -91,795 +90,1034 @@ General: Unless otherwise specified, all data structures and constants are defined in +------------------------------------------------------------------------------ +CDROMPAUSE + Pause Audio Operation -CDROMPAUSE Pause Audio Operation - usage: + usage:: ioctl(fd, CDROMPAUSE, 0); - inputs: none - outputs: none + inputs: + none + + + outputs: + none + error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. -CDROMRESUME Resume paused Audio Operation +CDROMRESUME + Resume paused Audio Operation - usage: + + usage:: ioctl(fd, CDROMRESUME, 0); - inputs: none - outputs: none + inputs: + none + + + outputs: + none + error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. -CDROMPLAYMSF Play Audio MSF (struct cdrom_msf) +CDROMPLAYMSF + Play Audio MSF - usage: + (struct cdrom_msf) + + + usage:: struct cdrom_msf msf; + ioctl(fd, CDROMPLAYMSF, &msf); inputs: - cdrom_msf structure, describing a segment of music to play + cdrom_msf structure, describing a segment of music to play + + + outputs: + none - outputs: none error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. notes: - MSF stands for minutes-seconds-frames - LBA stands for logical block address + - MSF stands for minutes-seconds-frames + - LBA stands for logical block address + - Segment is described as start and end times, where each time + is described as minutes:seconds:frames. + A frame is 1/75 of a second. - Segment is described as start and end times, where each time - is described as minutes:seconds:frames. A frame is 1/75 of - a second. +CDROMPLAYTRKIND + Play Audio Track/index -CDROMPLAYTRKIND Play Audio Track/index (struct cdrom_ti) + (struct cdrom_ti) - usage: + + usage:: struct cdrom_ti ti; + ioctl(fd, CDROMPLAYTRKIND, &ti); inputs: - cdrom_ti structure, describing a segment of music to play + cdrom_ti structure, describing a segment of music to play + + + outputs: + none - outputs: none error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. notes: - Segment is described as start and end times, where each time - is described as a track and an index. + - Segment is described as start and end times, where each time + is described as a track and an index. -CDROMREADTOCHDR Read TOC header (struct cdrom_tochdr) +CDROMREADTOCHDR + Read TOC header - usage: + (struct cdrom_tochdr) + + + usage:: cdrom_tochdr header; + ioctl(fd, CDROMREADTOCHDR, &header); inputs: - cdrom_tochdr structure + cdrom_tochdr structure + outputs: - cdrom_tochdr structure + cdrom_tochdr structure + error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. -CDROMREADTOCENTRY Read TOC entry (struct cdrom_tocentry) +CDROMREADTOCENTRY + Read TOC entry - usage: + (struct cdrom_tocentry) + + + usage:: struct cdrom_tocentry entry; + ioctl(fd, CDROMREADTOCENTRY, &entry); inputs: - cdrom_tocentry structure + cdrom_tocentry structure + outputs: - cdrom_tocentry structure + cdrom_tocentry structure + error return: - ENOSYS cd drive not audio-capable. - EINVAL entry.cdte_format not CDROM_MSF or CDROM_LBA - EINVAL requested track out of bounds - EIO I/O error reading TOC + - ENOSYS cd drive not audio-capable. + - EINVAL entry.cdte_format not CDROM_MSF or CDROM_LBA + - EINVAL requested track out of bounds + - EIO I/O error reading TOC notes: - TOC stands for Table Of Contents - MSF stands for minutes-seconds-frames - LBA stands for logical block address + - TOC stands for Table Of Contents + - MSF stands for minutes-seconds-frames + - LBA stands for logical block address -CDROMSTOP Stop the cdrom drive +CDROMSTOP + Stop the cdrom drive - usage: + + usage:: ioctl(fd, CDROMSTOP, 0); - inputs: none - outputs: none + inputs: + none + + + outputs: + none + error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. notes: - Exact interpretation of this ioctl depends on the device, - but most seem to spin the drive down. + - Exact interpretation of this ioctl depends on the device, + but most seem to spin the drive down. -CDROMSTART Start the cdrom drive +CDROMSTART + Start the cdrom drive - usage: + + usage:: ioctl(fd, CDROMSTART, 0); - inputs: none - outputs: none + inputs: + none + + + outputs: + none + error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. notes: - Exact interpretation of this ioctl depends on the device, - but most seem to spin the drive up and/or close the tray. - Other devices ignore the ioctl completely. + - Exact interpretation of this ioctl depends on the device, + but most seem to spin the drive up and/or close the tray. + Other devices ignore the ioctl completely. -CDROMEJECT Ejects the cdrom media +CDROMEJECT + - Ejects the cdrom media - usage: + + usage:: ioctl(fd, CDROMEJECT, 0); - inputs: none - outputs: none + inputs: + none + + + outputs: + none + error returns: - ENOSYS cd drive not capable of ejecting - EBUSY other processes are accessing drive, or door is locked + - ENOSYS cd drive not capable of ejecting + - EBUSY other processes are accessing drive, or door is locked notes: - See CDROM_LOCKDOOR, below. + - See CDROM_LOCKDOOR, below. -CDROMCLOSETRAY pendant of CDROMEJECT - usage: +CDROMCLOSETRAY + pendant of CDROMEJECT + + + usage:: ioctl(fd, CDROMCLOSETRAY, 0); - inputs: none - outputs: none + inputs: + none + + + outputs: + none + error returns: - ENOSYS cd drive not capable of closing the tray - EBUSY other processes are accessing drive, or door is locked + - ENOSYS cd drive not capable of closing the tray + - EBUSY other processes are accessing drive, or door is locked notes: - See CDROM_LOCKDOOR, below. + - See CDROM_LOCKDOOR, below. -CDROMVOLCTRL Control output volume (struct cdrom_volctrl) - usage: +CDROMVOLCTRL + Control output volume (struct cdrom_volctrl) + + + usage:: struct cdrom_volctrl volume; + ioctl(fd, CDROMVOLCTRL, &volume); inputs: - cdrom_volctrl structure containing volumes for up to 4 - channels. + cdrom_volctrl structure containing volumes for up to 4 + channels. + + outputs: + none - outputs: none error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. -CDROMVOLREAD Get the drive's volume setting - (struct cdrom_volctrl) +CDROMVOLREAD + Get the drive's volume setting - usage: + (struct cdrom_volctrl) + + + usage:: struct cdrom_volctrl volume; + ioctl(fd, CDROMVOLREAD, &volume); - inputs: none + inputs: + none + outputs: - The current volume settings. + The current volume settings. + error return: - ENOSYS cd drive not audio-capable. + - ENOSYS cd drive not audio-capable. -CDROMSUBCHNL Read subchannel data (struct cdrom_subchnl) +CDROMSUBCHNL + Read subchannel data - usage: + (struct cdrom_subchnl) + + + usage:: struct cdrom_subchnl q; + ioctl(fd, CDROMSUBCHNL, &q); inputs: - cdrom_subchnl structure + cdrom_subchnl structure + outputs: - cdrom_subchnl structure + cdrom_subchnl structure + error return: - ENOSYS cd drive not audio-capable. - EINVAL format not CDROM_MSF or CDROM_LBA + - ENOSYS cd drive not audio-capable. + - EINVAL format not CDROM_MSF or CDROM_LBA notes: - Format is converted to CDROM_MSF or CDROM_LBA - as per user request on return + - Format is converted to CDROM_MSF or CDROM_LBA + as per user request on return -CDROMREADRAW read data in raw mode (2352 Bytes) - (struct cdrom_read) +CDROMREADRAW + read data in raw mode (2352 Bytes) - usage: + (struct cdrom_read) + + usage:: union { + struct cdrom_msf msf; /* input */ char buffer[CD_FRAMESIZE_RAW]; /* return */ } arg; ioctl(fd, CDROMREADRAW, &arg); inputs: - cdrom_msf structure indicating an address to read. - Only the start values are significant. + cdrom_msf structure indicating an address to read. + + Only the start values are significant. outputs: - Data written to address provided by user. + Data written to address provided by user. + error return: - EINVAL address less than 0, or msf less than 0:2:0 - ENOMEM out of memory + - EINVAL address less than 0, or msf less than 0:2:0 + - ENOMEM out of memory notes: - As of 2.6.8.1, comments in indicate that this - ioctl accepts a cdrom_read structure, but actual source code - reads a cdrom_msf structure and writes a buffer of data to - the same address. + - As of 2.6.8.1, comments in indicate that this + ioctl accepts a cdrom_read structure, but actual source code + reads a cdrom_msf structure and writes a buffer of data to + the same address. - MSF values are converted to LBA values via this formula: + - MSF values are converted to LBA values via this formula:: - lba = (((m * CD_SECS) + s) * CD_FRAMES + f) - CD_MSF_OFFSET; + lba = (((m * CD_SECS) + s) * CD_FRAMES + f) - CD_MSF_OFFSET; -CDROMREADMODE1 Read CDROM mode 1 data (2048 Bytes) - (struct cdrom_read) +CDROMREADMODE1 + Read CDROM mode 1 data (2048 Bytes) + + (struct cdrom_read) notes: - Identical to CDROMREADRAW except that block size is - CD_FRAMESIZE (2048) bytes + Identical to CDROMREADRAW except that block size is + CD_FRAMESIZE (2048) bytes + +CDROMREADMODE2 + Read CDROM mode 2 data (2336 Bytes) -CDROMREADMODE2 Read CDROM mode 2 data (2336 Bytes) - (struct cdrom_read) + (struct cdrom_read) notes: - Identical to CDROMREADRAW except that block size is - CD_FRAMESIZE_RAW0 (2336) bytes + Identical to CDROMREADRAW except that block size is + CD_FRAMESIZE_RAW0 (2336) bytes -CDROMREADAUDIO (struct cdrom_read_audio) +CDROMREADAUDIO + (struct cdrom_read_audio) - usage: + usage:: struct cdrom_read_audio ra; + ioctl(fd, CDROMREADAUDIO, &ra); inputs: - cdrom_read_audio structure containing read start - point and length + cdrom_read_audio structure containing read start + point and length outputs: - audio data, returned to buffer indicated by ra + audio data, returned to buffer indicated by ra + error return: - EINVAL format not CDROM_MSF or CDROM_LBA - EINVAL nframes not in range [1 75] - ENXIO drive has no queue (probably means invalid fd) - ENOMEM out of memory + - EINVAL format not CDROM_MSF or CDROM_LBA + - EINVAL nframes not in range [1 75] + - ENXIO drive has no queue (probably means invalid fd) + - ENOMEM out of memory -CDROMEJECT_SW enable(1)/disable(0) auto-ejecting +CDROMEJECT_SW + enable(1)/disable(0) auto-ejecting - usage: + + usage:: int val; + ioctl(fd, CDROMEJECT_SW, val); inputs: - Flag specifying auto-eject flag. + Flag specifying auto-eject flag. + + + outputs: + none - outputs: none error return: - ENOSYS Drive is not capable of ejecting. - EBUSY Door is locked + - ENOSYS Drive is not capable of ejecting. + - EBUSY Door is locked -CDROMMULTISESSION Obtain the start-of-last-session - address of multi session disks - (struct cdrom_multisession) - usage: +CDROMMULTISESSION + Obtain the start-of-last-session address of multi session disks + + (struct cdrom_multisession) + + usage:: struct cdrom_multisession ms_info; + ioctl(fd, CDROMMULTISESSION, &ms_info); inputs: - cdrom_multisession structure containing desired + cdrom_multisession structure containing desired + format. outputs: - cdrom_multisession structure is filled with last_session - information. + cdrom_multisession structure is filled with last_session + information. error return: - EINVAL format not CDROM_MSF or CDROM_LBA + - EINVAL format not CDROM_MSF or CDROM_LBA -CDROM_GET_MCN Obtain the "Universal Product Code" - if available (struct cdrom_mcn) +CDROM_GET_MCN + Obtain the "Universal Product Code" + if available - usage: + (struct cdrom_mcn) + + + usage:: struct cdrom_mcn mcn; + ioctl(fd, CDROM_GET_MCN, &mcn); - inputs: none + inputs: + none + outputs: - Universal Product Code + Universal Product Code + error return: - ENOSYS Drive is not capable of reading MCN data. + - ENOSYS Drive is not capable of reading MCN data. notes: - Source code comments state: + - Source code comments state:: - The following function is implemented, although very few - audio discs give Universal Product Code information, which - should just be the Medium Catalog Number on the box. Note, - that the way the code is written on the CD is /not/ uniform - across all discs! + The following function is implemented, although very few + audio discs give Universal Product Code information, which + should just be the Medium Catalog Number on the box. Note, + that the way the code is written on the CD is /not/ uniform + across all discs! -CDROM_GET_UPC CDROM_GET_MCN (deprecated) +CDROM_GET_UPC + CDROM_GET_MCN (deprecated) + Not implemented, as of 2.6.8.1 -CDROMRESET hard-reset the drive +CDROMRESET + hard-reset the drive - usage: + + usage:: ioctl(fd, CDROMRESET, 0); - inputs: none - outputs: none + inputs: + none + + + outputs: + none + error return: - EACCES Access denied: requires CAP_SYS_ADMIN - ENOSYS Drive is not capable of resetting. + - EACCES Access denied: requires CAP_SYS_ADMIN + - ENOSYS Drive is not capable of resetting. -CDROMREADCOOKED read data in cooked mode +CDROMREADCOOKED + read data in cooked mode - usage: + + usage:: u8 buffer[CD_FRAMESIZE] + ioctl(fd, CDROMREADCOOKED, buffer); - inputs: none + inputs: + none + outputs: - 2048 bytes of data, "cooked" mode. + 2048 bytes of data, "cooked" mode. + notes: - Not implemented on all drives. + Not implemented on all drives. -CDROMREADALL read all 2646 bytes + +CDROMREADALL + read all 2646 bytes + Same as CDROMREADCOOKED, but reads 2646 bytes. -CDROMSEEK seek msf address +CDROMSEEK + seek msf address - usage: + + usage:: struct cdrom_msf msf; + ioctl(fd, CDROMSEEK, &msf); inputs: - MSF address to seek to. + MSF address to seek to. - outputs: none + outputs: + none -CDROMPLAYBLK scsi-cd only, (struct cdrom_blk) - usage: + +CDROMPLAYBLK + scsi-cd only + + (struct cdrom_blk) + + + usage:: struct cdrom_blk blk; + ioctl(fd, CDROMPLAYBLK, &blk); inputs: - Region to play + Region to play + + + outputs: + none - outputs: none CDROMGETSPINDOWN - - usage: + usage:: char spindown; + ioctl(fd, CDROMGETSPINDOWN, &spindown); - inputs: none + inputs: + none + outputs: - The value of the current 4-bit spindown value. + The value of the current 4-bit spindown value. + CDROMSETSPINDOWN - - usage: + usage:: char spindown + ioctl(fd, CDROMSETSPINDOWN, &spindown); inputs: - 4-bit value used to control spindown (TODO: more detail here) + 4-bit value used to control spindown (TODO: more detail here) - outputs: none + outputs: + none -CDROM_SET_OPTIONS Set behavior options - usage: + +CDROM_SET_OPTIONS + Set behavior options + + + usage:: int options; + ioctl(fd, CDROM_SET_OPTIONS, options); inputs: - New values for drive options. The logical 'or' of: + New values for drive options. The logical 'or' of: + + ============== ================================== CDO_AUTO_CLOSE close tray on first open(2) CDO_AUTO_EJECT open tray on last release CDO_USE_FFLAGS use O_NONBLOCK information on open CDO_LOCK lock tray on open files CDO_CHECK_TYPE check type on open for data + ============== ================================== outputs: - Returns the resulting options settings in the - ioctl return value. Returns -1 on error. + Returns the resulting options settings in the + ioctl return value. Returns -1 on error. error return: - ENOSYS selected option(s) not supported by drive. + - ENOSYS selected option(s) not supported by drive. -CDROM_CLEAR_OPTIONS Clear behavior options +CDROM_CLEAR_OPTIONS + Clear behavior options + Same as CDROM_SET_OPTIONS, except that selected options are turned off. -CDROM_SELECT_SPEED Set the CD-ROM speed +CDROM_SELECT_SPEED + Set the CD-ROM speed - usage: + + usage:: int speed; + ioctl(fd, CDROM_SELECT_SPEED, speed); inputs: - New drive speed. + New drive speed. + + + outputs: + none - outputs: none error return: - ENOSYS speed selection not supported by drive. + - ENOSYS speed selection not supported by drive. -CDROM_SELECT_DISC Select disc (for juke-boxes) +CDROM_SELECT_DISC + Select disc (for juke-boxes) - usage: + + usage:: int disk; + ioctl(fd, CDROM_SELECT_DISC, disk); inputs: - Disk to load into drive. + Disk to load into drive. + + + outputs: + none - outputs: none error return: - EINVAL Disk number beyond capacity of drive + - EINVAL Disk number beyond capacity of drive -CDROM_MEDIA_CHANGED Check is media changed +CDROM_MEDIA_CHANGED + Check is media changed - usage: + + usage:: int slot; + ioctl(fd, CDROM_MEDIA_CHANGED, slot); inputs: - Slot number to be tested, always zero except for jukeboxes. - May also be special values CDSL_NONE or CDSL_CURRENT + Slot number to be tested, always zero except for jukeboxes. + + May also be special values CDSL_NONE or CDSL_CURRENT outputs: - Ioctl return value is 0 or 1 depending on whether the media + Ioctl return value is 0 or 1 depending on whether the media + has been changed, or -1 on error. error returns: - ENOSYS Drive can't detect media change - EINVAL Slot number beyond capacity of drive - ENOMEM Out of memory + - ENOSYS Drive can't detect media change + - EINVAL Slot number beyond capacity of drive + - ENOMEM Out of memory -CDROM_DRIVE_STATUS Get tray position, etc. +CDROM_DRIVE_STATUS + Get tray position, etc. - usage: + + usage:: int slot; + ioctl(fd, CDROM_DRIVE_STATUS, slot); inputs: - Slot number to be tested, always zero except for jukeboxes. - May also be special values CDSL_NONE or CDSL_CURRENT + Slot number to be tested, always zero except for jukeboxes. + + May also be special values CDSL_NONE or CDSL_CURRENT outputs: - Ioctl return value will be one of the following values + Ioctl return value will be one of the following values + from : + =================== ========================== CDS_NO_INFO Information not available. CDS_NO_DISC CDS_TRAY_OPEN CDS_DRIVE_NOT_READY CDS_DISC_OK -1 error + =================== ========================== error returns: - ENOSYS Drive can't detect drive status - EINVAL Slot number beyond capacity of drive - ENOMEM Out of memory + - ENOSYS Drive can't detect drive status + - EINVAL Slot number beyond capacity of drive + - ENOMEM Out of memory -CDROM_DISC_STATUS Get disc type, etc. +CDROM_DISC_STATUS + Get disc type, etc. - usage: + + usage:: ioctl(fd, CDROM_DISC_STATUS, 0); - inputs: none + + inputs: + none + outputs: - Ioctl return value will be one of the following values + Ioctl return value will be one of the following values + from : - CDS_NO_INFO - CDS_AUDIO - CDS_MIXED - CDS_XA_2_2 - CDS_XA_2_1 - CDS_DATA_1 - error returns: none at present + - CDS_NO_INFO + - CDS_AUDIO + - CDS_MIXED + - CDS_XA_2_2 + - CDS_XA_2_1 + - CDS_DATA_1 + + error returns: + none at present notes: - Source code comments state: + - Source code comments state:: - Ok, this is where problems start. The current interface for - the CDROM_DISC_STATUS ioctl is flawed. It makes the false - assumption that CDs are all CDS_DATA_1 or all CDS_AUDIO, etc. - Unfortunately, while this is often the case, it is also - very common for CDs to have some tracks with data, and some - tracks with audio. Just because I feel like it, I declare - the following to be the best way to cope. If the CD has - ANY data tracks on it, it will be returned as a data CD. - If it has any XA tracks, I will return it as that. Now I - could simplify this interface by combining these returns with - the above, but this more clearly demonstrates the problem - with the current interface. Too bad this wasn't designed - to use bitmasks... -Erik - Well, now we have the option CDS_MIXED: a mixed-type CD. - User level programmers might feel the ioctl is not very - useful. - ---david + Ok, this is where problems start. The current interface for + the CDROM_DISC_STATUS ioctl is flawed. It makes the false + assumption that CDs are all CDS_DATA_1 or all CDS_AUDIO, etc. + Unfortunately, while this is often the case, it is also + very common for CDs to have some tracks with data, and some + tracks with audio. Just because I feel like it, I declare + the following to be the best way to cope. If the CD has + ANY data tracks on it, it will be returned as a data CD. + If it has any XA tracks, I will return it as that. Now I + could simplify this interface by combining these returns with + the above, but this more clearly demonstrates the problem + with the current interface. Too bad this wasn't designed + to use bitmasks... -Erik + Well, now we have the option CDS_MIXED: a mixed-type CD. + User level programmers might feel the ioctl is not very + useful. + ---david -CDROM_CHANGER_NSLOTS Get number of slots - usage: +CDROM_CHANGER_NSLOTS + Get number of slots + + + usage:: ioctl(fd, CDROM_CHANGER_NSLOTS, 0); - inputs: none + + inputs: + none + outputs: - The ioctl return value will be the number of slots in a - CD changer. Typically 1 for non-multi-disk devices. + The ioctl return value will be the number of slots in a + CD changer. Typically 1 for non-multi-disk devices. - error returns: none + error returns: + none -CDROM_LOCKDOOR lock or unlock door +CDROM_LOCKDOOR + lock or unlock door - usage: + + usage:: int lock; + ioctl(fd, CDROM_LOCKDOOR, lock); inputs: - Door lock flag, 1=lock, 0=unlock + Door lock flag, 1=lock, 0=unlock + + + outputs: + none - outputs: none error returns: - EDRIVE_CANT_DO_THIS Door lock function not supported. - EBUSY Attempt to unlock when multiple users - have the drive open and not CAP_SYS_ADMIN + - EDRIVE_CANT_DO_THIS + + Door lock function not supported. + - EBUSY + + Attempt to unlock when multiple users + have the drive open and not CAP_SYS_ADMIN notes: - As of 2.6.8.1, the lock flag is a global lock, meaning that - all CD drives will be locked or unlocked together. This is - probably a bug. + As of 2.6.8.1, the lock flag is a global lock, meaning that + all CD drives will be locked or unlocked together. This is + probably a bug. - The EDRIVE_CANT_DO_THIS value is defined in - and is currently (2.6.8.1) the same as EOPNOTSUPP + The EDRIVE_CANT_DO_THIS value is defined in + and is currently (2.6.8.1) the same as EOPNOTSUPP -CDROM_DEBUG Turn debug messages on/off +CDROM_DEBUG + Turn debug messages on/off - usage: + + usage:: int debug; + ioctl(fd, CDROM_DEBUG, debug); inputs: - Cdrom debug flag, 0=disable, 1=enable + Cdrom debug flag, 0=disable, 1=enable + outputs: - The ioctl return value will be the new debug flag. + The ioctl return value will be the new debug flag. + error return: - EACCES Access denied: requires CAP_SYS_ADMIN + - EACCES Access denied: requires CAP_SYS_ADMIN -CDROM_GET_CAPABILITY get capabilities +CDROM_GET_CAPABILITY + get capabilities - usage: + + usage:: ioctl(fd, CDROM_GET_CAPABILITY, 0); - inputs: none + + inputs: + none + outputs: - The ioctl return value is the current device capability - flags. See CDC_CLOSE_TRAY, CDC_OPEN_TRAY, etc. + The ioctl return value is the current device capability + flags. See CDC_CLOSE_TRAY, CDC_OPEN_TRAY, etc. -CDROMAUDIOBUFSIZ set the audio buffer size +CDROMAUDIOBUFSIZ + set the audio buffer size - usage: + + usage:: int arg; + ioctl(fd, CDROMAUDIOBUFSIZ, val); inputs: - New audio buffer size + New audio buffer size + outputs: - The ioctl return value is the new audio buffer size, or -1 - on error. + The ioctl return value is the new audio buffer size, or -1 + on error. error return: - ENOSYS Not supported by this driver. + - ENOSYS Not supported by this driver. notes: - Not supported by all drivers. + Not supported by all drivers. + DVD_READ_STRUCT Read structure - usage: + usage:: dvd_struct s; + ioctl(fd, DVD_READ_STRUCT, &s); inputs: - dvd_struct structure, containing: + dvd_struct structure, containing: + + =================== ========================================== type specifies the information desired, one of - DVD_STRUCT_PHYSICAL, DVD_STRUCT_COPYRIGHT, + DVD_STRUCT_PHYSICAL, DVD_STRUCT_COPYRIGHT, DVD_STRUCT_DISCKEY, DVD_STRUCT_BCA, DVD_STRUCT_MANUFACT physical.layer_num desired layer, indexed from 0 copyright.layer_num desired layer, indexed from 0 disckey.agid + =================== ========================================== outputs: - dvd_struct structure, containing: + dvd_struct structure, containing: + + =================== ================================ physical for type == DVD_STRUCT_PHYSICAL copyright for type == DVD_STRUCT_COPYRIGHT disckey.value for type == DVD_STRUCT_DISCKEY bca.{len,value} for type == DVD_STRUCT_BCA manufact.{len,valu} for type == DVD_STRUCT_MANUFACT + =================== ================================ error returns: - EINVAL physical.layer_num exceeds number of layers - EIO Received invalid response from drive + - EINVAL physical.layer_num exceeds number of layers + - EIO Received invalid response from drive @@ -891,77 +1129,105 @@ DVD_WRITE_STRUCT Write structure DVD_AUTH Authentication - usage: + usage:: dvd_authinfo ai; + ioctl(fd, DVD_AUTH, &ai); inputs: - dvd_authinfo structure. See + dvd_authinfo structure. See + outputs: - dvd_authinfo structure. + dvd_authinfo structure. + error return: - ENOTTY ai.type not recognized. + - ENOTTY ai.type not recognized. -CDROM_SEND_PACKET send a packet to the drive +CDROM_SEND_PACKET + send a packet to the drive - usage: + + usage:: struct cdrom_generic_command cgc; + ioctl(fd, CDROM_SEND_PACKET, &cgc); inputs: - cdrom_generic_command structure containing the packet to send. + cdrom_generic_command structure containing the packet to send. + + + outputs: + none - outputs: none cdrom_generic_command structure containing results. error return: - EIO command failed. - EPERM Operation not permitted, either because a + - EIO + + command failed. + - EPERM + + Operation not permitted, either because a write command was attempted on a drive which is opened read-only, or because the command requires CAP_SYS_RAWIO - EINVAL cgc.data_direction not set + - EINVAL + cgc.data_direction not set -CDROM_NEXT_WRITABLE get next writable block - usage: +CDROM_NEXT_WRITABLE + get next writable block + + + usage:: long next; + ioctl(fd, CDROM_NEXT_WRITABLE, &next); - inputs: none + inputs: + none + outputs: - The next writable block. + The next writable block. + notes: - If the device does not support this ioctl directly, the + If the device does not support this ioctl directly, the + ioctl will return CDROM_LAST_WRITTEN + 7. -CDROM_LAST_WRITTEN get last block written on disc +CDROM_LAST_WRITTEN + get last block written on disc - usage: + + usage:: long last; + ioctl(fd, CDROM_LAST_WRITTEN, &last); - inputs: none + inputs: + none + outputs: - The last block written on disc + The last block written on disc + notes: - If the device does not support this ioctl directly, the - result is derived from the disc's table of contents. If the - table of contents can't be read, this ioctl returns an - error. + If the device does not support this ioctl directly, the + result is derived from the disc's table of contents. If the + table of contents can't be read, this ioctl returns an + error. diff --git a/Documentation/ioctl/hdio.txt b/Documentation/ioctl/hdio.rst similarity index 54% rename from Documentation/ioctl/hdio.txt rename to Documentation/ioctl/hdio.rst index 18eb98c44ffe..e822e3dff176 100644 --- a/Documentation/ioctl/hdio.txt +++ b/Documentation/ioctl/hdio.rst @@ -1,9 +1,10 @@ - Summary of HDIO_ ioctl calls. - ============================ +============================== +Summary of `HDIO_` ioctl calls +============================== - Edward A. Falk +- Edward A. Falk - November, 2004 +November, 2004 This document attempts to describe the ioctl(2) calls supported by the HD/IDE layer. These are by-and-large implemented (as of Linux 2.6) @@ -14,6 +15,7 @@ are as follows: ioctls that pass argument pointers to user space: + ======================= ======================================= HDIO_GETGEO get device geometry HDIO_GET_UNMASKINTR get current unmask setting HDIO_GET_MULTCOUNT get current IDE blockmode setting @@ -36,9 +38,11 @@ are as follows: HDIO_DRIVE_TASK execute task and special drive command HDIO_DRIVE_CMD execute a special drive command HDIO_DRIVE_CMD_AEB HDIO_DRIVE_TASK + ======================= ======================================= ioctls that pass non-pointer values: + ======================= ======================================= HDIO_SET_MULTCOUNT change IDE blockmode HDIO_SET_UNMASKINTR permit other irqs during I/O HDIO_SET_KEEPSETTINGS keep ioctl settings on reset @@ -57,16 +61,13 @@ are as follows: HDIO_SET_IDE_SCSI Set scsi emulation mode on/off HDIO_SET_SCSI_IDE not implemented yet + ======================= ======================================= The information that follows was determined from reading kernel source code. It is likely that some corrections will be made over time. - - - - - +------------------------------------------------------------------------------ General: @@ -80,459 +81,610 @@ General: Unless otherwise specified, all data structures and constants are defined in +------------------------------------------------------------------------------ +HDIO_GETGEO + get device geometry -HDIO_GETGEO get device geometry - usage: + usage:: struct hd_geometry geom; + ioctl(fd, HDIO_GETGEO, &geom); - inputs: none + inputs: + none + + outputs: + hd_geometry structure containing: - hd_geometry structure containing: + ========= ================================== heads number of heads sectors number of sectors/track cylinders number of cylinders, mod 65536 start starting sector of this partition. + ========= ================================== error returns: - EINVAL if the device is not a disk drive or floppy drive, - or if the user passes a null pointer + - EINVAL + + if the device is not a disk drive or floppy drive, + or if the user passes a null pointer notes: + Not particularly useful with modern disk drives, whose geometry + is a polite fiction anyway. Modern drives are addressed + purely by sector number nowadays (lba addressing), and the + drive geometry is an abstraction which is actually subject + to change. Currently (as of Nov 2004), the geometry values + are the "bios" values -- presumably the values the drive had + when Linux first booted. - Not particularly useful with modern disk drives, whose geometry - is a polite fiction anyway. Modern drives are addressed - purely by sector number nowadays (lba addressing), and the - drive geometry is an abstraction which is actually subject - to change. Currently (as of Nov 2004), the geometry values - are the "bios" values -- presumably the values the drive had - when Linux first booted. + In addition, the cylinders field of the hd_geometry is an + unsigned short, meaning that on most architectures, this + ioctl will not return a meaningful value on drives with more + than 65535 tracks. - In addition, the cylinders field of the hd_geometry is an - unsigned short, meaning that on most architectures, this - ioctl will not return a meaningful value on drives with more - than 65535 tracks. + The start field is unsigned long, meaning that it will not + contain a meaningful value for disks over 219 Gb in size. - The start field is unsigned long, meaning that it will not - contain a meaningful value for disks over 219 Gb in size. +HDIO_GET_UNMASKINTR + get current unmask setting -HDIO_GET_UNMASKINTR get current unmask setting - usage: + usage:: long val; + ioctl(fd, HDIO_GET_UNMASKINTR, &val); - inputs: none + inputs: + none + + outputs: - The value of the drive's current unmask setting + The value of the drive's current unmask setting -HDIO_SET_UNMASKINTR permit other irqs during I/O - usage: + +HDIO_SET_UNMASKINTR + permit other irqs during I/O + + + usage:: unsigned long val; + ioctl(fd, HDIO_SET_UNMASKINTR, val); inputs: - New value for unmask flag + New value for unmask flag + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 1] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 1] + - EBUSY Controller busy -HDIO_GET_MULTCOUNT get current IDE blockmode setting +HDIO_GET_MULTCOUNT + get current IDE blockmode setting - usage: + + usage:: long val; + ioctl(fd, HDIO_GET_MULTCOUNT, &val); - inputs: none + inputs: + none + + outputs: - The value of the current IDE block mode setting. This - controls how many sectors the drive will transfer per - interrupt. + The value of the current IDE block mode setting. This + controls how many sectors the drive will transfer per + interrupt. -HDIO_SET_MULTCOUNT change IDE blockmode +HDIO_SET_MULTCOUNT + change IDE blockmode - usage: + + usage:: int val; + ioctl(fd, HDIO_SET_MULTCOUNT, val); inputs: - New value for IDE block mode setting. This controls how many - sectors the drive will transfer per interrupt. + New value for IDE block mode setting. This controls how many + sectors the drive will transfer per interrupt. + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range supported by disk. - EBUSY Controller busy or blockmode already set. - EIO Drive did not accept new block mode. + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range supported by disk. + - EBUSY Controller busy or blockmode already set. + - EIO Drive did not accept new block mode. notes: - - Source code comments read: + Source code comments read:: This is tightly woven into the driver->do_special cannot touch. DON'T do it again until a total personality rewrite is committed. If blockmode has already been set, this ioctl will fail with - EBUSY + -EBUSY -HDIO_GET_QDMA get use-qdma flag +HDIO_GET_QDMA + get use-qdma flag + Not implemented, as of 2.6.8.1 -HDIO_SET_XFER set transfer rate via proc +HDIO_SET_XFER + set transfer rate via proc + Not implemented, as of 2.6.8.1 -HDIO_OBSOLETE_IDENTITY OBSOLETE, DO NOT USE +HDIO_OBSOLETE_IDENTITY + OBSOLETE, DO NOT USE + Same as HDIO_GET_IDENTITY (see below), except that it only returns the first 142 bytes of drive identity information. -HDIO_GET_IDENTITY get IDE identification info +HDIO_GET_IDENTITY + get IDE identification info - usage: + + usage:: unsigned char identity[512]; + ioctl(fd, HDIO_GET_IDENTITY, identity); - inputs: none + inputs: + none + + outputs: - - ATA drive identity information. For full description, see - the IDENTIFY DEVICE and IDENTIFY PACKET DEVICE commands in - the ATA specification. + ATA drive identity information. For full description, see + the IDENTIFY DEVICE and IDENTIFY PACKET DEVICE commands in + the ATA specification. error returns: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - ENOMSG IDENTIFY DEVICE information not available + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - ENOMSG IDENTIFY DEVICE information not available notes: + Returns information that was obtained when the drive was + probed. Some of this information is subject to change, and + this ioctl does not re-probe the drive to update the + information. - Returns information that was obtained when the drive was - probed. Some of this information is subject to change, and - this ioctl does not re-probe the drive to update the - information. + This information is also available from /proc/ide/hdX/identify - This information is also available from /proc/ide/hdX/identify +HDIO_GET_KEEPSETTINGS + get keep-settings-on-reset flag -HDIO_GET_KEEPSETTINGS get keep-settings-on-reset flag - usage: + usage:: long val; + ioctl(fd, HDIO_GET_KEEPSETTINGS, &val); - inputs: none + inputs: + none + + outputs: - The value of the current "keep settings" flag + The value of the current "keep settings" flag + + notes: + When set, indicates that kernel should restore settings + after a drive reset. - When set, indicates that kernel should restore settings - after a drive reset. +HDIO_SET_KEEPSETTINGS + keep ioctl settings on reset -HDIO_SET_KEEPSETTINGS keep ioctl settings on reset - usage: + usage:: long val; + ioctl(fd, HDIO_SET_KEEPSETTINGS, val); inputs: - New value for keep_settings flag + New value for keep_settings flag + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 1] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 1] + - EBUSY Controller busy -HDIO_GET_32BIT get current io_32bit setting +HDIO_GET_32BIT + get current io_32bit setting - usage: + + usage:: long val; + ioctl(fd, HDIO_GET_32BIT, &val); - inputs: none + inputs: + none + + outputs: - The value of the current io_32bit setting + The value of the current io_32bit setting + + notes: + 0=16-bit, 1=32-bit, 2,3 = 32bit+sync - 0=16-bit, 1=32-bit, 2,3 = 32bit+sync -HDIO_GET_NOWERR get ignore-write-error flag - usage: +HDIO_GET_NOWERR + get ignore-write-error flag + + + usage:: long val; + ioctl(fd, HDIO_GET_NOWERR, &val); - inputs: none + inputs: + none + + outputs: - The value of the current ignore-write-error flag + The value of the current ignore-write-error flag -HDIO_GET_DMA get use-dma flag - usage: + +HDIO_GET_DMA + get use-dma flag + + + usage:: long val; + ioctl(fd, HDIO_GET_DMA, &val); - inputs: none + inputs: + none + + outputs: - The value of the current use-dma flag + The value of the current use-dma flag -HDIO_GET_NICE get nice flags - usage: + +HDIO_GET_NICE + get nice flags + + + usage:: long nice; + ioctl(fd, HDIO_GET_NICE, &nice); - inputs: none + inputs: + none + + outputs: + The drive's "nice" values. + - The drive's "nice" values. notes: + Per-drive flags which determine when the system will give more + bandwidth to other devices sharing the same IDE bus. - Per-drive flags which determine when the system will give more - bandwidth to other devices sharing the same IDE bus. - See , near symbol IDE_NICE_DSC_OVERLAP. + See , near symbol IDE_NICE_DSC_OVERLAP. -HDIO_SET_NICE set nice flags +HDIO_SET_NICE + set nice flags - usage: + + usage:: unsigned long nice; + ... ioctl(fd, HDIO_SET_NICE, nice); inputs: - bitmask of nice flags. + bitmask of nice flags. + + + + outputs: + none + - outputs: none error returns: - EACCES Access denied: requires CAP_SYS_ADMIN - EPERM Flags other than DSC_OVERLAP and NICE_1 set. - EPERM DSC_OVERLAP specified but not supported by drive + - EACCES Access denied: requires CAP_SYS_ADMIN + - EPERM Flags other than DSC_OVERLAP and NICE_1 set. + - EPERM DSC_OVERLAP specified but not supported by drive notes: + This ioctl sets the DSC_OVERLAP and NICE_1 flags from values + provided by the user. - This ioctl sets the DSC_OVERLAP and NICE_1 flags from values - provided by the user. + Nice flags are listed in , starting with + IDE_NICE_DSC_OVERLAP. These values represent shifts. - Nice flags are listed in , starting with - IDE_NICE_DSC_OVERLAP. These values represent shifts. +HDIO_GET_WCACHE + get write cache mode on|off -HDIO_GET_WCACHE get write cache mode on|off - usage: + usage:: long val; + ioctl(fd, HDIO_GET_WCACHE, &val); - inputs: none + inputs: + none + + outputs: - The value of the current write cache mode + The value of the current write cache mode -HDIO_GET_ACOUSTIC get acoustic value - usage: + +HDIO_GET_ACOUSTIC + get acoustic value + + + usage:: long val; + ioctl(fd, HDIO_GET_ACOUSTIC, &val); - inputs: none + inputs: + none + + outputs: - The value of the current acoustic settings + The value of the current acoustic settings + + notes: + See HDIO_SET_ACOUSTIC + - See HDIO_SET_ACOUSTIC HDIO_GET_ADDRESS + usage:: - usage: long val; + ioctl(fd, HDIO_GET_ADDRESS, &val); - inputs: none + inputs: + none + + outputs: - The value of the current addressing mode: - 0 = 28-bit - 1 = 48-bit - 2 = 48-bit doing 28-bit - 3 = 64-bit + The value of the current addressing mode: + = =================== + 0 28-bit + 1 48-bit + 2 48-bit doing 28-bit + 3 64-bit + = =================== -HDIO_GET_BUSSTATE get the bus state of the hwif - usage: +HDIO_GET_BUSSTATE + get the bus state of the hwif + + + usage:: long state; + ioctl(fd, HDIO_SCAN_HWIF, &state); - inputs: none + inputs: + none + + outputs: - Current power state of the IDE bus. One of BUSSTATE_OFF, - BUSSTATE_ON, or BUSSTATE_TRISTATE + Current power state of the IDE bus. One of BUSSTATE_OFF, + BUSSTATE_ON, or BUSSTATE_TRISTATE error returns: - EACCES Access denied: requires CAP_SYS_ADMIN + - EACCES Access denied: requires CAP_SYS_ADMIN -HDIO_SET_BUSSTATE set the bus state of the hwif +HDIO_SET_BUSSTATE + set the bus state of the hwif - usage: + + usage:: int state; + ... ioctl(fd, HDIO_SCAN_HWIF, state); inputs: - Desired IDE power state. One of BUSSTATE_OFF, BUSSTATE_ON, - or BUSSTATE_TRISTATE + Desired IDE power state. One of BUSSTATE_OFF, BUSSTATE_ON, + or BUSSTATE_TRISTATE + + outputs: + none + - outputs: none error returns: - EACCES Access denied: requires CAP_SYS_RAWIO - EOPNOTSUPP Hardware interface does not support bus power control + - EACCES Access denied: requires CAP_SYS_RAWIO + - EOPNOTSUPP Hardware interface does not support bus power control -HDIO_TRISTATE_HWIF execute a channel tristate +HDIO_TRISTATE_HWIF + execute a channel tristate + Not implemented, as of 2.6.8.1. See HDIO_SET_BUSSTATE -HDIO_DRIVE_RESET execute a device reset +HDIO_DRIVE_RESET + execute a device reset - usage: + + usage:: int args[3] + ... ioctl(fd, HDIO_DRIVE_RESET, args); - inputs: none + inputs: + none + + + + outputs: + none + - outputs: none error returns: - EACCES Access denied: requires CAP_SYS_ADMIN - ENXIO No such device: phy dead or ctl_addr == 0 - EIO I/O error: reset timed out or hardware error + - EACCES Access denied: requires CAP_SYS_ADMIN + - ENXIO No such device: phy dead or ctl_addr == 0 + - EIO I/O error: reset timed out or hardware error notes: - Execute a reset on the device as soon as the current IO - operation has completed. + - Execute a reset on the device as soon as the current IO + operation has completed. - Executes an ATAPI soft reset if applicable, otherwise - executes an ATA soft reset on the controller. + - Executes an ATAPI soft reset if applicable, otherwise + executes an ATA soft reset on the controller. -HDIO_DRIVE_TASKFILE execute raw taskfile +HDIO_DRIVE_TASKFILE + execute raw taskfile - Note: If you don't have a copy of the ANSI ATA specification - handy, you should probably ignore this ioctl. - Execute an ATA disk command directly by writing the "taskfile" - registers of the drive. Requires ADMIN and RAWIO access - privileges. + Note: + If you don't have a copy of the ANSI ATA specification + handy, you should probably ignore this ioctl. - usage: + - Execute an ATA disk command directly by writing the "taskfile" + registers of the drive. Requires ADMIN and RAWIO access + privileges. + + usage:: struct { + ide_task_request_t req_task; u8 outbuf[OUTPUT_SIZE]; u8 inbuf[INPUT_SIZE]; @@ -548,6 +700,7 @@ HDIO_DRIVE_TASKFILE execute raw taskfile (See below for details on memory area passed to ioctl.) + ============ =================================================== io_ports[8] values to be written to taskfile registers hob_ports[8] high-order bytes, for extended commands. out_flags flags indicating which registers are valid @@ -557,24 +710,29 @@ HDIO_DRIVE_TASKFILE execute raw taskfile out_size size of output buffer outbuf buffer of data to be transmitted to disk inbuf buffer of data to be received from disk (see [1]) + ============ =================================================== outputs: + =========== ==================================================== io_ports[] values returned in the taskfile registers hob_ports[] high-order bytes, for extended commands. out_flags flags indicating which registers are valid (see [2]) in_flags flags indicating which registers should be returned outbuf buffer of data to be transmitted to disk (see [1]) inbuf buffer of data to be received from disk + =========== ==================================================== error returns: - EACCES CAP_SYS_ADMIN or CAP_SYS_RAWIO privilege not set. - ENOMSG Device is not a disk drive. - ENOMEM Unable to allocate memory for task - EFAULT req_cmd == TASKFILE_IN_OUT (not implemented as of 2.6.8) - EPERM req_cmd == TASKFILE_MULTI_OUT and drive - multi-count not yet set. - EIO Drive failed the command. + - EACCES CAP_SYS_ADMIN or CAP_SYS_RAWIO privilege not set. + - ENOMSG Device is not a disk drive. + - ENOMEM Unable to allocate memory for task + - EFAULT req_cmd == TASKFILE_IN_OUT (not implemented as of 2.6.8) + - EPERM + + req_cmd == TASKFILE_MULTI_OUT and drive + multi-count not yet set. + - EIO Drive failed the command. notes: @@ -615,22 +773,25 @@ HDIO_DRIVE_TASKFILE execute raw taskfile Command is passed to the disk drive via the ide_task_request_t structure, which contains these fields: + ============ =============================================== io_ports[8] values for the taskfile registers hob_ports[8] high-order bytes, for extended commands out_flags flags indicating which entries in the - io_ports[] and hob_ports[] arrays + io_ports[] and hob_ports[] arrays contain valid values. Type ide_reg_valid_t. in_flags flags indicating which entries in the - io_ports[] and hob_ports[] arrays + io_ports[] and hob_ports[] arrays are expected to contain valid values on return. data_phase See below req_cmd Command type, see below out_size output (user->drive) buffer size, bytes in_size input (drive->user) buffer size, bytes + ============ =============================================== When out_flags is zero, the following registers are loaded. + ============ =============================================== HOB_FEATURE If the drive supports LBA48 HOB_NSECTOR If the drive supports LBA48 HOB_SECTOR If the drive supports LBA48 @@ -644,9 +805,11 @@ HDIO_DRIVE_TASKFILE execute raw taskfile SELECT First, masked with 0xE0 if LBA48, 0xEF otherwise; then, or'ed with the default value of SELECT. + ============ =============================================== If any bit in out_flags is set, the following registers are loaded. + ============ =============================================== HOB_DATA If out_flags.b.data is set. HOB_DATA will travel on DD8-DD15 on little endian machines and on DD0-DD7 on big endian machines. @@ -664,6 +827,7 @@ HDIO_DRIVE_TASKFILE execute raw taskfile HCYL If out_flags.b.hcyl is set SELECT Or'ed with the default value of SELECT and loaded regardless of out_flags.b.select. + ============ =============================================== Taskfile registers are read back from the drive into {io|hob}_ports[] after the command completes iff one of the @@ -674,6 +838,7 @@ HDIO_DRIVE_TASKFILE execute raw taskfile 2. One or more than one bits are set in out_flags. 3. The requested data_phase is TASKFILE_NO_DATA. + ============ =============================================== HOB_DATA If in_flags.b.data is set. It will contain DD8-DD15 on little endian machines and DD0-DD7 on big endian machines. @@ -689,10 +854,12 @@ HDIO_DRIVE_TASKFILE execute raw taskfile SECTOR LCYL HCYL + ============ =============================================== The data_phase field describes the data transfer to be performed. Value is one of: + =================== ======================================== TASKFILE_IN TASKFILE_MULTI_IN TASKFILE_OUT @@ -708,15 +875,18 @@ HDIO_DRIVE_TASKFILE execute raw taskfile TASKFILE_P_OUT unimplemented TASKFILE_P_OUT_DMA unimplemented TASKFILE_P_OUT_DMAQ unimplemented + =================== ======================================== The req_cmd field classifies the command type. It may be one of: + ======================== ======================================= IDE_DRIVE_TASK_NO_DATA IDE_DRIVE_TASK_SET_XFER unimplemented IDE_DRIVE_TASK_IN IDE_DRIVE_TASK_OUT unimplemented IDE_DRIVE_TASK_RAW_WRITE + ======================== ======================================= [6] Do not access {in|out}_flags->all except for resetting all the bits. Always access individual bit fields. ->all @@ -726,45 +896,57 @@ HDIO_DRIVE_TASKFILE execute raw taskfile -HDIO_DRIVE_CMD execute a special drive command +HDIO_DRIVE_CMD + execute a special drive command + Note: If you don't have a copy of the ANSI ATA specification handy, you should probably ignore this ioctl. - usage: + usage:: u8 args[4+XFER_SIZE]; + ... ioctl(fd, HDIO_DRIVE_CMD, args); inputs: + Commands other than WIN_SMART: - Commands other than WIN_SMART + ======= ======= args[0] COMMAND args[1] NSECTOR args[2] FEATURE args[3] NSECTOR + ======= ======= - WIN_SMART + WIN_SMART: + + ======= ======= args[0] COMMAND args[1] SECTOR args[2] FEATURE args[3] NSECTOR + ======= ======= outputs: + args[] buffer is filled with register values followed by any + - args[] buffer is filled with register values followed by any data returned by the disk. + + ======== ==================================================== args[0] status args[1] error args[2] NSECTOR args[3] undefined args[4+] NSECTOR * 512 bytes of data returned by the command. + ======== ==================================================== error returns: - EACCES Access denied: requires CAP_SYS_RAWIO - ENOMEM Unable to allocate memory for task - EIO Drive reports error + - EACCES Access denied: requires CAP_SYS_RAWIO + - ENOMEM Unable to allocate memory for task + - EIO Drive reports error notes: @@ -789,20 +971,24 @@ HDIO_DRIVE_CMD execute a special drive command -HDIO_DRIVE_TASK execute task and special drive command +HDIO_DRIVE_TASK + execute task and special drive command + Note: If you don't have a copy of the ANSI ATA specification handy, you should probably ignore this ioctl. - usage: + usage:: u8 args[7]; + ... ioctl(fd, HDIO_DRIVE_TASK, args); inputs: + Taskfile register values: - Taskfile register values: + ======= ======= args[0] COMMAND args[1] FEATURE args[2] NSECTOR @@ -810,10 +996,13 @@ HDIO_DRIVE_TASK execute task and special drive command args[4] LCYL args[5] HCYL args[6] SELECT + ======= ======= outputs: + Taskfile register values: - Taskfile register values: + + ======= ======= args[0] status args[1] error args[2] NSECTOR @@ -821,12 +1010,13 @@ HDIO_DRIVE_TASK execute task and special drive command args[4] LCYL args[5] HCYL args[6] SELECT + ======= ======= error returns: - EACCES Access denied: requires CAP_SYS_RAWIO - ENOMEM Unable to allocate memory for task - ENOMSG Device is not a disk drive. - EIO Drive failed the command. + - EACCES Access denied: requires CAP_SYS_RAWIO + - ENOMEM Unable to allocate memory for task + - ENOMSG Device is not a disk drive. + - EIO Drive failed the command. notes: @@ -836,236 +1026,317 @@ HDIO_DRIVE_TASK execute task and special drive command -HDIO_DRIVE_CMD_AEB HDIO_DRIVE_TASK +HDIO_DRIVE_CMD_AEB + HDIO_DRIVE_TASK + Not implemented, as of 2.6.8.1 -HDIO_SET_32BIT change io_32bit flags +HDIO_SET_32BIT + change io_32bit flags - usage: + + usage:: int val; + ioctl(fd, HDIO_SET_32BIT, val); inputs: - New value for io_32bit flag + New value for io_32bit flag + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 3] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 3] + - EBUSY Controller busy -HDIO_SET_NOWERR change ignore-write-error flag +HDIO_SET_NOWERR + change ignore-write-error flag - usage: + + usage:: int val; + ioctl(fd, HDIO_SET_NOWERR, val); inputs: - New value for ignore-write-error flag. Used for ignoring + New value for ignore-write-error flag. Used for ignoring + + WRERR_STAT - outputs: none + outputs: + none + + error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 1] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 1] + - EBUSY Controller busy -HDIO_SET_DMA change use-dma flag +HDIO_SET_DMA + change use-dma flag - usage: + + usage:: long val; + ioctl(fd, HDIO_SET_DMA, val); inputs: - New value for use-dma flag + New value for use-dma flag + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 1] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 1] + - EBUSY Controller busy -HDIO_SET_PIO_MODE reconfig interface to new speed +HDIO_SET_PIO_MODE + reconfig interface to new speed - usage: + + usage:: long val; + ioctl(fd, HDIO_SET_PIO_MODE, val); inputs: - New interface speed. + New interface speed. + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 255] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 255] + - EBUSY Controller busy -HDIO_SCAN_HWIF register and (re)scan interface +HDIO_SCAN_HWIF + register and (re)scan interface - usage: + + usage:: int args[3] + ... ioctl(fd, HDIO_SCAN_HWIF, args); inputs: + + ======= ========================= args[0] io address to probe + + args[1] control address to probe args[2] irq number + ======= ========================= + + outputs: + none + - outputs: none error returns: - EACCES Access denied: requires CAP_SYS_RAWIO - EIO Probe failed. + - EACCES Access denied: requires CAP_SYS_RAWIO + - EIO Probe failed. notes: + This ioctl initializes the addresses and irq for a disk + controller, probes for drives, and creates /proc/ide + interfaces as appropriate. - This ioctl initializes the addresses and irq for a disk - controller, probes for drives, and creates /proc/ide - interfaces as appropriate. +HDIO_UNREGISTER_HWIF + unregister interface -HDIO_UNREGISTER_HWIF unregister interface - usage: + usage:: int index; + ioctl(fd, HDIO_UNREGISTER_HWIF, index); inputs: - index index of hardware interface to unregister + index index of hardware interface to unregister + + + + outputs: + none + - outputs: none error returns: - EACCES Access denied: requires CAP_SYS_RAWIO + - EACCES Access denied: requires CAP_SYS_RAWIO notes: + This ioctl removes a hardware interface from the kernel. - This ioctl removes a hardware interface from the kernel. + Currently (2.6.8) this ioctl silently fails if any drive on + the interface is busy. - Currently (2.6.8) this ioctl silently fails if any drive on - the interface is busy. +HDIO_SET_WCACHE + change write cache enable-disable -HDIO_SET_WCACHE change write cache enable-disable - usage: + usage:: int val; + ioctl(fd, HDIO_SET_WCACHE, val); inputs: - New value for write cache enable + New value for write cache enable + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 1] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 1] + - EBUSY Controller busy -HDIO_SET_ACOUSTIC change acoustic behavior +HDIO_SET_ACOUSTIC + change acoustic behavior - usage: + + usage:: int val; + ioctl(fd, HDIO_SET_ACOUSTIC, val); inputs: - New value for drive acoustic settings + New value for drive acoustic settings + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 254] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 254] + - EBUSY Controller busy -HDIO_SET_QDMA change use-qdma flag +HDIO_SET_QDMA + change use-qdma flag + Not implemented, as of 2.6.8.1 -HDIO_SET_ADDRESS change lba addressing modes +HDIO_SET_ADDRESS + change lba addressing modes - usage: + + usage:: int val; + ioctl(fd, HDIO_SET_ADDRESS, val); inputs: - New value for addressing mode - 0 = 28-bit - 1 = 48-bit - 2 = 48-bit doing 28-bit + New value for addressing mode + + = =================== + 0 28-bit + 1 48-bit + 2 48-bit doing 28-bit + = =================== + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 2] - EBUSY Controller busy - EIO Drive does not support lba48 mode. + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 2] + - EBUSY Controller busy + - EIO Drive does not support lba48 mode. HDIO_SET_IDE_SCSI + usage:: - usage: long val; + ioctl(fd, HDIO_SET_IDE_SCSI, val); inputs: - New value for scsi emulation mode (?) + New value for scsi emulation mode (?) + + + + outputs: + none + - outputs: none error return: - EINVAL (bdev != bdev->bd_contains) (not sure what this means) - EACCES Access denied: requires CAP_SYS_ADMIN - EINVAL value out of range [0 1] - EBUSY Controller busy + - EINVAL (bdev != bdev->bd_contains) (not sure what this means) + - EACCES Access denied: requires CAP_SYS_ADMIN + - EINVAL value out of range [0 1] + - EBUSY Controller busy HDIO_SET_SCSI_IDE - Not implemented, as of 2.6.8.1 - - diff --git a/Documentation/ioctl/index.rst b/Documentation/ioctl/index.rst new file mode 100644 index 000000000000..1a6f437566e3 --- /dev/null +++ b/Documentation/ioctl/index.rst @@ -0,0 +1,16 @@ +:orphan: + +====== +IOCTLs +====== + +.. toctree:: + :maxdepth: 1 + + ioctl-number + + botching-up-ioctls + ioctl-decoding + + cdrom + hdio diff --git a/Documentation/ioctl/ioctl-decoding.txt b/Documentation/ioctl/ioctl-decoding.rst similarity index 54% rename from Documentation/ioctl/ioctl-decoding.txt rename to Documentation/ioctl/ioctl-decoding.rst index e35efb0cec2e..380d6bb3e3ea 100644 --- a/Documentation/ioctl/ioctl-decoding.txt +++ b/Documentation/ioctl/ioctl-decoding.rst @@ -1,10 +1,16 @@ +============================== +Decoding an IOCTL Magic Number +============================== + To decode a hex IOCTL code: Most architectures use this generic format, but check include/ARCH/ioctl.h for specifics, e.g. powerpc uses 3 bits to encode read/write and 13 bits for size. - bits meaning + ====== ================================== + bits meaning + ====== ================================== 31-30 00 - no parameters: uses _IO macro 10 - read: _IOR 01 - write: _IOW @@ -16,9 +22,10 @@ uses 3 bits to encode read/write and 13 bits for size. unique to each driver 7-0 function # + ====== ================================== So for example 0x82187201 is a read with arg length of 0x218, -character 'r' function 1. Grepping the source reveals this is: +character 'r' function 1. Grepping the source reveals this is:: -#define VFAT_IOCTL_READDIR_BOTH _IOR('r', 1, struct dirent [2]) + #define VFAT_IOCTL_READDIR_BOTH _IOR('r', 1, struct dirent [2]) diff --git a/drivers/gpu/drm/drm_ioctl.c b/drivers/gpu/drm/drm_ioctl.c index 9441a36a2469..bd810454d239 100644 --- a/drivers/gpu/drm/drm_ioctl.c +++ b/drivers/gpu/drm/drm_ioctl.c @@ -736,7 +736,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.txt``. Note that drm_ioctl() + * ``Documentation/ioctl/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. * From patchwork Tue Jun 18 21:05:35 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11002745 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 4C96C924 for ; Tue, 18 Jun 2019 21:06:14 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 387BB2891B for ; Tue, 18 Jun 2019 21:06:14 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2B88428A7E; Tue, 18 Jun 2019 21:06:14 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 6D440289B3 for ; Tue, 18 Jun 2019 21:06:08 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 3ADC489EBD; Tue, 18 Jun 2019 21:06:06 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) by gabe.freedesktop.org (Postfix) with ESMTPS id 8B6EC6E250 for ; Tue, 18 Jun 2019 21:06:02 +0000 (UTC) Received: from 177.133.86.196.dynamic.adsl.gvt.net.br ([177.133.86.196] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hdLIc-0006yo-8m; Tue, 18 Jun 2019 21:05:51 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hdLIZ-0002CT-UD; Tue, 18 Jun 2019 18:05:47 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v1 11/22] docs: admin-guide: add .rst files from the main dir Date: Tue, 18 Jun 2019 18:05:35 -0300 Message-Id: X-Mailer: git-send-email 2.21.0 In-Reply-To: References: MIME-Version: 1.0 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Sender:Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Reply-To:Content-Type:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=ILFlqgqUpjtOl6bcqmzPHPRjC3sELLB/zwafC8iLyLk=; b=sFLSnVYWtxVt4ZAGcxH4SZc0Cc 1Mjsb8jkKewfm9IaPUGyI7IeHGkSXsUkrmxiWNdiQjq3wKDA+BAivvCr1pgLD2jJ7aC1YG9CAPGYi o5VgVlc6ZjvHzCgFG4eQ0ePf+EMnJnqZfg4N7YlJ/XY/e5FX9k7jrz/qWb/KWqw+EAf7Z2JvrRJto Xg2WenvHPBfhrRZnoFPNjXCYUiCanBlAGZSafWsWpAAyx1vM7r+yqZ/DrBt9A5YdJsLbqrogFaJ4f x9cHHrwzmC37H4jMUqv6pqm6KSz4lnEq9tWBxyu7P3YZM8asucLCMFjjnloMcwidWe77+M4+eG1Ax o4wAYPyw==; X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-rtc@vger.kernel.org, linux-fbdev@vger.kernel.org, linux-efi@vger.kernel.org, linux-parisc@vger.kernel.org, Jonathan Corbet , linux-ntfs-dev@lists.sourceforge.net, netdev@vger.kernel.org, x86@kernel.org, linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Mauro Carvalho Chehab , linux-block@vger.kernel.org, sparclinux@vger.kernel.org, linux-security-module@vger.kernel.org, linux-video@atrey.karlin.mff.cuni.cz, linux-crypto@vger.kernel.org, linux-sh@vger.kernel.org, Mauro Carvalho Chehab , cgroups@vger.kernel.org, bpf@vger.kernel.org, linux-arm-kernel@lists.infradead.org Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP Those files belong to the admin guide. Add them to the admin-guide book. Signed-off-by: Mauro Carvalho Chehab --- I had to remove the long list of maintainers got by getpatch.pl, as it was too long. I opted to keep only the mailing lists. Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-diskstats | 2 +- Documentation/ABI/testing/sysfs-block | 2 +- .../ABI/testing/sysfs-devices-system-cpu | 4 ++-- Documentation/{ => admin-guide}/aoe/aoe.rst | 4 ++-- .../{ => admin-guide}/aoe/autoload.sh | 1 - .../{ => admin-guide}/aoe/examples.rst | 0 Documentation/{ => admin-guide}/aoe/index.rst | 2 -- Documentation/{ => admin-guide}/aoe/status.sh | 0 Documentation/{ => admin-guide}/aoe/todo.rst | 0 .../{ => admin-guide}/aoe/udev-install.sh | 4 ++-- Documentation/{ => admin-guide}/aoe/udev.txt | 8 +++---- Documentation/{ => admin-guide}/btmrvl.rst | 2 -- .../cgroup-v1/blkio-controller.rst | 0 .../{ => admin-guide}/cgroup-v1/cgroups.rst | 4 ++-- .../{ => admin-guide}/cgroup-v1/cpuacct.rst | 0 .../{ => admin-guide}/cgroup-v1/cpusets.rst | 2 +- .../{ => admin-guide}/cgroup-v1/devices.rst | 0 .../cgroup-v1/freezer-subsystem.rst | 0 .../{ => admin-guide}/cgroup-v1/hugetlb.rst | 0 .../{ => admin-guide}/cgroup-v1/index.rst | 2 -- .../cgroup-v1/memcg_test.rst | 4 ++-- .../{ => admin-guide}/cgroup-v1/memory.rst | 0 .../{ => admin-guide}/cgroup-v1/net_cls.rst | 0 .../{ => admin-guide}/cgroup-v1/net_prio.rst | 0 .../{ => admin-guide}/cgroup-v1/pids.rst | 0 .../{ => admin-guide}/cgroup-v1/rdma.rst | 0 Documentation/admin-guide/cgroup-v2.rst | 2 +- .../{ => admin-guide}/clearing-warn-once.rst | 2 -- Documentation/{ => admin-guide}/cpu-load.rst | 2 -- .../{ => admin-guide}/cputopology.rst | 2 -- Documentation/{ => admin-guide}/efi-stub.rst | 2 -- Documentation/{ => admin-guide}/highuid.rst | 2 -- Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- Documentation/{ => admin-guide}/hw_random.rst | 2 -- Documentation/admin-guide/index.rst | 23 +++++++++++++++++++ Documentation/{ => admin-guide}/iostats.rst | 2 -- .../admin-guide/kernel-parameters.txt | 6 ++--- .../kernel-per-cpu-kthreads.rst} | 4 +--- .../lcd-panel-cgram.rst | 2 -- Documentation/{ => admin-guide}/ldm.rst | 2 -- .../{ => admin-guide}/lockup-watchdogs.rst | 2 -- .../mm/cma_debugfs.rst} | 2 -- .../admin-guide/mm/numa_memory_policy.rst | 2 +- Documentation/{ => admin-guide}/numastat.rst | 4 +--- Documentation/{ => admin-guide}/pnp.rst | 2 -- Documentation/{ => admin-guide}/rtc.rst | 2 -- Documentation/{ => admin-guide}/svga.rst | 2 -- .../{ => admin-guide}/video-output.rst | 2 -- Documentation/block/bfq-iosched.rst | 2 +- Documentation/device-mapper/statistics.rst | 4 ++-- Documentation/driver-api/index.rst | 2 +- Documentation/fb/vesafb.rst | 2 +- Documentation/filesystems/tmpfs.txt | 2 +- Documentation/scheduler/sched-deadline.rst | 2 +- Documentation/scheduler/sched-design-CFS.rst | 2 +- Documentation/scheduler/sched-rt-group.rst | 2 +- Documentation/sysctl/kernel.rst | 2 +- Documentation/vm/numa.rst | 4 ++-- Documentation/vm/page_migration.rst | 2 +- Documentation/vm/unevictable-lru.rst | 2 +- Documentation/x86/topology.rst | 2 +- .../x86/x86_64/fake-numa-for-cpusets.rst | 4 ++-- MAINTAINERS | 18 +++++++-------- arch/arm/Kconfig | 2 +- arch/parisc/Kconfig | 2 +- arch/sh/Kconfig | 2 +- arch/sparc/Kconfig | 2 +- arch/x86/Kconfig | 4 ++-- block/Kconfig | 2 +- block/partitions/Kconfig | 2 +- drivers/char/Kconfig | 4 ++-- drivers/char/hw_random/core.c | 2 +- include/linux/cgroup-defs.h | 2 +- include/linux/hw_random.h | 2 +- include/uapi/linux/bpf.h | 2 +- init/Kconfig | 4 ++-- kernel/cgroup/cpuset.c | 2 +- security/device_cgroup.c | 2 +- tools/include/uapi/linux/bpf.h | 2 +- 80 files changed, 94 insertions(+), 112 deletions(-) rename Documentation/{ => admin-guide}/aoe/aoe.rst (97%) rename Documentation/{ => admin-guide}/aoe/autoload.sh (99%) rename Documentation/{ => admin-guide}/aoe/examples.rst (100%) rename Documentation/{ => admin-guide}/aoe/index.rst (95%) rename Documentation/{ => admin-guide}/aoe/status.sh (100%) rename Documentation/{ => admin-guide}/aoe/todo.rst (100%) rename Documentation/{ => admin-guide}/aoe/udev-install.sh (92%) rename Documentation/{ => admin-guide}/aoe/udev.txt (91%) rename Documentation/{ => admin-guide}/btmrvl.rst (99%) rename Documentation/{ => admin-guide}/cgroup-v1/blkio-controller.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst (99%) rename Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst (99%) rename Documentation/{ => admin-guide}/cgroup-v1/devices.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/freezer-subsystem.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/index.rst (97%) rename Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst (98%) rename Documentation/{ => admin-guide}/cgroup-v1/memory.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/pids.rst (100%) rename Documentation/{ => admin-guide}/cgroup-v1/rdma.rst (100%) rename Documentation/{ => admin-guide}/clearing-warn-once.rst (96%) rename Documentation/{ => admin-guide}/cpu-load.rst (99%) rename Documentation/{ => admin-guide}/cputopology.rst (99%) rename Documentation/{ => admin-guide}/efi-stub.rst (99%) rename Documentation/{ => admin-guide}/highuid.rst (99%) rename Documentation/{ => admin-guide}/hw_random.rst (99%) rename Documentation/{ => admin-guide}/iostats.rst (99%) rename Documentation/{kernel-per-CPU-kthreads.rst => admin-guide/kernel-per-cpu-kthreads.rst} (99%) rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%) rename Documentation/{ => admin-guide}/ldm.rst (99%) rename Documentation/{ => admin-guide}/lockup-watchdogs.rst (99%) rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%) rename Documentation/{ => admin-guide}/numastat.rst (93%) rename Documentation/{ => admin-guide}/pnp.rst (99%) rename Documentation/{ => admin-guide}/rtc.rst (99%) rename Documentation/{ => admin-guide}/svga.rst (99%) rename Documentation/{ => admin-guide}/video-output.rst (99%) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index de1d022c0864..df8413cf1468 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -61,7 +61,7 @@ Date: October 2002 Contact: Linux Memory Management list Description: The node's hit/miss statistics, in units of pages. - See Documentation/numastat.rst + See Documentation/admin-guide/numastat.rst What: /sys/devices/system/node/nodeX/distance Date: October 2002 diff --git a/Documentation/ABI/testing/procfs-diskstats b/Documentation/ABI/testing/procfs-diskstats index 26661dd5188b..2c44b4f1b060 100644 --- a/Documentation/ABI/testing/procfs-diskstats +++ b/Documentation/ABI/testing/procfs-diskstats @@ -29,4 +29,4 @@ Description: 17 - sectors discarded 18 - time spent discarding - For more details refer to Documentation/iostats.rst + For more details refer to Documentation/admin-guide/iostats.rst diff --git a/Documentation/ABI/testing/sysfs-block b/Documentation/ABI/testing/sysfs-block index d300a6b9d17c..f8c7c7126bb1 100644 --- a/Documentation/ABI/testing/sysfs-block +++ b/Documentation/ABI/testing/sysfs-block @@ -15,7 +15,7 @@ Description: 9 - I/Os currently in progress 10 - time spent doing I/Os (ms) 11 - weighted time spent doing I/Os (ms) - For more details refer Documentation/iostats.rst + For more details refer Documentation/admin-guide/iostats.rst What: /sys/block///stat diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu index 1a2653f5261f..d1aad0ea0ab9 100644 --- a/Documentation/ABI/testing/sysfs-devices-system-cpu +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu @@ -34,7 +34,7 @@ Description: CPU topology files that describe kernel limits related to present: cpus that have been identified as being present in the system. - See Documentation/cputopology.rst for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/probe @@ -103,7 +103,7 @@ Description: CPU topology files that describe a logical CPU's relationship thread_siblings_list: human-readable list of cpu#'s hardware threads within the same core as cpu# - See Documentation/cputopology.rst for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/cpuidle/current_driver diff --git a/Documentation/aoe/aoe.rst b/Documentation/admin-guide/aoe/aoe.rst similarity index 97% rename from Documentation/aoe/aoe.rst rename to Documentation/admin-guide/aoe/aoe.rst index 58747ecec71d..a05e751363a0 100644 --- a/Documentation/aoe/aoe.rst +++ b/Documentation/admin-guide/aoe/aoe.rst @@ -20,7 +20,7 @@ driver. The aoetools are on sourceforge. http://aoetools.sourceforge.net/ -The scripts in this Documentation/aoe directory are intended to +The scripts in this Documentation/admin-guide/aoe directory are intended to document the use of the driver and are not necessary if you install the aoetools. @@ -86,7 +86,7 @@ Using sysfs a convenient way. Users with aoetools should use the aoe-stat command:: - root@makki root# sh Documentation/aoe/status.sh + root@makki root# sh Documentation/admin-guide/aoe/status.sh e10.0 eth3 up e10.1 eth3 up e10.2 eth3 up diff --git a/Documentation/aoe/autoload.sh b/Documentation/admin-guide/aoe/autoload.sh similarity index 99% rename from Documentation/aoe/autoload.sh rename to Documentation/admin-guide/aoe/autoload.sh index 815dff4691c9..591a58d6c3c6 100644 --- a/Documentation/aoe/autoload.sh +++ b/Documentation/admin-guide/aoe/autoload.sh @@ -14,4 +14,3 @@ if [ $? = 1 ]; then echo alias block-major-152 aoe >> $f echo alias char-major-152 aoe >> $f fi - diff --git a/Documentation/aoe/examples.rst b/Documentation/admin-guide/aoe/examples.rst similarity index 100% rename from Documentation/aoe/examples.rst rename to Documentation/admin-guide/aoe/examples.rst diff --git a/Documentation/aoe/index.rst b/Documentation/admin-guide/aoe/index.rst similarity index 95% rename from Documentation/aoe/index.rst rename to Documentation/admin-guide/aoe/index.rst index 4394b9b7913c..d71c5df15922 100644 --- a/Documentation/aoe/index.rst +++ b/Documentation/admin-guide/aoe/index.rst @@ -1,5 +1,3 @@ -:orphan: - ======================= ATA over Ethernet (AoE) ======================= diff --git a/Documentation/aoe/status.sh b/Documentation/admin-guide/aoe/status.sh similarity index 100% rename from Documentation/aoe/status.sh rename to Documentation/admin-guide/aoe/status.sh diff --git a/Documentation/aoe/todo.rst b/Documentation/admin-guide/aoe/todo.rst similarity index 100% rename from Documentation/aoe/todo.rst rename to Documentation/admin-guide/aoe/todo.rst diff --git a/Documentation/aoe/udev-install.sh b/Documentation/admin-guide/aoe/udev-install.sh similarity index 92% rename from Documentation/aoe/udev-install.sh rename to Documentation/admin-guide/aoe/udev-install.sh index 15e86f58c036..1404d629a249 100644 --- a/Documentation/aoe/udev-install.sh +++ b/Documentation/admin-guide/aoe/udev-install.sh @@ -1,6 +1,6 @@ -# install the aoe-specific udev rules from udev.txt into +# install the aoe-specific udev rules from udev.txt into # the system's udev configuration -# +# me="`basename $0`" diff --git a/Documentation/aoe/udev.txt b/Documentation/admin-guide/aoe/udev.txt similarity index 91% rename from Documentation/aoe/udev.txt rename to Documentation/admin-guide/aoe/udev.txt index 54feda5a0772..d55ecb411c21 100644 --- a/Documentation/aoe/udev.txt +++ b/Documentation/admin-guide/aoe/udev.txt @@ -2,7 +2,7 @@ # They may be installed along the following lines. Check the section # 8 udev manpage to see whether your udev supports SUBSYSTEM, and # whether it uses one or two equal signs for SUBSYSTEM and KERNEL. -# +# # ecashin@makki ~$ su # Password: # bash# find /etc -type f -name udev.conf @@ -11,9 +11,9 @@ # udev_rules="/etc/udev/rules.d/" # bash# ls /etc/udev/rules.d/ # 10-wacom.rules 50-udev.rules -# bash# cp /path/to/linux/Documentation/aoe/udev.txt \ +# bash# cp /path/to/linux/Documentation/admin-guide/aoe/udev.txt \ # /etc/udev/rules.d/60-aoe.rules -# +# # aoe char devices SUBSYSTEM=="aoe", KERNEL=="discover", NAME="etherd/%k", GROUP="disk", MODE="0220" @@ -22,5 +22,5 @@ SUBSYSTEM=="aoe", KERNEL=="interfaces", NAME="etherd/%k", GROUP="disk", MODE="02 SUBSYSTEM=="aoe", KERNEL=="revalidate", NAME="etherd/%k", GROUP="disk", MODE="0220" SUBSYSTEM=="aoe", KERNEL=="flush", NAME="etherd/%k", GROUP="disk", MODE="0220" -# aoe block devices +# aoe block devices KERNEL=="etherd*", GROUP="disk" diff --git a/Documentation/btmrvl.rst b/Documentation/admin-guide/btmrvl.rst similarity index 99% rename from Documentation/btmrvl.rst rename to Documentation/admin-guide/btmrvl.rst index e6dd1c96e842..ec57740ead0c 100644 --- a/Documentation/btmrvl.rst +++ b/Documentation/admin-guide/btmrvl.rst @@ -1,5 +1,3 @@ -:orphan: - ============= btmrvl driver ============= diff --git a/Documentation/cgroup-v1/blkio-controller.rst b/Documentation/admin-guide/cgroup-v1/blkio-controller.rst similarity index 100% rename from Documentation/cgroup-v1/blkio-controller.rst rename to Documentation/admin-guide/cgroup-v1/blkio-controller.rst diff --git a/Documentation/cgroup-v1/cgroups.rst b/Documentation/admin-guide/cgroup-v1/cgroups.rst similarity index 99% rename from Documentation/cgroup-v1/cgroups.rst rename to Documentation/admin-guide/cgroup-v1/cgroups.rst index 46bbe7e022d4..b0688011ed06 100644 --- a/Documentation/cgroup-v1/cgroups.rst +++ b/Documentation/admin-guide/cgroup-v1/cgroups.rst @@ -3,7 +3,7 @@ Control Groups ============== Written by Paul Menage based on -Documentation/cgroup-v1/cpusets.rst +Documentation/admin-guide/cgroup-v1/cpusets.rst Original copyright statements from cpusets.txt: @@ -76,7 +76,7 @@ On their own, the only use for cgroups is for simple job tracking. The intention is that other subsystems hook into the generic cgroup support to provide new attributes for cgroups, such as accounting/limiting the resources which processes in a cgroup can -access. For example, cpusets (see Documentation/cgroup-v1/cpusets.rst) allow +access. For example, cpusets (see Documentation/admin-guide/cgroup-v1/cpusets.rst) allow you to associate a set of CPUs and a set of memory nodes with the tasks in each cgroup. diff --git a/Documentation/cgroup-v1/cpuacct.rst b/Documentation/admin-guide/cgroup-v1/cpuacct.rst similarity index 100% rename from Documentation/cgroup-v1/cpuacct.rst rename to Documentation/admin-guide/cgroup-v1/cpuacct.rst diff --git a/Documentation/cgroup-v1/cpusets.rst b/Documentation/admin-guide/cgroup-v1/cpusets.rst similarity index 99% rename from Documentation/cgroup-v1/cpusets.rst rename to Documentation/admin-guide/cgroup-v1/cpusets.rst index b6a42cdea72b..86a6ae995d54 100644 --- a/Documentation/cgroup-v1/cpusets.rst +++ b/Documentation/admin-guide/cgroup-v1/cpusets.rst @@ -49,7 +49,7 @@ hooks, beyond what is already present, required to manage dynamic job placement on large systems. Cpusets use the generic cgroup subsystem described in -Documentation/cgroup-v1/cgroups.rst. +Documentation/admin-guide/cgroup-v1/cgroups.rst. Requests by a task, using the sched_setaffinity(2) system call to include CPUs in its CPU affinity mask, and using the mbind(2) and diff --git a/Documentation/cgroup-v1/devices.rst b/Documentation/admin-guide/cgroup-v1/devices.rst similarity index 100% rename from Documentation/cgroup-v1/devices.rst rename to Documentation/admin-guide/cgroup-v1/devices.rst diff --git a/Documentation/cgroup-v1/freezer-subsystem.rst b/Documentation/admin-guide/cgroup-v1/freezer-subsystem.rst similarity index 100% rename from Documentation/cgroup-v1/freezer-subsystem.rst rename to Documentation/admin-guide/cgroup-v1/freezer-subsystem.rst diff --git a/Documentation/cgroup-v1/hugetlb.rst b/Documentation/admin-guide/cgroup-v1/hugetlb.rst similarity index 100% rename from Documentation/cgroup-v1/hugetlb.rst rename to Documentation/admin-guide/cgroup-v1/hugetlb.rst diff --git a/Documentation/cgroup-v1/index.rst b/Documentation/admin-guide/cgroup-v1/index.rst similarity index 97% rename from Documentation/cgroup-v1/index.rst rename to Documentation/admin-guide/cgroup-v1/index.rst index fe76d42edc11..10bf48bae0b0 100644 --- a/Documentation/cgroup-v1/index.rst +++ b/Documentation/admin-guide/cgroup-v1/index.rst @@ -1,5 +1,3 @@ -:orphan: - ======================== Control Groups version 1 ======================== diff --git a/Documentation/cgroup-v1/memcg_test.rst b/Documentation/admin-guide/cgroup-v1/memcg_test.rst similarity index 98% rename from Documentation/cgroup-v1/memcg_test.rst rename to Documentation/admin-guide/cgroup-v1/memcg_test.rst index 91bd18c6a514..3f7115e07b5d 100644 --- a/Documentation/cgroup-v1/memcg_test.rst +++ b/Documentation/admin-guide/cgroup-v1/memcg_test.rst @@ -10,7 +10,7 @@ Because VM is getting complex (one of reasons is memcg...), memcg's behavior is complex. This is a document for memcg's internal behavior. Please note that implementation details can be changed. -(*) Topics on API should be in Documentation/cgroup-v1/memory.rst) +(*) Topics on API should be in Documentation/admin-guide/cgroup-v1/memory.rst) 0. How to record usage ? ======================== @@ -327,7 +327,7 @@ Under below explanation, we assume CONFIG_MEM_RES_CTRL_SWAP=y. You can see charges have been moved by reading ``*.usage_in_bytes`` or memory.stat of both A and B. - See 8.2 of Documentation/cgroup-v1/memory.rst to see what value should + See 8.2 of Documentation/admin-guide/cgroup-v1/memory.rst to see what value should be written to move_charge_at_immigrate. 9.10 Memory thresholds diff --git a/Documentation/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst similarity index 100% rename from Documentation/cgroup-v1/memory.rst rename to Documentation/admin-guide/cgroup-v1/memory.rst diff --git a/Documentation/cgroup-v1/net_cls.rst b/Documentation/admin-guide/cgroup-v1/net_cls.rst similarity index 100% rename from Documentation/cgroup-v1/net_cls.rst rename to Documentation/admin-guide/cgroup-v1/net_cls.rst diff --git a/Documentation/cgroup-v1/net_prio.rst b/Documentation/admin-guide/cgroup-v1/net_prio.rst similarity index 100% rename from Documentation/cgroup-v1/net_prio.rst rename to Documentation/admin-guide/cgroup-v1/net_prio.rst diff --git a/Documentation/cgroup-v1/pids.rst b/Documentation/admin-guide/cgroup-v1/pids.rst similarity index 100% rename from Documentation/cgroup-v1/pids.rst rename to Documentation/admin-guide/cgroup-v1/pids.rst diff --git a/Documentation/cgroup-v1/rdma.rst b/Documentation/admin-guide/cgroup-v1/rdma.rst similarity index 100% rename from Documentation/cgroup-v1/rdma.rst rename to Documentation/admin-guide/cgroup-v1/rdma.rst diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst index 4b971a0bc99a..125c5cc15fe7 100644 --- a/Documentation/admin-guide/cgroup-v2.rst +++ b/Documentation/admin-guide/cgroup-v2.rst @@ -9,7 +9,7 @@ This is the authoritative documentation on the design, interface and conventions of cgroup v2. It describes all userland-visible aspects of cgroup including core and specific controller behaviors. All future changes must be reflected in this document. Documentation for -v1 is available under Documentation/cgroup-v1/. +v1 is available under Documentation/admin-guide/cgroup-v1/. .. CONTENTS diff --git a/Documentation/clearing-warn-once.rst b/Documentation/admin-guide/clearing-warn-once.rst similarity index 96% rename from Documentation/clearing-warn-once.rst rename to Documentation/admin-guide/clearing-warn-once.rst index cdfa892c7fdf..211fd926cf00 100644 --- a/Documentation/clearing-warn-once.rst +++ b/Documentation/admin-guide/clearing-warn-once.rst @@ -1,5 +1,3 @@ -:orphan: - Clearing WARN_ONCE ------------------ diff --git a/Documentation/cpu-load.rst b/Documentation/admin-guide/cpu-load.rst similarity index 99% rename from Documentation/cpu-load.rst rename to Documentation/admin-guide/cpu-load.rst index 6b2815b78683..2d01ce43d2a2 100644 --- a/Documentation/cpu-load.rst +++ b/Documentation/admin-guide/cpu-load.rst @@ -1,5 +1,3 @@ -:orphan: - ======== CPU load ======== diff --git a/Documentation/cputopology.rst b/Documentation/admin-guide/cputopology.rst similarity index 99% rename from Documentation/cputopology.rst rename to Documentation/admin-guide/cputopology.rst index ef1e6b105957..b90dafcc8237 100644 --- a/Documentation/cputopology.rst +++ b/Documentation/admin-guide/cputopology.rst @@ -1,5 +1,3 @@ -:orphan: - =========================================== How CPU topology info is exported via sysfs =========================================== diff --git a/Documentation/efi-stub.rst b/Documentation/admin-guide/efi-stub.rst similarity index 99% rename from Documentation/efi-stub.rst rename to Documentation/admin-guide/efi-stub.rst index 29256cad8af3..833edb0d0bc4 100644 --- a/Documentation/efi-stub.rst +++ b/Documentation/admin-guide/efi-stub.rst @@ -1,5 +1,3 @@ -:orphan: - ================= The EFI Boot Stub ================= diff --git a/Documentation/highuid.rst b/Documentation/admin-guide/highuid.rst similarity index 99% rename from Documentation/highuid.rst rename to Documentation/admin-guide/highuid.rst index d1cbc71a59a2..1ab59d7807d1 100644 --- a/Documentation/highuid.rst +++ b/Documentation/admin-guide/highuid.rst @@ -1,5 +1,3 @@ -:orphan: - =================================================== Notes on the change from 16-bit UIDs to 32-bit UIDs =================================================== diff --git a/Documentation/admin-guide/hw-vuln/l1tf.rst b/Documentation/admin-guide/hw-vuln/l1tf.rst index 5668fc2013ce..9b1e6aafea1f 100644 --- a/Documentation/admin-guide/hw-vuln/l1tf.rst +++ b/Documentation/admin-guide/hw-vuln/l1tf.rst @@ -241,7 +241,7 @@ Guest mitigation mechanisms For further information about confining guests to a single or to a group of cores consult the cpusets documentation: - https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.rst + https://www.kernel.org/doc/Documentation/admin-guide/cgroup-v1/cpusets.rst .. _interrupt_isolation: diff --git a/Documentation/hw_random.rst b/Documentation/admin-guide/hw_random.rst similarity index 99% rename from Documentation/hw_random.rst rename to Documentation/admin-guide/hw_random.rst index fb5e32fae384..121de96e395e 100644 --- a/Documentation/hw_random.rst +++ b/Documentation/admin-guide/hw_random.rst @@ -1,5 +1,3 @@ -:orphan: - ========================================================== Linux support for random number generator in i8xx chipsets ========================================================== diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index 8001917ee012..ba9ff8e3b45a 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -56,6 +56,7 @@ configure specific aspects of kernel behavior to your liking. initrd cgroup-v2 + cgroup-v1/index serial-console braille-console parport @@ -74,9 +75,31 @@ configure specific aspects of kernel behavior to your liking. thunderbolt LSM/index mm/index + aoe/index perf-security acpi/index + btmrvl + clearing-warn-once + cpu-load + cputopology + highuid + hw_random + ldm + pnp + rtc + video-output + efi-stub + iostats + kernel-per-cpu-kthreads + lcd-panel-cgram + lockup-watchdogs + mm/cma_debugfs + numastat + svga + + + .. only:: subproject and html Indices diff --git a/Documentation/iostats.rst b/Documentation/admin-guide/iostats.rst similarity index 99% rename from Documentation/iostats.rst rename to Documentation/admin-guide/iostats.rst index f4d37d812c30..5d63b18bd6d1 100644 --- a/Documentation/iostats.rst +++ b/Documentation/admin-guide/iostats.rst @@ -1,5 +1,3 @@ -:orphan: - ===================== I/O statistics fields ===================== diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index d11b8a745897..95885726778c 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -4098,7 +4098,7 @@ relax_domain_level= [KNL, SMP] Set scheduler's default relax_domain_level. - See Documentation/cgroup-v1/cpusets.rst. + See Documentation/admin-guide/cgroup-v1/cpusets.rst. reserve= [KNL,BUGS] Force kernel to ignore I/O ports or memory Format: ,[,,,...] @@ -4608,7 +4608,7 @@ swapaccount=[0|1] [KNL] Enable accounting of swap in memory resource controller if no parameter or 1 is given or disable - it if 0 is given (See Documentation/cgroup-v1/memory.rst) + it if 0 is given (See Documentation/admin-guide/cgroup-v1/memory.rst) swiotlb= [ARM,IA-64,PPC,MIPS,X86] Format: { | force | noforce } @@ -5075,7 +5075,7 @@ vga= [BOOT,X86-32] Select a particular video mode See Documentation/x86/boot.rst and - Documentation/svga.rst. + Documentation/admin-guide/svga.rst. Use vga=ask for menu. This is actually a boot loader parameter; the value is passed to the kernel using a special protocol. diff --git a/Documentation/kernel-per-CPU-kthreads.rst b/Documentation/admin-guide/kernel-per-cpu-kthreads.rst similarity index 99% rename from Documentation/kernel-per-CPU-kthreads.rst rename to Documentation/admin-guide/kernel-per-cpu-kthreads.rst index 765c7b9bd7fd..d430048a0307 100644 --- a/Documentation/kernel-per-CPU-kthreads.rst +++ b/Documentation/admin-guide/kernel-per-cpu-kthreads.rst @@ -1,5 +1,3 @@ -:orphan: - ========================================== Reducing OS jitter due to per-cpu kthreads ========================================== @@ -14,7 +12,7 @@ References - Documentation/IRQ-affinity.rst: Binding interrupts to sets of CPUs. -- Documentation/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. +- Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. - man taskset: Using the taskset command to bind tasks to sets of CPUs. diff --git a/Documentation/auxdisplay/lcd-panel-cgram.rst b/Documentation/admin-guide/lcd-panel-cgram.rst similarity index 99% rename from Documentation/auxdisplay/lcd-panel-cgram.rst rename to Documentation/admin-guide/lcd-panel-cgram.rst index dfef50286018..a3eb00c62f53 100644 --- a/Documentation/auxdisplay/lcd-panel-cgram.rst +++ b/Documentation/admin-guide/lcd-panel-cgram.rst @@ -1,5 +1,3 @@ -:orphan: - ====================================== Parallel port LCD/Keypad Panel support ====================================== diff --git a/Documentation/ldm.rst b/Documentation/admin-guide/ldm.rst similarity index 99% rename from Documentation/ldm.rst rename to Documentation/admin-guide/ldm.rst index 1e8739669541..90ccf24ebfdd 100644 --- a/Documentation/ldm.rst +++ b/Documentation/admin-guide/ldm.rst @@ -1,5 +1,3 @@ -:orphan: - ========================================== LDM - Logical Disk Manager (Dynamic Disks) ========================================== diff --git a/Documentation/lockup-watchdogs.rst b/Documentation/admin-guide/lockup-watchdogs.rst similarity index 99% rename from Documentation/lockup-watchdogs.rst rename to Documentation/admin-guide/lockup-watchdogs.rst index a60598bfd50f..290840c160af 100644 --- a/Documentation/lockup-watchdogs.rst +++ b/Documentation/admin-guide/lockup-watchdogs.rst @@ -1,5 +1,3 @@ -:orphan: - =============================================================== Softlockup detector and hardlockup detector (aka nmi_watchdog) =============================================================== diff --git a/Documentation/cma/debugfs.rst b/Documentation/admin-guide/mm/cma_debugfs.rst similarity index 98% rename from Documentation/cma/debugfs.rst rename to Documentation/admin-guide/mm/cma_debugfs.rst index 518fe401b5ee..4e06ffabd78a 100644 --- a/Documentation/cma/debugfs.rst +++ b/Documentation/admin-guide/mm/cma_debugfs.rst @@ -1,5 +1,3 @@ -:orphan: - ===================== CMA Debugfs Interface ===================== diff --git a/Documentation/admin-guide/mm/numa_memory_policy.rst b/Documentation/admin-guide/mm/numa_memory_policy.rst index 546f174e5d6a..8463f5538fda 100644 --- a/Documentation/admin-guide/mm/numa_memory_policy.rst +++ b/Documentation/admin-guide/mm/numa_memory_policy.rst @@ -15,7 +15,7 @@ document attempts to describe the concepts and APIs of the 2.6 memory policy support. Memory policies should not be confused with cpusets -(``Documentation/cgroup-v1/cpusets.rst``) +(``Documentation/admin-guide/cgroup-v1/cpusets.rst``) which is an administrative mechanism for restricting the nodes from which memory may be allocated by a set of processes. Memory policies are a programming interface that a NUMA-aware application can take advantage of. When diff --git a/Documentation/numastat.rst b/Documentation/admin-guide/numastat.rst similarity index 93% rename from Documentation/numastat.rst rename to Documentation/admin-guide/numastat.rst index 762925cfe882..94b7f0477f97 100644 --- a/Documentation/numastat.rst +++ b/Documentation/admin-guide/numastat.rst @@ -1,5 +1,3 @@ -:orphan: - =============================== Numa policy hit/miss statistics =============================== @@ -22,7 +20,7 @@ local_node A process ran on this node and got memory from it. other_node A process ran on this node and got memory from another node. -interleave_hit Interleaving wanted to allocate from this node +interleave_hit Interleaving wanted to allocate from this node and succeeded. =============== ============================================================ diff --git a/Documentation/pnp.rst b/Documentation/admin-guide/pnp.rst similarity index 99% rename from Documentation/pnp.rst rename to Documentation/admin-guide/pnp.rst index ef84f35a9b47..c103acb9ad99 100644 --- a/Documentation/pnp.rst +++ b/Documentation/admin-guide/pnp.rst @@ -1,5 +1,3 @@ -:orphan: - ================================= Linux Plug and Play Documentation ================================= diff --git a/Documentation/rtc.rst b/Documentation/admin-guide/rtc.rst similarity index 99% rename from Documentation/rtc.rst rename to Documentation/admin-guide/rtc.rst index 6893bb5cf0ef..c7647de33c69 100644 --- a/Documentation/rtc.rst +++ b/Documentation/admin-guide/rtc.rst @@ -1,5 +1,3 @@ -:orphan: - ======================================= Real Time Clock (RTC) Drivers for Linux ======================================= diff --git a/Documentation/svga.rst b/Documentation/admin-guide/svga.rst similarity index 99% rename from Documentation/svga.rst rename to Documentation/admin-guide/svga.rst index 1bfd54d9fb59..b6c2f9acca92 100644 --- a/Documentation/svga.rst +++ b/Documentation/admin-guide/svga.rst @@ -1,5 +1,3 @@ -:orphan: - .. include:: ================================= diff --git a/Documentation/video-output.rst b/Documentation/admin-guide/video-output.rst similarity index 99% rename from Documentation/video-output.rst rename to Documentation/admin-guide/video-output.rst index 9095c4be45e5..aab623cfb2f3 100644 --- a/Documentation/video-output.rst +++ b/Documentation/admin-guide/video-output.rst @@ -1,5 +1,3 @@ -:orphan: - Video Output Switcher Control ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/Documentation/block/bfq-iosched.rst b/Documentation/block/bfq-iosched.rst index 3fd9e8029347..6636ad2dad3f 100644 --- a/Documentation/block/bfq-iosched.rst +++ b/Documentation/block/bfq-iosched.rst @@ -547,7 +547,7 @@ As for cgroups-v1 (blkio controller), the exact set of stat files created, and kept up-to-date by bfq, depends on whether CONFIG_DEBUG_BLK_CGROUP is set. If it is set, then bfq creates all the stat files documented in -Documentation/cgroup-v1/blkio-controller.rst. If, instead, +Documentation/admin-guide/cgroup-v1/blkio-controller.rst. If, instead, CONFIG_DEBUG_BLK_CGROUP is not set, then bfq creates only the files:: blkio.bfq.io_service_bytes diff --git a/Documentation/device-mapper/statistics.rst b/Documentation/device-mapper/statistics.rst index 39f74af35abb..41ded0bc5933 100644 --- a/Documentation/device-mapper/statistics.rst +++ b/Documentation/device-mapper/statistics.rst @@ -13,7 +13,7 @@ the range specified. The I/O statistics counters for each step-sized area of a region are in the same format as `/sys/block/*/stat` or `/proc/diskstats` (see: -Documentation/iostats.rst). But two extra counters (12 and 13) are +Documentation/admin-guide/iostats.rst). But two extra counters (12 and 13) are provided: total time spent reading and writing. When the histogram argument is used, the 14th parameter is reported that represents the histogram of latencies. All these counters may be accessed by sending @@ -151,7 +151,7 @@ Messages The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. - Please refer to Documentation/iostats.rst for details. + Please refer to Documentation/admin-guide/iostats.rst for details. 1. the number of reads completed 2. the number of reads merged diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index 0dbaa987aa11..c76a101c2a6b 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -29,8 +29,8 @@ available subsections can be seen below. regulator iio/index input - usb/index firewire + usb/index pci/index spi i2c diff --git a/Documentation/fb/vesafb.rst b/Documentation/fb/vesafb.rst index a0b658091b07..6821c87b7893 100644 --- a/Documentation/fb/vesafb.rst +++ b/Documentation/fb/vesafb.rst @@ -30,7 +30,7 @@ How to use it? ============== Switching modes is done using the vga=... boot parameter. Read -Documentation/svga.rst for details. +Documentation/admin-guide/svga.rst for details. You should compile in both vgacon (for text mode) and vesafb (for graphics mode). Which of them takes over the console depends on diff --git a/Documentation/filesystems/tmpfs.txt b/Documentation/filesystems/tmpfs.txt index cad797a8a39e..5ecbc03e6b2f 100644 --- a/Documentation/filesystems/tmpfs.txt +++ b/Documentation/filesystems/tmpfs.txt @@ -98,7 +98,7 @@ A memory policy with a valid NodeList will be saved, as specified, for use at file creation time. When a task allocates a file in the file system, the mount option memory policy will be applied with a NodeList, if any, modified by the calling task's cpuset constraints -[See Documentation/cgroup-v1/cpusets.rst] and any optional flags, listed +[See Documentation/admin-guide/cgroup-v1/cpusets.rst] and any optional flags, listed below. If the resulting NodeLists is the empty set, the effective memory policy for the file will revert to "default" policy. diff --git a/Documentation/scheduler/sched-deadline.rst b/Documentation/scheduler/sched-deadline.rst index 3391e86d810c..14a2f7bf63fe 100644 --- a/Documentation/scheduler/sched-deadline.rst +++ b/Documentation/scheduler/sched-deadline.rst @@ -669,7 +669,7 @@ Deadline Task Scheduling -deadline tasks cannot have an affinity mask smaller that the entire root_domain they are created on. However, affinities can be specified - through the cpuset facility (Documentation/cgroup-v1/cpusets.rst). + through the cpuset facility (Documentation/admin-guide/cgroup-v1/cpusets.rst). 5.1 SCHED_DEADLINE and cpusets HOWTO ------------------------------------ diff --git a/Documentation/scheduler/sched-design-CFS.rst b/Documentation/scheduler/sched-design-CFS.rst index 53b30d1967cf..a96c72651877 100644 --- a/Documentation/scheduler/sched-design-CFS.rst +++ b/Documentation/scheduler/sched-design-CFS.rst @@ -222,7 +222,7 @@ SCHED_BATCH) tasks. These options need CONFIG_CGROUPS to be defined, and let the administrator create arbitrary groups of tasks, using the "cgroup" pseudo filesystem. See - Documentation/cgroup-v1/cgroups.rst for more information about this filesystem. + Documentation/admin-guide/cgroup-v1/cgroups.rst for more information about this filesystem. When CONFIG_FAIR_GROUP_SCHED is defined, a "cpu.shares" file is created for each group created using the pseudo filesystem. See example steps below to create diff --git a/Documentation/scheduler/sched-rt-group.rst b/Documentation/scheduler/sched-rt-group.rst index d27d3f3712fd..655a096ec8fb 100644 --- a/Documentation/scheduler/sched-rt-group.rst +++ b/Documentation/scheduler/sched-rt-group.rst @@ -133,7 +133,7 @@ This uses the cgroup virtual file system and "/cpu.rt_runtime_us" to control the CPU time reserved for each control group. For more information on working with control groups, you should read -Documentation/cgroup-v1/cgroups.rst as well. +Documentation/admin-guide/cgroup-v1/cgroups.rst as well. Group settings are checked against the following limits in order to keep the configuration schedulable: diff --git a/Documentation/sysctl/kernel.rst b/Documentation/sysctl/kernel.rst index 29a5bbca9bee..9324c3b1aa3e 100644 --- a/Documentation/sysctl/kernel.rst +++ b/Documentation/sysctl/kernel.rst @@ -343,7 +343,7 @@ when a hard lockup is detected. 0 - don't panic on hard lockup 1 - panic on hard lockup -See Documentation/lockup-watchdogs.rst for more information. This can +See Documentation/admin-guide/lockup-watchdogs.rst for more information. This can also be set using the nmi_watchdog kernel parameter. diff --git a/Documentation/vm/numa.rst b/Documentation/vm/numa.rst index 130f3cfa1c19..99fdeca917ca 100644 --- a/Documentation/vm/numa.rst +++ b/Documentation/vm/numa.rst @@ -67,7 +67,7 @@ nodes. Each emulated node will manage a fraction of the underlying cells' physical memory. NUMA emluation is useful for testing NUMA kernel and application features on non-NUMA platforms, and as a sort of memory resource management mechanism when used together with cpusets. -[see Documentation/cgroup-v1/cpusets.rst] +[see Documentation/admin-guide/cgroup-v1/cpusets.rst] For each node with memory, Linux constructs an independent memory management subsystem, complete with its own free page lists, in-use page lists, usage @@ -114,7 +114,7 @@ allocation behavior using Linux NUMA memory policy. [see System administrators can restrict the CPUs and nodes' memories that a non- privileged user can specify in the scheduling or NUMA commands and functions -using control groups and CPUsets. [see Documentation/cgroup-v1/cpusets.rst] +using control groups and CPUsets. [see Documentation/admin-guide/cgroup-v1/cpusets.rst] On architectures that do not hide memoryless nodes, Linux will include only zones [nodes] with memory in the zonelists. This means that for a memoryless diff --git a/Documentation/vm/page_migration.rst b/Documentation/vm/page_migration.rst index 35bba27d5fff..1d6cd7db4e43 100644 --- a/Documentation/vm/page_migration.rst +++ b/Documentation/vm/page_migration.rst @@ -41,7 +41,7 @@ locations. Larger installations usually partition the system using cpusets into sections of nodes. Paul Jackson has equipped cpusets with the ability to move pages when a task is moved to another cpuset (See -Documentation/cgroup-v1/cpusets.rst). +Documentation/admin-guide/cgroup-v1/cpusets.rst). Cpusets allows the automation of process locality. If a task is moved to a new cpuset then also all its pages are moved with it so that the performance of the process does not sink dramatically. Also the pages diff --git a/Documentation/vm/unevictable-lru.rst b/Documentation/vm/unevictable-lru.rst index 8ba656f37cd8..997dfbf13b99 100644 --- a/Documentation/vm/unevictable-lru.rst +++ b/Documentation/vm/unevictable-lru.rst @@ -98,7 +98,7 @@ Memory Control Group Interaction -------------------------------- The unevictable LRU facility interacts with the memory control group [aka -memory controller; see Documentation/cgroup-v1/memory.rst] by extending the +memory controller; see Documentation/admin-guide/cgroup-v1/memory.rst] by extending the lru_list enum. The memory controller data structure automatically gets a per-zone unevictable diff --git a/Documentation/x86/topology.rst b/Documentation/x86/topology.rst index b06d895becce..e29739904e37 100644 --- a/Documentation/x86/topology.rst +++ b/Documentation/x86/topology.rst @@ -9,7 +9,7 @@ representation in the kernel. Update/change when doing changes to the respective code. The architecture-agnostic topology definitions are in -Documentation/cputopology.rst. This file holds x86-specific +Documentation/admin-guide/cputopology.rst. This file holds x86-specific differences/specialities which must not necessarily apply to the generic definitions. Thus, the way to read up on Linux topology on x86 is to start with the generic one and look at this one in parallel for the x86 specifics. diff --git a/Documentation/x86/x86_64/fake-numa-for-cpusets.rst b/Documentation/x86/x86_64/fake-numa-for-cpusets.rst index 30108684ae87..ff9bcfd2cc14 100644 --- a/Documentation/x86/x86_64/fake-numa-for-cpusets.rst +++ b/Documentation/x86/x86_64/fake-numa-for-cpusets.rst @@ -15,7 +15,7 @@ assign them to cpusets and their attached tasks. This is a way of limiting the amount of system memory that are available to a certain class of tasks. For more information on the features of cpusets, see -Documentation/cgroup-v1/cpusets.rst. +Documentation/admin-guide/cgroup-v1/cpusets.rst. There are a number of different configurations you can use for your needs. For more information on the numa=fake command line option and its various ways of configuring fake nodes, see Documentation/x86/x86_64/boot-options.rst. @@ -40,7 +40,7 @@ A machine may be split as follows with "numa=fake=4*512," as reported by dmesg:: On node 3 totalpages: 131072 Now following the instructions for mounting the cpusets filesystem from -Documentation/cgroup-v1/cpusets.rst, you can assign fake nodes (i.e. contiguous memory +Documentation/admin-guide/cgroup-v1/cpusets.rst, you can assign fake nodes (i.e. contiguous memory address spaces) to individual cpusets:: [root@xroads /]# mkdir exampleset diff --git a/MAINTAINERS b/MAINTAINERS index d850d7f15a38..98723afdbf0b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2651,7 +2651,7 @@ ATA OVER ETHERNET (AOE) DRIVER M: "Justin Sanders" W: http://www.openaoe.org/ S: Supported -F: Documentation/aoe/ +F: Documentation/admin-guide/aoe/ F: drivers/block/aoe/ ATHEROS 71XX/9XXX GPIO DRIVER @@ -4105,7 +4105,7 @@ L: cgroups@vger.kernel.org T: git git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup.git S: Maintained F: Documentation/admin-guide/cgroup-v2.rst -F: Documentation/cgroup-v1/ +F: Documentation/admin-guide/cgroup-v1/ F: include/linux/cgroup* F: kernel/cgroup/ @@ -4116,7 +4116,7 @@ W: http://www.bullopensource.org/cpuset/ W: http://oss.sgi.com/projects/cpusets/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup.git S: Maintained -F: Documentation/cgroup-v1/cpusets.rst +F: Documentation/admin-guide/cgroup-v1/cpusets.rst F: include/linux/cpuset.h F: kernel/cgroup/cpuset.c @@ -6038,7 +6038,7 @@ M: Ard Biesheuvel L: linux-efi@vger.kernel.org T: git git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi.git S: Maintained -F: Documentation/efi-stub.rst +F: Documentation/admin-guide/efi-stub.rst F: arch/*/kernel/efi.c F: arch/x86/boot/compressed/eboot.[ch] F: arch/*/include/asm/efi.h @@ -7006,7 +7006,7 @@ M: Herbert Xu L: linux-crypto@vger.kernel.org S: Odd fixes F: Documentation/devicetree/bindings/rng/ -F: Documentation/hw_random.rst +F: Documentation/admin-guide/hw_random.rst F: drivers/char/hw_random/ F: include/linux/hw_random.h @@ -9296,7 +9296,7 @@ M: "Richard Russon (FlatCap)" L: linux-ntfs-dev@lists.sourceforge.net W: http://www.linux-ntfs.org/content/view/19/37/ S: Maintained -F: Documentation/ldm.rst +F: Documentation/admin-guide/ldm.rst F: block/partitions/ldm.* LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI) @@ -11935,7 +11935,7 @@ PARALLEL LCD/KEYPAD PANEL DRIVER M: Willy Tarreau M: Ksenija Stanojevic S: Odd Fixes -F: Documentation/auxdisplay/lcd-panel-cgram.rst +F: Documentation/admin-guide/lcd-panel-cgram.rst F: drivers/auxdisplay/panel.c PARALLEL PORT SUBSYSTEM @@ -13354,7 +13354,7 @@ Q: http://patchwork.ozlabs.org/project/rtc-linux/list/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux.git S: Maintained F: Documentation/devicetree/bindings/rtc/ -F: Documentation/rtc.rst +F: Documentation/admin-guide/rtc.rst F: drivers/rtc/ F: include/linux/rtc.h F: include/uapi/linux/rtc.h @@ -15174,7 +15174,7 @@ SVGA HANDLING M: Martin Mares L: linux-video@atrey.karlin.mff.cuni.cz S: Maintained -F: Documentation/svga.rst +F: Documentation/admin-guide/svga.rst F: arch/x86/boot/video* SWIOTLB SUBSYSTEM diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig index 2d0a14a4286c..ff0e247573d8 100644 --- a/arch/arm/Kconfig +++ b/arch/arm/Kconfig @@ -1266,7 +1266,7 @@ config SMP will run faster if you say N here. See also , - and the SMP-HOWTO available at + and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/parisc/Kconfig b/arch/parisc/Kconfig index 188fdf4f5080..071640ecafea 100644 --- a/arch/parisc/Kconfig +++ b/arch/parisc/Kconfig @@ -275,7 +275,7 @@ config SMP machines, but will use only one CPU of a multiprocessor machine. On a uniprocessor machine, the kernel will run faster if you say N. - See also and the SMP-HOWTO + See also and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/sh/Kconfig b/arch/sh/Kconfig index 669adef94507..7440639510a0 100644 --- a/arch/sh/Kconfig +++ b/arch/sh/Kconfig @@ -677,7 +677,7 @@ config SMP People using multiprocessor machines who say Y here should also say Y to "Enhanced Real Time Clock Support", below. - See also and the SMP-HOWTO + See also and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/sparc/Kconfig b/arch/sparc/Kconfig index 04a3b2246a2a..6a31f240840d 100644 --- a/arch/sparc/Kconfig +++ b/arch/sparc/Kconfig @@ -179,7 +179,7 @@ config SMP Y to "Enhanced Real Time Clock Support", below. The "Advanced Power Management" code will be disabled if you say Y here. - See also and the SMP-HOWTO + See also and the SMP-HOWTO available at . If you don't know what to do here, say N. diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig index 0d5f0710347c..586dd3529d14 100644 --- a/arch/x86/Kconfig +++ b/arch/x86/Kconfig @@ -397,7 +397,7 @@ config SMP Management" code will be disabled if you say Y here. See also , - and the SMP-HOWTO available at + and the SMP-HOWTO available at . If you don't know what to do here, say N. @@ -1954,7 +1954,7 @@ config EFI_STUB This kernel feature allows a bzImage to be loaded directly by EFI firmware without the use of a bootloader. - See Documentation/efi-stub.rst for more information. + See Documentation/admin-guide/efi-stub.rst for more information. config EFI_MIXED bool "EFI mixed-mode support" diff --git a/block/Kconfig b/block/Kconfig index b16b3e075d31..8b5f8e560eb4 100644 --- a/block/Kconfig +++ b/block/Kconfig @@ -89,7 +89,7 @@ config BLK_DEV_THROTTLING one needs to mount and use blkio cgroup controller for creating cgroups and specifying per device IO rate policies. - See Documentation/cgroup-v1/blkio-controller.rst for more information. + See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information. config BLK_DEV_THROTTLING_LOW bool "Block throttling .low limit interface support (EXPERIMENTAL)" diff --git a/block/partitions/Kconfig b/block/partitions/Kconfig index 51b28e1e225d..702689a628f0 100644 --- a/block/partitions/Kconfig +++ b/block/partitions/Kconfig @@ -194,7 +194,7 @@ config LDM_PARTITION Normal partitions are now called Basic Disks under Windows 2000, XP, and Vista. - For a fuller description read . + For a fuller description read . If unsure, say N. diff --git a/drivers/char/Kconfig b/drivers/char/Kconfig index ba90034f5b8f..3a0f94929814 100644 --- a/drivers/char/Kconfig +++ b/drivers/char/Kconfig @@ -291,7 +291,7 @@ config RTC and set the RTC in an SMP compatible fashion. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read + sampling), then say Y here, and read for details. To compile this driver as a module, choose M here: the @@ -313,7 +313,7 @@ config JS_RTC /dev/rtc. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read + sampling), then say Y here, and read for details. To compile this driver as a module, choose M here: the diff --git a/drivers/char/hw_random/core.c b/drivers/char/hw_random/core.c index 41acde92bedc..9044d31ab1a1 100644 --- a/drivers/char/hw_random/core.c +++ b/drivers/char/hw_random/core.c @@ -4,7 +4,7 @@ * Copyright 2006 Michael Buesch * Copyright 2005 (c) MontaVista Software, Inc. * - * Please read Documentation/hw_random.rst for details on use. + * Please read Documentation/admin-guide/hw_random.rst for details on use. * * This software may be used and distributed according to the terms * of the GNU General Public License, incorporated herein by reference. diff --git a/include/linux/cgroup-defs.h b/include/linux/cgroup-defs.h index c5311935239d..430e219e3aba 100644 --- a/include/linux/cgroup-defs.h +++ b/include/linux/cgroup-defs.h @@ -624,7 +624,7 @@ struct cftype { /* * Control Group subsystem type. - * See Documentation/cgroup-v1/cgroups.rst for details + * See Documentation/admin-guide/cgroup-v1/cgroups.rst for details */ struct cgroup_subsys { struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css); diff --git a/include/linux/hw_random.h b/include/linux/hw_random.h index e533eac9942b..8e6dd908da21 100644 --- a/include/linux/hw_random.h +++ b/include/linux/hw_random.h @@ -1,7 +1,7 @@ /* Hardware Random Number Generator - Please read Documentation/hw_random.rst for details on use. + Please read Documentation/admin-guide/hw_random.rst for details on use. ---------------------------------------------------------- This software may be used and distributed according to the terms diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h index 19d9ee7e0518..c2fa3dc1d167 100644 --- a/include/uapi/linux/bpf.h +++ b/include/uapi/linux/bpf.h @@ -803,7 +803,7 @@ union bpf_attr { * based on a user-provided identifier for all traffic coming from * the tasks belonging to the related cgroup. See also the related * kernel documentation, available from the Linux sources in file - * *Documentation/cgroup-v1/net_cls.rst*. + * *Documentation/admin-guide/cgroup-v1/net_cls.rst*. * * The Linux kernel has two versions for cgroups: there are * cgroups v1 and cgroups v2. Both are available to users, who can diff --git a/init/Kconfig b/init/Kconfig index 501126df6336..e02cfae73ce5 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -735,7 +735,7 @@ menuconfig CGROUPS controls or device isolation. See - Documentation/scheduler/sched-design-CFS.rst (CFS) - - Documentation/cgroup-v1/ (features for grouping, isolation + - Documentation/admin-guide/cgroup-v1/ (features for grouping, isolation and resource control) Say N if unsure. @@ -797,7 +797,7 @@ config BLK_CGROUP CONFIG_CFQ_GROUP_IOSCHED=y; for enabling throttling policy, set CONFIG_BLK_DEV_THROTTLING=y. - See Documentation/cgroup-v1/blkio-controller.rst for more information. + See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information. config DEBUG_BLK_CGROUP bool "IO controller debugging" diff --git a/kernel/cgroup/cpuset.c b/kernel/cgroup/cpuset.c index b3b02b9c4405..863e434a6020 100644 --- a/kernel/cgroup/cpuset.c +++ b/kernel/cgroup/cpuset.c @@ -729,7 +729,7 @@ static inline int nr_cpusets(void) * load balancing domains (sched domains) as specified by that partial * partition. * - * See "What is sched_load_balance" in Documentation/cgroup-v1/cpusets.rst + * See "What is sched_load_balance" in Documentation/admin-guide/cgroup-v1/cpusets.rst * for a background explanation of this. * * Does not return errors, on the theory that the callers of this diff --git a/security/device_cgroup.c b/security/device_cgroup.c index c07196502577..725674f3276d 100644 --- a/security/device_cgroup.c +++ b/security/device_cgroup.c @@ -509,7 +509,7 @@ static inline int may_allow_all(struct dev_cgroup *parent) * This is one of the three key functions for hierarchy implementation. * This function is responsible for re-evaluating all the cgroup's active * exceptions due to a parent's exception change. - * Refer to Documentation/cgroup-v1/devices.rst for more details. + * Refer to Documentation/admin-guide/cgroup-v1/devices.rst for more details. */ static void revalidate_active_exceptions(struct dev_cgroup *devcg) { diff --git a/tools/include/uapi/linux/bpf.h b/tools/include/uapi/linux/bpf.h index 19d9ee7e0518..c2fa3dc1d167 100644 --- a/tools/include/uapi/linux/bpf.h +++ b/tools/include/uapi/linux/bpf.h @@ -803,7 +803,7 @@ union bpf_attr { * based on a user-provided identifier for all traffic coming from * the tasks belonging to the related cgroup. See also the related * kernel documentation, available from the Linux sources in file - * *Documentation/cgroup-v1/net_cls.rst*. + * *Documentation/admin-guide/cgroup-v1/net_cls.rst*. * * The Linux kernel has two versions for cgroups: there are * cgroups v1 and cgroups v2. Both are available to users, who can From patchwork Tue Jun 18 21:05:36 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 11002751 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 143C3924 for ; Tue, 18 Jun 2019 21:06:24 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id EF15122F3E for ; Tue, 18 Jun 2019 21:06:23 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id DC3A128A7E; Tue, 18 Jun 2019 21:06:23 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id C268422F3E for ; Tue, 18 Jun 2019 21:06:12 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 697C66E250; Tue, 18 Jun 2019 21:06:11 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) by gabe.freedesktop.org (Postfix) with ESMTPS id 143166E250 for ; Tue, 18 Jun 2019 21:06:10 +0000 (UTC) Received: from 177.133.86.196.dynamic.adsl.gvt.net.br ([177.133.86.196] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hdLIc-0006yu-Ff; Tue, 18 Jun 2019 21:05:52 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hdLIZ-0002CX-VH; Tue, 18 Jun 2019 18:05:47 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH v1 12/22] docs: driver-api: add .rst files from the main dir Date: Tue, 18 Jun 2019 18:05:36 -0300 Message-Id: X-Mailer: git-send-email 2.21.0 In-Reply-To: References: MIME-Version: 1.0 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc: To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=FISmA4+yooQYp3UXQ1RSWHaYngXi1oOul8B4uyUy5LE=; b=PSJTf+ybuqVO2Rt29OuvJXzN+S 0KaaHzpgf1WzI7BpGiGlhRg435AgTjDzbKuSCvKpz8H61ttb+lIpYvJZmvnGGQva7XThVn0ASLdFO 9Sv0WxVy86ltUJNKalEO05AmMVzziCwwlqvDvuIilZ0XFgMWHZohbPsDuq6DbpuMUZ5hVKe8UKJdB cdSxcGn+p3zCCT7zRTbtaWEx86QtRiVcFMv7k2KHn+aAhpmUsSQskpjRtBcp/E0lykGIQFuoLZ2Y3 Q3ZxPkahCCqsKocpkHHgvWrMnCriIMxK4DkNKT1Ssce+IYyScqgPdAaTh9WUWR2GG+xKPFBHd4Wpn N2UAMvvg==; X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-fbdev@vger.kernel.org, kvm@vger.kernel.org, kernel-hardening@lists.openwall.com, linux-pci@vger.kernel.org, linux-remoteproc@vger.kernel.org, dri-devel@lists.freedesktop.org, platform-driver-x86@vger.kernel.org, linux-mm@kvack.org, Mauro Carvalho Chehab , linux-arch@vger.kernel.org, linux-s390@vger.kernel.org, Jonathan Corbet , linux-pwm@vger.kernel.org, linux-watchdog@vger.kernel.org, Mauro Carvalho Chehab , linaro-mm-sig@lists.linaro.org, linux-gpio@vger.kernel.org, openipmi-developer@lists.sourceforge.net, linux-arm-kernel@lists.infradead.org, netdev@vger.kernel.org, linux-wireless@vger.kernel.org, linux-kernel@vger.kernel.org, linux-crypto@vger.kernel.org Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP Those files belong to the driver-api guide. Add them to the driver-api book. Signed-off-by: Mauro Carvalho Chehab --- I had to remove the long list of maintainers got by getpatch.pl, as it was too long. I opted to keep only the mailing lists. Documentation/ABI/removed/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-class-rfkill | 2 +- .../ABI/testing/sysfs-class-switchtec | 2 +- Documentation/PCI/pci.rst | 2 +- Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- .../admin-guide/kernel-parameters.txt | 4 +- .../admin-guide/kernel-per-cpu-kthreads.rst | 2 +- .../{ => driver-api}/atomic_bitops.rst | 2 - Documentation/{ => driver-api}/bt8xxgpio.rst | 2 - .../bus-virt-phys-mapping.rst | 2 - .../{connector => driver-api}/connector.rst | 2 - .../{console => driver-api}/console.rst | 2 - Documentation/{ => driver-api}/crc32.rst | 2 - Documentation/{ => driver-api}/dcdbas.rst | 2 - .../{ => driver-api}/debugging-modules.rst | 2 - .../debugging-via-ohci1394.rst | 2 - Documentation/{ => driver-api}/dell_rbu.rst | 2 - Documentation/{ => driver-api}/digsig.rst | 2 - .../{EDID/howto.rst => driver-api/edid.rst} | 2 - Documentation/{ => driver-api}/eisa.rst | 2 - .../{ => driver-api}/futex-requeue-pi.rst | 2 - .../{ => driver-api}/gcc-plugins.rst | 2 - Documentation/{ => driver-api}/hwspinlock.rst | 2 - Documentation/driver-api/index.rst | 66 +++++++++++++++++++ Documentation/{ => driver-api}/io-mapping.rst | 2 - .../{ => driver-api}/io_ordering.rst | 2 - .../{IPMI.rst => driver-api/ipmi.rst} | 2 - .../irq-affinity.rst} | 2 - .../irq-domain.rst} | 2 - Documentation/{IRQ.rst => driver-api/irq.rst} | 2 - .../{ => driver-api}/irqflags-tracing.rst | 2 - Documentation/{ => driver-api}/isa.rst | 2 - Documentation/{ => driver-api}/isapnp.rst | 2 - Documentation/{ => driver-api}/kobject.rst | 4 +- Documentation/{ => driver-api}/kprobes.rst | 2 - Documentation/{ => driver-api}/kref.rst | 2 - .../pblk.txt => driver-api/lightnvm-pblk.rst} | 0 Documentation/{ => driver-api}/lzo.rst | 2 - Documentation/{ => driver-api}/mailbox.rst | 2 - .../{ => driver-api}/men-chameleon-bus.rst | 2 - Documentation/{ => driver-api}/nommu-mmap.rst | 2 - Documentation/{ => driver-api}/ntb.rst | 2 - Documentation/{nvmem => driver-api}/nvmem.rst | 2 - Documentation/{ => driver-api}/padata.rst | 2 - .../{ => driver-api}/parport-lowlevel.rst | 2 - .../{ => driver-api}/percpu-rw-semaphore.rst | 2 - Documentation/{ => driver-api}/pi-futex.rst | 2 - Documentation/driver-api/pps.rst | 2 - .../{ => driver-api}/preempt-locking.rst | 2 - .../{pti => driver-api}/pti_intel_mid.rst | 2 - Documentation/driver-api/ptp.rst | 2 - Documentation/{ => driver-api}/pwm.rst | 2 - Documentation/{ => driver-api}/rbtree.rst | 2 - Documentation/{ => driver-api}/remoteproc.rst | 4 +- Documentation/{ => driver-api}/rfkill.rst | 2 - .../{ => driver-api}/robust-futex-ABI.rst | 2 - .../{ => driver-api}/robust-futexes.rst | 2 - Documentation/{ => driver-api}/rpmsg.rst | 2 - Documentation/{ => driver-api}/sgi-ioc4.rst | 2 - .../{SM501.rst => driver-api/sm501.rst} | 2 - .../{ => driver-api}/smsc_ece1099.rst | 2 - .../{ => driver-api}/speculation.rst | 8 +-- .../{ => driver-api}/static-keys.rst | 2 - Documentation/{ => driver-api}/switchtec.rst | 4 +- Documentation/{ => driver-api}/sync_file.rst | 2 - Documentation/{ => driver-api}/tee.rst | 2 - .../{ => driver-api}/this_cpu_ops.rst | 2 - .../unaligned-memory-access.rst | 2 - .../{ => driver-api}/vfio-mediated-device.rst | 4 +- Documentation/{ => driver-api}/vfio.rst | 2 - Documentation/{ => driver-api}/xillybus.rst | 2 - Documentation/{ => driver-api}/xz.rst | 2 - Documentation/{ => driver-api}/zorro.rst | 2 - Documentation/driver-model/device.rst | 2 +- Documentation/fb/fbcon.rst | 4 +- Documentation/filesystems/sysfs.txt | 2 +- Documentation/gpu/drm-mm.rst | 2 +- Documentation/ia64/irq-redir.rst | 2 +- Documentation/laptops/thinkpad-acpi.rst | 6 +- Documentation/locking/rt-mutex.rst | 2 +- Documentation/networking/scaling.rst | 4 +- Documentation/s390/vfio-ccw.rst | 6 +- Documentation/sysctl/kernel.rst | 2 +- Documentation/sysctl/vm.rst | 2 +- Documentation/trace/kprobetrace.rst | 2 +- Documentation/translations/zh_CN/IRQ.txt | 4 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/io_ordering.txt | 4 +- Documentation/w1/w1.netlink | 2 +- Documentation/watchdog/hpwdt.rst | 2 +- MAINTAINERS | 46 ++++++------- arch/Kconfig | 4 +- arch/unicore32/include/asm/io.h | 2 +- drivers/base/core.c | 2 +- drivers/char/ipmi/Kconfig | 2 +- drivers/char/ipmi/ipmi_si_hotmod.c | 2 +- drivers/char/ipmi/ipmi_si_intf.c | 2 +- drivers/dma-buf/Kconfig | 2 +- drivers/gpio/Kconfig | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/pci/switch/Kconfig | 2 +- drivers/platform/x86/Kconfig | 4 +- drivers/platform/x86/dcdbas.c | 2 +- drivers/platform/x86/dell_rbu.c | 2 +- drivers/pnp/isapnp/Kconfig | 2 +- drivers/tty/Kconfig | 2 +- drivers/vfio/Kconfig | 2 +- drivers/vfio/mdev/Kconfig | 2 +- drivers/w1/Kconfig | 2 +- include/asm-generic/bitops/atomic.h | 2 +- include/linux/io-mapping.h | 2 +- include/linux/jump_label.h | 2 +- include/linux/kobject.h | 2 +- include/linux/kobject_ns.h | 2 +- include/linux/rbtree.h | 2 +- include/linux/rbtree_augmented.h | 2 +- init/Kconfig | 2 +- kernel/padata.c | 2 +- lib/Kconfig | 2 +- lib/Kconfig.debug | 2 +- lib/crc32.c | 2 +- lib/kobject.c | 4 +- lib/lzo/lzo1x_decompress_safe.c | 2 +- lib/xz/Kconfig | 2 +- mm/Kconfig | 2 +- mm/nommu.c | 2 +- samples/Kconfig | 2 +- samples/kprobes/kprobe_example.c | 2 +- samples/kprobes/kretprobe_example.c | 2 +- scripts/gcc-plugins/Kconfig | 2 +- tools/include/linux/rbtree.h | 2 +- tools/include/linux/rbtree_augmented.h | 2 +- 132 files changed, 173 insertions(+), 235 deletions(-) rename Documentation/{ => driver-api}/atomic_bitops.rst (99%) rename Documentation/{ => driver-api}/bt8xxgpio.rst (99%) rename Documentation/{ => driver-api}/bus-virt-phys-mapping.rst (99%) rename Documentation/{connector => driver-api}/connector.rst (99%) rename Documentation/{console => driver-api}/console.rst (99%) rename Documentation/{ => driver-api}/crc32.rst (99%) rename Documentation/{ => driver-api}/dcdbas.rst (99%) rename Documentation/{ => driver-api}/debugging-modules.rst (98%) rename Documentation/{ => driver-api}/debugging-via-ohci1394.rst (99%) rename Documentation/{ => driver-api}/dell_rbu.rst (99%) rename Documentation/{ => driver-api}/digsig.rst (99%) rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (99%) rename Documentation/{ => driver-api}/eisa.rst (99%) rename Documentation/{ => driver-api}/futex-requeue-pi.rst (99%) rename Documentation/{ => driver-api}/gcc-plugins.rst (99%) rename Documentation/{ => driver-api}/hwspinlock.rst (99%) rename Documentation/{ => driver-api}/io-mapping.rst (99%) rename Documentation/{ => driver-api}/io_ordering.rst (99%) rename Documentation/{IPMI.rst => driver-api/ipmi.rst} (99%) rename Documentation/{IRQ-affinity.rst => driver-api/irq-affinity.rst} (99%) rename Documentation/{IRQ-domain.rst => driver-api/irq-domain.rst} (99%) rename Documentation/{IRQ.rst => driver-api/irq.rst} (99%) rename Documentation/{ => driver-api}/irqflags-tracing.rst (99%) rename Documentation/{ => driver-api}/isa.rst (99%) rename Documentation/{ => driver-api}/isapnp.rst (98%) rename Documentation/{ => driver-api}/kobject.rst (99%) rename Documentation/{ => driver-api}/kprobes.rst (99%) rename Documentation/{ => driver-api}/kref.rst (99%) rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%) rename Documentation/{ => driver-api}/lzo.rst (99%) rename Documentation/{ => driver-api}/mailbox.rst (99%) rename Documentation/{ => driver-api}/men-chameleon-bus.rst (99%) rename Documentation/{ => driver-api}/nommu-mmap.rst (99%) rename Documentation/{ => driver-api}/ntb.rst (99%) rename Documentation/{nvmem => driver-api}/nvmem.rst (99%) rename Documentation/{ => driver-api}/padata.rst (99%) rename Documentation/{ => driver-api}/parport-lowlevel.rst (99%) rename Documentation/{ => driver-api}/percpu-rw-semaphore.rst (99%) rename Documentation/{ => driver-api}/pi-futex.rst (99%) rename Documentation/{ => driver-api}/preempt-locking.rst (99%) rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%) rename Documentation/{ => driver-api}/pwm.rst (99%) rename Documentation/{ => driver-api}/rbtree.rst (99%) rename Documentation/{ => driver-api}/remoteproc.rst (99%) rename Documentation/{ => driver-api}/rfkill.rst (99%) rename Documentation/{ => driver-api}/robust-futex-ABI.rst (99%) rename Documentation/{ => driver-api}/robust-futexes.rst (99%) rename Documentation/{ => driver-api}/rpmsg.rst (99%) rename Documentation/{ => driver-api}/sgi-ioc4.rst (99%) rename Documentation/{SM501.rst => driver-api/sm501.rst} (99%) rename Documentation/{ => driver-api}/smsc_ece1099.rst (99%) rename Documentation/{ => driver-api}/speculation.rst (99%) rename Documentation/{ => driver-api}/static-keys.rst (99%) rename Documentation/{ => driver-api}/switchtec.rst (97%) rename Documentation/{ => driver-api}/sync_file.rst (99%) rename Documentation/{ => driver-api}/tee.rst (99%) rename Documentation/{ => driver-api}/this_cpu_ops.rst (99%) rename Documentation/{ => driver-api}/unaligned-memory-access.rst (99%) rename Documentation/{ => driver-api}/vfio-mediated-device.rst (99%) rename Documentation/{ => driver-api}/vfio.rst (99%) rename Documentation/{ => driver-api}/xillybus.rst (99%) rename Documentation/{ => driver-api}/xz.rst (99%) rename Documentation/{ => driver-api}/zorro.rst (99%) diff --git a/Documentation/ABI/removed/sysfs-class-rfkill b/Documentation/ABI/removed/sysfs-class-rfkill index 1652b2381dda..9c08c7f98ffb 100644 --- a/Documentation/ABI/removed/sysfs-class-rfkill +++ b/Documentation/ABI/removed/sysfs-class-rfkill @@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.rst. +For details to this subsystem look at Documentation/driver-api/rfkill.rst. What: /sys/class/rfkill/rfkill[0-9]+/claim Date: 09-Jul-2007 diff --git a/Documentation/ABI/stable/sysfs-class-rfkill b/Documentation/ABI/stable/sysfs-class-rfkill index 68fd0afdad0d..5b154f922643 100644 --- a/Documentation/ABI/stable/sysfs-class-rfkill +++ b/Documentation/ABI/stable/sysfs-class-rfkill @@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.rst. +For details to this subsystem look at Documentation/driver-api/rfkill.rst. For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in Documentation/ABI/removed/sysfs-class-rfkill. diff --git a/Documentation/ABI/testing/sysfs-class-switchtec b/Documentation/ABI/testing/sysfs-class-switchtec index c8d80db1e32c..76c7a661a595 100644 --- a/Documentation/ABI/testing/sysfs-class-switchtec +++ b/Documentation/ABI/testing/sysfs-class-switchtec @@ -1,6 +1,6 @@ switchtec - Microsemi Switchtec PCI Switch Management Endpoint -For details on this subsystem look at Documentation/switchtec.rst. +For details on this subsystem look at Documentation/driver-api/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017 diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst index 840cbf5f37a7..0f52d172c9ac 100644 --- a/Documentation/PCI/pci.rst +++ b/Documentation/PCI/pci.rst @@ -239,7 +239,7 @@ from the PCI device config space. Use the values in the pci_dev structure as the PCI "bus address" might have been remapped to a "host physical" address by the arch/chip-set specific kernel support. -See Documentation/io-mapping.rst for how to access device registers +See Documentation/driver-api/io-mapping.rst for how to access device registers or device memory. The device driver needs to call pci_request_region() to verify diff --git a/Documentation/admin-guide/hw-vuln/l1tf.rst b/Documentation/admin-guide/hw-vuln/l1tf.rst index 9b1e6aafea1f..29449ba7773c 100644 --- a/Documentation/admin-guide/hw-vuln/l1tf.rst +++ b/Documentation/admin-guide/hw-vuln/l1tf.rst @@ -268,7 +268,7 @@ Guest mitigation mechanisms /proc/irq/$NR/smp_affinity[_list] files. Limited documentation is available at: - https://www.kernel.org/doc/Documentation/IRQ-affinity.rst + https://www.kernel.org/doc/Documentation/driver-api/irq-affinity.rst .. _smt_control: diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index 95885726778c..2f8751323f6d 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -930,7 +930,7 @@ edid/1680x1050.bin, or edid/1920x1080.bin is given and no file with the same name exists. Details and instructions how to build your own EDID data are - available in Documentation/EDID/howto.rst. An EDID + available in Documentation/driver-api/edid.rst. An EDID data set will only be used for a particular connector, if its name and a colon are prepended to the EDID name. Each connector may use a unique EDID data @@ -3162,7 +3162,7 @@ See Documentation/sysctl/vm.rst for details. ohci1394_dma=early [HW] enable debugging via the ohci1394 driver. - See Documentation/debugging-via-ohci1394.rst for more + See Documentation/driver-api/debugging-via-ohci1394.rst for more info. olpc_ec_timeout= [OLPC] ms delay when issuing EC commands diff --git a/Documentation/admin-guide/kernel-per-cpu-kthreads.rst b/Documentation/admin-guide/kernel-per-cpu-kthreads.rst index d430048a0307..942b7835b9f6 100644 --- a/Documentation/admin-guide/kernel-per-cpu-kthreads.rst +++ b/Documentation/admin-guide/kernel-per-cpu-kthreads.rst @@ -10,7 +10,7 @@ them to a "housekeeping" CPU dedicated to such work. References ========== -- Documentation/IRQ-affinity.rst: Binding interrupts to sets of CPUs. +- Documentation/driver-api/irq-affinity.rst: Binding interrupts to sets of CPUs. - Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. diff --git a/Documentation/atomic_bitops.rst b/Documentation/driver-api/atomic_bitops.rst similarity index 99% rename from Documentation/atomic_bitops.rst rename to Documentation/driver-api/atomic_bitops.rst index b683bcb71185..7c7d33ee64f7 100644 --- a/Documentation/atomic_bitops.rst +++ b/Documentation/driver-api/atomic_bitops.rst @@ -1,5 +1,3 @@ -:orphan: - ============= Atomic bitops ============= diff --git a/Documentation/bt8xxgpio.rst b/Documentation/driver-api/bt8xxgpio.rst similarity index 99% rename from Documentation/bt8xxgpio.rst rename to Documentation/driver-api/bt8xxgpio.rst index 093875e1b0aa..4f937bead52c 100644 --- a/Documentation/bt8xxgpio.rst +++ b/Documentation/driver-api/bt8xxgpio.rst @@ -1,5 +1,3 @@ -:orphan: - =================================================================== A driver for a selfmade cheap BT8xx based PCI GPIO-card (bt8xxgpio) =================================================================== diff --git a/Documentation/bus-virt-phys-mapping.rst b/Documentation/driver-api/bus-virt-phys-mapping.rst similarity index 99% rename from Documentation/bus-virt-phys-mapping.rst rename to Documentation/driver-api/bus-virt-phys-mapping.rst index eefb0ae99ba8..80972916e88c 100644 --- a/Documentation/bus-virt-phys-mapping.rst +++ b/Documentation/driver-api/bus-virt-phys-mapping.rst @@ -1,5 +1,3 @@ -:orphan: - ========================================================== How to access I/O mapped memory from within device drivers ========================================================== diff --git a/Documentation/connector/connector.rst b/Documentation/driver-api/connector.rst similarity index 99% rename from Documentation/connector/connector.rst rename to Documentation/driver-api/connector.rst index 24e26dc22dbf..2cf9b5adfe2a 100644 --- a/Documentation/connector/connector.rst +++ b/Documentation/driver-api/connector.rst @@ -1,5 +1,3 @@ -:orphan: - ================ Kernel Connector ================ diff --git a/Documentation/console/console.rst b/Documentation/driver-api/console.rst similarity index 99% rename from Documentation/console/console.rst rename to Documentation/driver-api/console.rst index b374141b027e..8b0205d27a71 100644 --- a/Documentation/console/console.rst +++ b/Documentation/driver-api/console.rst @@ -1,5 +1,3 @@ -:orphan: - =============== Console Drivers =============== diff --git a/Documentation/crc32.rst b/Documentation/driver-api/crc32.rst similarity index 99% rename from Documentation/crc32.rst rename to Documentation/driver-api/crc32.rst index f7c73d713a35..8a6860f33b4e 100644 --- a/Documentation/crc32.rst +++ b/Documentation/driver-api/crc32.rst @@ -1,5 +1,3 @@ -:orphan: - ================================= brief tutorial on CRC computation ================================= diff --git a/Documentation/dcdbas.rst b/Documentation/driver-api/dcdbas.rst similarity index 99% rename from Documentation/dcdbas.rst rename to Documentation/driver-api/dcdbas.rst index abbc2bfd58a7..309cc57a7c1c 100644 --- a/Documentation/dcdbas.rst +++ b/Documentation/driver-api/dcdbas.rst @@ -1,5 +1,3 @@ -:orphan: - =================================== Dell Systems Management Base Driver =================================== diff --git a/Documentation/debugging-modules.rst b/Documentation/driver-api/debugging-modules.rst similarity index 98% rename from Documentation/debugging-modules.rst rename to Documentation/driver-api/debugging-modules.rst index 994f4b021a81..172ad4aec493 100644 --- a/Documentation/debugging-modules.rst +++ b/Documentation/driver-api/debugging-modules.rst @@ -1,5 +1,3 @@ -:orphan: - Debugging Modules after 2.6.3 ----------------------------- diff --git a/Documentation/debugging-via-ohci1394.rst b/Documentation/driver-api/debugging-via-ohci1394.rst similarity index 99% rename from Documentation/debugging-via-ohci1394.rst rename to Documentation/driver-api/debugging-via-ohci1394.rst index ead0196d94b7..981ad4f89fd3 100644 --- a/Documentation/debugging-via-ohci1394.rst +++ b/Documentation/driver-api/debugging-via-ohci1394.rst @@ -1,5 +1,3 @@ -:orphan: - =========================================================================== Using physical DMA provided by OHCI-1394 FireWire controllers for debugging =========================================================================== diff --git a/Documentation/dell_rbu.rst b/Documentation/driver-api/dell_rbu.rst similarity index 99% rename from Documentation/dell_rbu.rst rename to Documentation/driver-api/dell_rbu.rst index 45cd18abd98f..f3bfa1a17961 100644 --- a/Documentation/dell_rbu.rst +++ b/Documentation/driver-api/dell_rbu.rst @@ -1,5 +1,3 @@ -:orphan: - ============================================================= Usage of the new open sourced rbu (Remote BIOS Update) driver ============================================================= diff --git a/Documentation/digsig.rst b/Documentation/driver-api/digsig.rst similarity index 99% rename from Documentation/digsig.rst rename to Documentation/driver-api/digsig.rst index 3597711d0df1..f6a8902d3ef7 100644 --- a/Documentation/digsig.rst +++ b/Documentation/driver-api/digsig.rst @@ -1,5 +1,3 @@ -:orphan: - ================================== Digital Signature Verification API ================================== diff --git a/Documentation/EDID/howto.rst b/Documentation/driver-api/edid.rst similarity index 99% rename from Documentation/EDID/howto.rst rename to Documentation/driver-api/edid.rst index 725fd49a88ca..9a9b512e0ac9 100644 --- a/Documentation/EDID/howto.rst +++ b/Documentation/driver-api/edid.rst @@ -1,5 +1,3 @@ -:orphan: - ==== EDID ==== diff --git a/Documentation/eisa.rst b/Documentation/driver-api/eisa.rst similarity index 99% rename from Documentation/eisa.rst rename to Documentation/driver-api/eisa.rst index d98949908405..f388545a85a7 100644 --- a/Documentation/eisa.rst +++ b/Documentation/driver-api/eisa.rst @@ -1,5 +1,3 @@ -:orphan: - ================ EISA bus support ================ diff --git a/Documentation/futex-requeue-pi.rst b/Documentation/driver-api/futex-requeue-pi.rst similarity index 99% rename from Documentation/futex-requeue-pi.rst rename to Documentation/driver-api/futex-requeue-pi.rst index a90dbff26629..14ab5787b9a7 100644 --- a/Documentation/futex-requeue-pi.rst +++ b/Documentation/driver-api/futex-requeue-pi.rst @@ -1,5 +1,3 @@ -:orphan: - ================ Futex Requeue PI ================ diff --git a/Documentation/gcc-plugins.rst b/Documentation/driver-api/gcc-plugins.rst similarity index 99% rename from Documentation/gcc-plugins.rst rename to Documentation/driver-api/gcc-plugins.rst index e08d013c6de2..8502f24396fb 100644 --- a/Documentation/gcc-plugins.rst +++ b/Documentation/driver-api/gcc-plugins.rst @@ -1,5 +1,3 @@ -:orphan: - ========================= GCC plugin infrastructure ========================= diff --git a/Documentation/hwspinlock.rst b/Documentation/driver-api/hwspinlock.rst similarity index 99% rename from Documentation/hwspinlock.rst rename to Documentation/driver-api/hwspinlock.rst index 68297473647c..ed640a278185 100644 --- a/Documentation/hwspinlock.rst +++ b/Documentation/driver-api/hwspinlock.rst @@ -1,5 +1,3 @@ -:orphan: - =========================== Hardware Spinlock Framework =========================== diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index c76a101c2a6b..bb2621b17212 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -60,6 +60,72 @@ available subsections can be seen below. acpi/index generic-counter + atomic_bitops + bt8xxgpio + bus-virt-phys-mapping + connector + console + crc32 + dcdbas + debugging-modules + debugging-via-ohci1394 + dell_rbu + digsig + edid + eisa + futex-requeue-pi + gcc-plugins + hwspinlock + io-mapping + io_ordering + ipmi + irq + irq-affinity + irq-domain + irqflags-tracing + isa + isapnp + kobject + kprobes + kref + lightnvm-pblk + lzo + mailbox + men-chameleon-bus + nommu-mmap + ntb + nvmem + padata + parport-lowlevel + percpu-rw-semaphore + pi-futex + pps + preempt-locking + pti_intel_mid + ptp + pwm + rbtree + remoteproc + rfkill + robust-futex-ABI + robust-futexes + rpmsg + sgi-ioc4 + sm501 + smsc_ece1099 + speculation + static-keys + switchtec + sync_file + tee + this_cpu_ops + unaligned-memory-access + vfio + vfio-mediated-device + xillybus + xz + zorro + .. only:: subproject and html Indices diff --git a/Documentation/io-mapping.rst b/Documentation/driver-api/io-mapping.rst similarity index 99% rename from Documentation/io-mapping.rst rename to Documentation/driver-api/io-mapping.rst index 82a2cacf9a29..a966239f04e4 100644 --- a/Documentation/io-mapping.rst +++ b/Documentation/driver-api/io-mapping.rst @@ -1,5 +1,3 @@ -:orphan: - ======================== The io_mapping functions ======================== diff --git a/Documentation/io_ordering.rst b/Documentation/driver-api/io_ordering.rst similarity index 99% rename from Documentation/io_ordering.rst rename to Documentation/driver-api/io_ordering.rst index 18ef889c100e..2ab303ce9a0d 100644 --- a/Documentation/io_ordering.rst +++ b/Documentation/driver-api/io_ordering.rst @@ -1,5 +1,3 @@ -:orphan: - ============================================== Ordering I/O writes to memory-mapped addresses ============================================== diff --git a/Documentation/IPMI.rst b/Documentation/driver-api/ipmi.rst similarity index 99% rename from Documentation/IPMI.rst rename to Documentation/driver-api/ipmi.rst index f6c2d11710fe..5ef1047e2e66 100644 --- a/Documentation/IPMI.rst +++ b/Documentation/driver-api/ipmi.rst @@ -1,5 +1,3 @@ -:orphan: - ===================== The Linux IPMI Driver ===================== diff --git a/Documentation/IRQ-affinity.rst b/Documentation/driver-api/irq-affinity.rst similarity index 99% rename from Documentation/IRQ-affinity.rst rename to Documentation/driver-api/irq-affinity.rst index 49ba271349d6..29da5000836a 100644 --- a/Documentation/IRQ-affinity.rst +++ b/Documentation/driver-api/irq-affinity.rst @@ -1,5 +1,3 @@ -:orphan: - ================ SMP IRQ affinity ================ diff --git a/Documentation/IRQ-domain.rst b/Documentation/driver-api/irq-domain.rst similarity index 99% rename from Documentation/IRQ-domain.rst rename to Documentation/driver-api/irq-domain.rst index a610a8ea9a92..507775cce753 100644 --- a/Documentation/IRQ-domain.rst +++ b/Documentation/driver-api/irq-domain.rst @@ -1,5 +1,3 @@ -:orphan: - =============================================== The irq_domain interrupt number mapping library =============================================== diff --git a/Documentation/IRQ.rst b/Documentation/driver-api/irq.rst similarity index 99% rename from Documentation/IRQ.rst rename to Documentation/driver-api/irq.rst index a9f3e192c2cb..4273806a606b 100644 --- a/Documentation/IRQ.rst +++ b/Documentation/driver-api/irq.rst @@ -1,5 +1,3 @@ -:orphan: - =============== What is an IRQ? =============== diff --git a/Documentation/irqflags-tracing.rst b/Documentation/driver-api/irqflags-tracing.rst similarity index 99% rename from Documentation/irqflags-tracing.rst rename to Documentation/driver-api/irqflags-tracing.rst index a2fbbb1a62b9..27d0d5a9d6b4 100644 --- a/Documentation/irqflags-tracing.rst +++ b/Documentation/driver-api/irqflags-tracing.rst @@ -1,5 +1,3 @@ -:orphan: - ======================= IRQ-flags state tracing ======================= diff --git a/Documentation/isa.rst b/Documentation/driver-api/isa.rst similarity index 99% rename from Documentation/isa.rst rename to Documentation/driver-api/isa.rst index f3a412d266b0..def4a7b690b5 100644 --- a/Documentation/isa.rst +++ b/Documentation/driver-api/isa.rst @@ -1,5 +1,3 @@ -:orphan: - =========== ISA Drivers =========== diff --git a/Documentation/isapnp.rst b/Documentation/driver-api/isapnp.rst similarity index 98% rename from Documentation/isapnp.rst rename to Documentation/driver-api/isapnp.rst index 136a5e92be27..8d0840ac847b 100644 --- a/Documentation/isapnp.rst +++ b/Documentation/driver-api/isapnp.rst @@ -1,5 +1,3 @@ -:orphan: - ========================================================== ISA Plug & Play support by Jaroslav Kysela ========================================================== diff --git a/Documentation/kobject.rst b/Documentation/driver-api/kobject.rst similarity index 99% rename from Documentation/kobject.rst rename to Documentation/driver-api/kobject.rst index 6117192bf3e6..9f8c42b48867 100644 --- a/Documentation/kobject.rst +++ b/Documentation/driver-api/kobject.rst @@ -1,5 +1,3 @@ -:orphan: - ===================================================================== Everything you never wanted to know about kobjects, ksets, and ktypes ===================================================================== @@ -212,7 +210,7 @@ statically and will warn the developer of this improper usage. If all that you want to use a kobject for is to provide a reference counter for your structure, please use the struct kref instead; a kobject would be overkill. For more information on how to use struct kref, please see the -file Documentation/kref.rst in the Linux kernel source tree. +file Documentation/driver-api/kref.rst in the Linux kernel source tree. Creating "simple" kobjects diff --git a/Documentation/kprobes.rst b/Documentation/driver-api/kprobes.rst similarity index 99% rename from Documentation/kprobes.rst rename to Documentation/driver-api/kprobes.rst index 6c0011755e68..a44cb5f49846 100644 --- a/Documentation/kprobes.rst +++ b/Documentation/driver-api/kprobes.rst @@ -1,5 +1,3 @@ -:orphan: - ======================= Kernel Probes (Kprobes) ======================= diff --git a/Documentation/kref.rst b/Documentation/driver-api/kref.rst similarity index 99% rename from Documentation/kref.rst rename to Documentation/driver-api/kref.rst index 470e3c1bacdc..3af384156d7e 100644 --- a/Documentation/kref.rst +++ b/Documentation/driver-api/kref.rst @@ -1,5 +1,3 @@ -:orphan: - =================================================== Adding reference counters (krefs) to kernel objects =================================================== diff --git a/Documentation/lightnvm/pblk.txt b/Documentation/driver-api/lightnvm-pblk.rst similarity index 100% rename from Documentation/lightnvm/pblk.txt rename to Documentation/driver-api/lightnvm-pblk.rst diff --git a/Documentation/lzo.rst b/Documentation/driver-api/lzo.rst similarity index 99% rename from Documentation/lzo.rst rename to Documentation/driver-api/lzo.rst index 36965db785af..ca983328976b 100644 --- a/Documentation/lzo.rst +++ b/Documentation/driver-api/lzo.rst @@ -1,5 +1,3 @@ -:orphan: - =========================================================== LZO stream format as understood by Linux's LZO decompressor =========================================================== diff --git a/Documentation/mailbox.rst b/Documentation/driver-api/mailbox.rst similarity index 99% rename from Documentation/mailbox.rst rename to Documentation/driver-api/mailbox.rst index 02e754db3567..0ed95009cc30 100644 --- a/Documentation/mailbox.rst +++ b/Documentation/driver-api/mailbox.rst @@ -1,5 +1,3 @@ -:orphan: - ============================ The Common Mailbox Framework ============================ diff --git a/Documentation/men-chameleon-bus.rst b/Documentation/driver-api/men-chameleon-bus.rst similarity index 99% rename from Documentation/men-chameleon-bus.rst rename to Documentation/driver-api/men-chameleon-bus.rst index 2d6175229e58..1b1f048aa748 100644 --- a/Documentation/men-chameleon-bus.rst +++ b/Documentation/driver-api/men-chameleon-bus.rst @@ -1,5 +1,3 @@ -:orphan: - ================= MEN Chameleon Bus ================= diff --git a/Documentation/nommu-mmap.rst b/Documentation/driver-api/nommu-mmap.rst similarity index 99% rename from Documentation/nommu-mmap.rst rename to Documentation/driver-api/nommu-mmap.rst index f7f75813dc9c..530fed08de2c 100644 --- a/Documentation/nommu-mmap.rst +++ b/Documentation/driver-api/nommu-mmap.rst @@ -1,5 +1,3 @@ -:orphan: - ============================= No-MMU memory mapping support ============================= diff --git a/Documentation/ntb.rst b/Documentation/driver-api/ntb.rst similarity index 99% rename from Documentation/ntb.rst rename to Documentation/driver-api/ntb.rst index a25e7814b898..87d1372da879 100644 --- a/Documentation/ntb.rst +++ b/Documentation/driver-api/ntb.rst @@ -1,5 +1,3 @@ -:orphan: - =========== NTB Drivers =========== diff --git a/Documentation/nvmem/nvmem.rst b/Documentation/driver-api/nvmem.rst similarity index 99% rename from Documentation/nvmem/nvmem.rst rename to Documentation/driver-api/nvmem.rst index 3866b6e066d5..c93a9c6cd878 100644 --- a/Documentation/nvmem/nvmem.rst +++ b/Documentation/driver-api/nvmem.rst @@ -1,5 +1,3 @@ -:orphan: - =============== NVMEM Subsystem =============== diff --git a/Documentation/padata.rst b/Documentation/driver-api/padata.rst similarity index 99% rename from Documentation/padata.rst rename to Documentation/driver-api/padata.rst index f8369d18c846..b103d0c82000 100644 --- a/Documentation/padata.rst +++ b/Documentation/driver-api/padata.rst @@ -1,5 +1,3 @@ -:orphan: - ======================================= The padata parallel execution mechanism ======================================= diff --git a/Documentation/parport-lowlevel.rst b/Documentation/driver-api/parport-lowlevel.rst similarity index 99% rename from Documentation/parport-lowlevel.rst rename to Documentation/driver-api/parport-lowlevel.rst index b8574d83d328..0633d70ffda7 100644 --- a/Documentation/parport-lowlevel.rst +++ b/Documentation/driver-api/parport-lowlevel.rst @@ -1,5 +1,3 @@ -:orphan: - =============================== PARPORT interface documentation =============================== diff --git a/Documentation/percpu-rw-semaphore.rst b/Documentation/driver-api/percpu-rw-semaphore.rst similarity index 99% rename from Documentation/percpu-rw-semaphore.rst rename to Documentation/driver-api/percpu-rw-semaphore.rst index 5c39c88d3719..247de6410855 100644 --- a/Documentation/percpu-rw-semaphore.rst +++ b/Documentation/driver-api/percpu-rw-semaphore.rst @@ -1,5 +1,3 @@ -:orphan: - ==================== Percpu rw semaphores ==================== diff --git a/Documentation/pi-futex.rst b/Documentation/driver-api/pi-futex.rst similarity index 99% rename from Documentation/pi-futex.rst rename to Documentation/driver-api/pi-futex.rst index 884ba7f2aa10..c33ba2befbf8 100644 --- a/Documentation/pi-futex.rst +++ b/Documentation/driver-api/pi-futex.rst @@ -1,5 +1,3 @@ -:orphan: - ====================== Lightweight PI-futexes ====================== diff --git a/Documentation/driver-api/pps.rst b/Documentation/driver-api/pps.rst index 1456d2c32ebd..262151a6dad5 100644 --- a/Documentation/driver-api/pps.rst +++ b/Documentation/driver-api/pps.rst @@ -1,5 +1,3 @@ -:orphan: - ====================== PPS - Pulse Per Second ====================== diff --git a/Documentation/preempt-locking.rst b/Documentation/driver-api/preempt-locking.rst similarity index 99% rename from Documentation/preempt-locking.rst rename to Documentation/driver-api/preempt-locking.rst index 4dfa1512a75b..291c2a45b3e8 100644 --- a/Documentation/preempt-locking.rst +++ b/Documentation/driver-api/preempt-locking.rst @@ -1,5 +1,3 @@ -:orphan: - =========================================================================== Proper Locking Under a Preemptible Kernel: Keeping Kernel Code Preempt-Safe =========================================================================== diff --git a/Documentation/pti/pti_intel_mid.rst b/Documentation/driver-api/pti_intel_mid.rst similarity index 99% rename from Documentation/pti/pti_intel_mid.rst rename to Documentation/driver-api/pti_intel_mid.rst index ea05725174cb..a674317790ba 100644 --- a/Documentation/pti/pti_intel_mid.rst +++ b/Documentation/driver-api/pti_intel_mid.rst @@ -1,5 +1,3 @@ -:orphan: - ============= Intel MID PTI ============= diff --git a/Documentation/driver-api/ptp.rst b/Documentation/driver-api/ptp.rst index b6e65d66d37a..65c84a72e9fc 100644 --- a/Documentation/driver-api/ptp.rst +++ b/Documentation/driver-api/ptp.rst @@ -1,5 +1,3 @@ -:orphan: - =========================================== PTP hardware clock infrastructure for Linux =========================================== diff --git a/Documentation/pwm.rst b/Documentation/driver-api/pwm.rst similarity index 99% rename from Documentation/pwm.rst rename to Documentation/driver-api/pwm.rst index 78d06b7f5427..8fbf0aa3ba2d 100644 --- a/Documentation/pwm.rst +++ b/Documentation/driver-api/pwm.rst @@ -1,5 +1,3 @@ -:orphan: - ====================================== Pulse Width Modulation (PWM) interface ====================================== diff --git a/Documentation/rbtree.rst b/Documentation/driver-api/rbtree.rst similarity index 99% rename from Documentation/rbtree.rst rename to Documentation/driver-api/rbtree.rst index c0cbda408050..8bbfcac8db46 100644 --- a/Documentation/rbtree.rst +++ b/Documentation/driver-api/rbtree.rst @@ -1,5 +1,3 @@ -:orphan: - ================================= Red-black Trees (rbtree) in Linux ================================= diff --git a/Documentation/remoteproc.rst b/Documentation/driver-api/remoteproc.rst similarity index 99% rename from Documentation/remoteproc.rst rename to Documentation/driver-api/remoteproc.rst index 71eb7728fcf3..2f525b00f8e7 100644 --- a/Documentation/remoteproc.rst +++ b/Documentation/driver-api/remoteproc.rst @@ -1,5 +1,3 @@ -:orphan: - ========================== Remote Processor Framework ========================== @@ -24,7 +22,7 @@ for remote processors that supports this kind of communication. This way, platform-specific remoteproc drivers only need to provide a few low-level handlers, and then all rpmsg drivers will then just work (for more information about the virtio-based rpmsg bus and its drivers, -please read Documentation/rpmsg.rst). +please read Documentation/driver-api/rpmsg.rst). Registration of other types of virtio devices is now also possible. Firmwares just need to publish what kind of virtio devices do they support, and then remoteproc will add those devices. This makes it possible to reuse the diff --git a/Documentation/rfkill.rst b/Documentation/driver-api/rfkill.rst similarity index 99% rename from Documentation/rfkill.rst rename to Documentation/driver-api/rfkill.rst index 4da9994e9bb4..7d3684e81df6 100644 --- a/Documentation/rfkill.rst +++ b/Documentation/driver-api/rfkill.rst @@ -1,5 +1,3 @@ -:orphan: - =============================== rfkill - RF kill switch support =============================== diff --git a/Documentation/robust-futex-ABI.rst b/Documentation/driver-api/robust-futex-ABI.rst similarity index 99% rename from Documentation/robust-futex-ABI.rst rename to Documentation/driver-api/robust-futex-ABI.rst index 6d359b46610c..8a5d34abf726 100644 --- a/Documentation/robust-futex-ABI.rst +++ b/Documentation/driver-api/robust-futex-ABI.rst @@ -1,5 +1,3 @@ -:orphan: - ==================== The robust futex ABI ==================== diff --git a/Documentation/robust-futexes.rst b/Documentation/driver-api/robust-futexes.rst similarity index 99% rename from Documentation/robust-futexes.rst rename to Documentation/driver-api/robust-futexes.rst index 20beef77597a..6361fb01c9c1 100644 --- a/Documentation/robust-futexes.rst +++ b/Documentation/driver-api/robust-futexes.rst @@ -1,5 +1,3 @@ -:orphan: - ======================================== A description of what robust futexes are ======================================== diff --git a/Documentation/rpmsg.rst b/Documentation/driver-api/rpmsg.rst similarity index 99% rename from Documentation/rpmsg.rst rename to Documentation/driver-api/rpmsg.rst index ad53931f3e43..24b7a9e1a5f9 100644 --- a/Documentation/rpmsg.rst +++ b/Documentation/driver-api/rpmsg.rst @@ -1,5 +1,3 @@ -:orphan: - ============================================ Remote Processor Messaging (rpmsg) Framework ============================================ diff --git a/Documentation/sgi-ioc4.rst b/Documentation/driver-api/sgi-ioc4.rst similarity index 99% rename from Documentation/sgi-ioc4.rst rename to Documentation/driver-api/sgi-ioc4.rst index e6ed2e9b055b..72709222d3c0 100644 --- a/Documentation/sgi-ioc4.rst +++ b/Documentation/driver-api/sgi-ioc4.rst @@ -1,5 +1,3 @@ -:orphan: - ==================================== SGI IOC4 PCI (multi function) device ==================================== diff --git a/Documentation/SM501.rst b/Documentation/driver-api/sm501.rst similarity index 99% rename from Documentation/SM501.rst rename to Documentation/driver-api/sm501.rst index 772a9b5c7d49..882507453ba4 100644 --- a/Documentation/SM501.rst +++ b/Documentation/driver-api/sm501.rst @@ -1,5 +1,3 @@ -:orphan: - .. include:: ============ diff --git a/Documentation/smsc_ece1099.rst b/Documentation/driver-api/smsc_ece1099.rst similarity index 99% rename from Documentation/smsc_ece1099.rst rename to Documentation/driver-api/smsc_ece1099.rst index a403fcd7c64d..079277421eaf 100644 --- a/Documentation/smsc_ece1099.rst +++ b/Documentation/driver-api/smsc_ece1099.rst @@ -1,5 +1,3 @@ -:orphan: - ================================================= Msc Keyboard Scan Expansion/GPIO Expansion device ================================================= diff --git a/Documentation/speculation.rst b/Documentation/driver-api/speculation.rst similarity index 99% rename from Documentation/speculation.rst rename to Documentation/driver-api/speculation.rst index e240f01b0983..47f8ad300695 100644 --- a/Documentation/speculation.rst +++ b/Documentation/driver-api/speculation.rst @@ -1,12 +1,10 @@ -:orphan: +=========== +Speculation +=========== This document explains potential effects of speculation, and how undesirable effects can be mitigated portably using common APIs. -=========== -Speculation -=========== - To improve performance and minimize average latencies, many contemporary CPUs employ speculative execution techniques such as branch prediction, performing work which may be discarded at a later stage. diff --git a/Documentation/static-keys.rst b/Documentation/driver-api/static-keys.rst similarity index 99% rename from Documentation/static-keys.rst rename to Documentation/driver-api/static-keys.rst index bdf545e3a37f..9803e14639bf 100644 --- a/Documentation/static-keys.rst +++ b/Documentation/driver-api/static-keys.rst @@ -1,5 +1,3 @@ -:orphan: - =========== Static Keys =========== diff --git a/Documentation/switchtec.rst b/Documentation/driver-api/switchtec.rst similarity index 97% rename from Documentation/switchtec.rst rename to Documentation/driver-api/switchtec.rst index 6879c92de8e2..7611fdc53e19 100644 --- a/Documentation/switchtec.rst +++ b/Documentation/driver-api/switchtec.rst @@ -1,5 +1,3 @@ -:orphan: - ======================== Linux Switchtec Support ======================== @@ -99,6 +97,6 @@ the following configuration settings: NT EP BAR 2 will be dynamically configured as a Direct Window, and the configuration file does not need to configure it explicitly. -Please refer to Documentation/ntb.rst in Linux source tree for an overall +Please refer to Documentation/driver-api/ntb.rst in Linux source tree for an overall understanding of the Linux NTB stack. ntb_hw_switchtec works as an NTB Hardware Driver in this stack. diff --git a/Documentation/sync_file.rst b/Documentation/driver-api/sync_file.rst similarity index 99% rename from Documentation/sync_file.rst rename to Documentation/driver-api/sync_file.rst index a65a67cc06fa..496fb2c3b3e6 100644 --- a/Documentation/sync_file.rst +++ b/Documentation/driver-api/sync_file.rst @@ -1,5 +1,3 @@ -:orphan: - =================== Sync File API Guide =================== diff --git a/Documentation/tee.rst b/Documentation/driver-api/tee.rst similarity index 99% rename from Documentation/tee.rst rename to Documentation/driver-api/tee.rst index 5eacffb823b5..afacdf2fd1de 100644 --- a/Documentation/tee.rst +++ b/Documentation/driver-api/tee.rst @@ -1,5 +1,3 @@ -:orphan: - ============= TEE subsystem ============= diff --git a/Documentation/this_cpu_ops.rst b/Documentation/driver-api/this_cpu_ops.rst similarity index 99% rename from Documentation/this_cpu_ops.rst rename to Documentation/driver-api/this_cpu_ops.rst index a489d25ff549..5cb8b883ae83 100644 --- a/Documentation/this_cpu_ops.rst +++ b/Documentation/driver-api/this_cpu_ops.rst @@ -1,5 +1,3 @@ -:orphan: - =================== this_cpu operations =================== diff --git a/Documentation/unaligned-memory-access.rst b/Documentation/driver-api/unaligned-memory-access.rst similarity index 99% rename from Documentation/unaligned-memory-access.rst rename to Documentation/driver-api/unaligned-memory-access.rst index 848013a8bc10..1ee82419d8aa 100644 --- a/Documentation/unaligned-memory-access.rst +++ b/Documentation/driver-api/unaligned-memory-access.rst @@ -1,5 +1,3 @@ -:orphan: - ========================= Unaligned Memory Accesses ========================= diff --git a/Documentation/vfio-mediated-device.rst b/Documentation/driver-api/vfio-mediated-device.rst similarity index 99% rename from Documentation/vfio-mediated-device.rst rename to Documentation/driver-api/vfio-mediated-device.rst index 0ea57427e7e6..25eb7d5b834b 100644 --- a/Documentation/vfio-mediated-device.rst +++ b/Documentation/driver-api/vfio-mediated-device.rst @@ -1,5 +1,3 @@ -:orphan: - .. include:: ===================== @@ -410,7 +408,7 @@ card. References ========== -1. See Documentation/vfio.rst for more information on VFIO. +1. See Documentation/driver-api/vfio.rst for more information on VFIO. 2. struct mdev_driver in include/linux/mdev.h 3. struct mdev_parent_ops in include/linux/mdev.h 4. struct vfio_iommu_driver_ops in include/linux/vfio.h diff --git a/Documentation/vfio.rst b/Documentation/driver-api/vfio.rst similarity index 99% rename from Documentation/vfio.rst rename to Documentation/driver-api/vfio.rst index 8a3fbd7d96f0..f1a4d3c3ba0b 100644 --- a/Documentation/vfio.rst +++ b/Documentation/driver-api/vfio.rst @@ -1,5 +1,3 @@ -:orphan: - ================================== VFIO - "Virtual Function I/O" [1]_ ================================== diff --git a/Documentation/xillybus.rst b/Documentation/driver-api/xillybus.rst similarity index 99% rename from Documentation/xillybus.rst rename to Documentation/driver-api/xillybus.rst index d99f4a37e8b6..2446ee303c09 100644 --- a/Documentation/xillybus.rst +++ b/Documentation/driver-api/xillybus.rst @@ -1,5 +1,3 @@ -:orphan: - ========================================== Xillybus driver for generic FPGA interface ========================================== diff --git a/Documentation/xz.rst b/Documentation/driver-api/xz.rst similarity index 99% rename from Documentation/xz.rst rename to Documentation/driver-api/xz.rst index 205edc6646d5..b2220d03aa50 100644 --- a/Documentation/xz.rst +++ b/Documentation/driver-api/xz.rst @@ -1,5 +1,3 @@ -:orphan: - ============================ XZ data compression in Linux ============================ diff --git a/Documentation/zorro.rst b/Documentation/driver-api/zorro.rst similarity index 99% rename from Documentation/zorro.rst rename to Documentation/driver-api/zorro.rst index 7cd509f31d57..59fb1634d903 100644 --- a/Documentation/zorro.rst +++ b/Documentation/driver-api/zorro.rst @@ -1,5 +1,3 @@ -:orphan: - ======================================== Writing Device Drivers for Zorro Devices ======================================== diff --git a/Documentation/driver-model/device.rst b/Documentation/driver-model/device.rst index 17bcc483c4b1..b0734caf6b8f 100644 --- a/Documentation/driver-model/device.rst +++ b/Documentation/driver-model/device.rst @@ -53,7 +53,7 @@ Attributes of devices can be exported by a device driver through sysfs. Please see Documentation/filesystems/sysfs.txt for more information on how sysfs works. -As explained in Documentation/kobject.rst, device attributes must be +As explained in Documentation/driver-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. diff --git a/Documentation/fb/fbcon.rst b/Documentation/fb/fbcon.rst index 22112718dd5d..b9aafb733db9 100644 --- a/Documentation/fb/fbcon.rst +++ b/Documentation/fb/fbcon.rst @@ -187,7 +187,7 @@ the hardware. Thus, in a VGA console:: Assuming the VGA driver can be unloaded, one must first unbind the VGA driver from the console layer before unloading the driver. The VGA driver cannot be unloaded if it is still bound to the console layer. (See -Documentation/console/console.rst for more information). +Documentation/driver-api/console.rst for more information). This is more complicated in the case of the framebuffer console (fbcon), because fbcon is an intermediate layer between the console and the drivers:: @@ -204,7 +204,7 @@ fbcon. Thus, there is no need to explicitly unbind the fbdev drivers from fbcon. So, how do we unbind fbcon from the console? Part of the answer is in -Documentation/console/console.rst. To summarize: +Documentation/driver-api/console.rst. To summarize: Echo a value to the bind file that represents the framebuffer console driver. So assuming vtcon1 represents fbcon, then:: diff --git a/Documentation/filesystems/sysfs.txt b/Documentation/filesystems/sysfs.txt index d159826c5cf3..20ab929c0e0c 100644 --- a/Documentation/filesystems/sysfs.txt +++ b/Documentation/filesystems/sysfs.txt @@ -16,7 +16,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.rst for more information concerning the kobject +Documentation/driver-api/kobject.rst for more information concerning the kobject interface. diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst index fa30dfcfc3c8..b0f948d8733b 100644 --- a/Documentation/gpu/drm-mm.rst +++ b/Documentation/gpu/drm-mm.rst @@ -320,7 +320,7 @@ struct :c:type:`struct file_operations ` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rst Memory Coherency ---------------- diff --git a/Documentation/ia64/irq-redir.rst b/Documentation/ia64/irq-redir.rst index 0abc7b35f6c0..0cd7ba1b0b08 100644 --- a/Documentation/ia64/irq-redir.rst +++ b/Documentation/ia64/irq-redir.rst @@ -7,7 +7,7 @@ IRQ affinity on IA64 platforms By writing to /proc/irq/IRQ#/smp_affinity the interrupt routing can be controlled. The behavior on IA64 platforms is slightly different from -that described in Documentation/IRQ-affinity.rst for i386 systems. +that described in Documentation/driver-api/irq-affinity.rst for i386 systems. Because of the usage of SAPIC mode and physical destination mode the IRQ target is one particular CPU and cannot be a mask of several diff --git a/Documentation/laptops/thinkpad-acpi.rst b/Documentation/laptops/thinkpad-acpi.rst index d0f0d16c21b9..adea0bf2acc5 100644 --- a/Documentation/laptops/thinkpad-acpi.rst +++ b/Documentation/laptops/thinkpad-acpi.rst @@ -643,7 +643,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_bluetooth_sw": refer to - Documentation/rfkill.rst for details. + Documentation/driver-api/rfkill.rst for details. Video output control -- /proc/acpi/ibm/video @@ -1406,7 +1406,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_wwan_sw": refer to - Documentation/rfkill.rst for details. + Documentation/driver-api/rfkill.rst for details. EXPERIMENTAL: UWB @@ -1426,7 +1426,7 @@ Sysfs notes ^^^^^^^^^^^ rfkill controller switch "tpacpi_uwb_sw": refer to - Documentation/rfkill.rst for details. + Documentation/driver-api/rfkill.rst for details. Adaptive keyboard ----------------- diff --git a/Documentation/locking/rt-mutex.rst b/Documentation/locking/rt-mutex.rst index 6e3dcff802f9..18b5f0f0418e 100644 --- a/Documentation/locking/rt-mutex.rst +++ b/Documentation/locking/rt-mutex.rst @@ -4,7 +4,7 @@ RT-mutex subsystem with PI support RT-mutexes with priority inheritance are used to support PI-futexes, which enable pthread_mutex_t priority inheritance attributes -(PTHREAD_PRIO_INHERIT). [See Documentation/pi-futex.rst for more details +(PTHREAD_PRIO_INHERIT). [See Documentation/driver-api/pi-futex.rst for more details about PI-futexes.] This technology was developed in the -rt tree and streamlined for diff --git a/Documentation/networking/scaling.rst b/Documentation/networking/scaling.rst index 05f0feb99320..a20325aa1330 100644 --- a/Documentation/networking/scaling.rst +++ b/Documentation/networking/scaling.rst @@ -81,7 +81,7 @@ of queues to IRQs can be determined from /proc/interrupts. By default, an IRQ may be handled on any CPU. Because a non-negligible part of packet processing takes place in receive interrupt handling, it is advantageous to spread receive interrupts between CPUs. To manually adjust the IRQ -affinity of each interrupt see Documentation/IRQ-affinity.rst. Some systems +affinity of each interrupt see Documentation/driver-api/irq-affinity.rst. Some systems will be running irqbalance, a daemon that dynamically optimizes IRQ assignments and as a result may override any manual settings. @@ -160,7 +160,7 @@ can be configured for each receive queue using a sysfs file entry:: This file implements a bitmap of CPUs. RPS is disabled when it is zero (the default), in which case packets are processed on the interrupting -CPU. Documentation/IRQ-affinity.rst explains how CPUs are assigned to +CPU. Documentation/driver-api/irq-affinity.rst explains how CPUs are assigned to the bitmap. diff --git a/Documentation/s390/vfio-ccw.rst b/Documentation/s390/vfio-ccw.rst index 87b5bb49b2f3..1e210c6afa88 100644 --- a/Documentation/s390/vfio-ccw.rst +++ b/Documentation/s390/vfio-ccw.rst @@ -38,7 +38,7 @@ every detail. More information/reference could be found here: qemu/hw/s390x/css.c For vfio mediated device framework: -- Documentation/vfio-mediated-device.rst +- Documentation/driver-api/vfio-mediated-device.rst Motivation of vfio-ccw ---------------------- @@ -322,5 +322,5 @@ Reference 2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204) 3. https://en.wikipedia.org/wiki/Channel_I/O 4. Documentation/s390/cds.rst -5. Documentation/vfio.rst -6. Documentation/vfio-mediated-device.rst +5. Documentation/driver-api/vfio.rst +6. Documentation/driver-api/vfio-mediated-device.rst diff --git a/Documentation/sysctl/kernel.rst b/Documentation/sysctl/kernel.rst index 9324c3b1aa3e..6e9144bfba9c 100644 --- a/Documentation/sysctl/kernel.rst +++ b/Documentation/sysctl/kernel.rst @@ -50,7 +50,7 @@ show up in /proc/sys/kernel: - kexec_load_disabled - kptr_restrict - l2cr [ PPC only ] -- modprobe ==> Documentation/debugging-modules.rst +- modprobe ==> Documentation/driver-api/debugging-modules.rst - modules_disabled - msg_next_id [ sysv ipc ] - msgmax diff --git a/Documentation/sysctl/vm.rst b/Documentation/sysctl/vm.rst index 43d594877df7..4940ab610eb7 100644 --- a/Documentation/sysctl/vm.rst +++ b/Documentation/sysctl/vm.rst @@ -580,7 +580,7 @@ trimming of allocations is initiated. The default value is 1. -See Documentation/nommu-mmap.rst for more information. +See Documentation/driver-api/nommu-mmap.rst for more information. numa_zonelist_order diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst index 74f698affea1..caa0a8ba081e 100644 --- a/Documentation/trace/kprobetrace.rst +++ b/Documentation/trace/kprobetrace.rst @@ -40,7 +40,7 @@ Synopsis of kprobe_events MEMADDR : Address where the probe is inserted. MAXACTIVE : Maximum number of instances of the specified function that can be probed simultaneously, or 0 for the default value - as defined in Documentation/kprobes.rst section 1.3.1. + as defined in Documentation/driver-api/kprobes.rst section 1.3.1. FETCHARGS : Arguments. Each probe can have up to 128 args. %REG : Fetch register REG diff --git a/Documentation/translations/zh_CN/IRQ.txt b/Documentation/translations/zh_CN/IRQ.txt index 0d9ec142e185..c6e77a1b14e7 100644 --- a/Documentation/translations/zh_CN/IRQ.txt +++ b/Documentation/translations/zh_CN/IRQ.txt @@ -1,4 +1,4 @@ -Chinese translated version of Documentation/IRQ.rst +Chinese translated version of Documentation/driver-api/irq.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem @@ -9,7 +9,7 @@ or if there is a problem with the translation. Maintainer: Eric W. Biederman Chinese maintainer: Fu Wei --------------------------------------------------------------------- -Documentation/IRQ.rst 的中文翻译 +Documentation/driver-api/irq.rst 的中文翻译 如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 diff --git a/Documentation/translations/zh_CN/filesystems/sysfs.txt b/Documentation/translations/zh_CN/filesystems/sysfs.txt index f5482e082399..0e0c6d3d4129 100644 --- a/Documentation/translations/zh_CN/filesystems/sysfs.txt +++ b/Documentation/translations/zh_CN/filesystems/sysfs.txt @@ -40,7 +40,7 @@ sysfs 是一个最初基于 ramfs 且位于内存的文件系统。它提供导 数据结构及其属性，以及它们之间的关联到用户空间的方法。 sysfs 始终与 kobject 的底层结构紧密相关。请阅读 -Documentation/kobject.rst 文档以获得更多关于 kobject 接口的 +Documentation/driver-api/kobject.rst 文档以获得更多关于 kobject 接口的 信息。 diff --git a/Documentation/translations/zh_CN/io_ordering.txt b/Documentation/translations/zh_CN/io_ordering.txt index 4e9727990c10..7bb3086227ae 100644 --- a/Documentation/translations/zh_CN/io_ordering.txt +++ b/Documentation/translations/zh_CN/io_ordering.txt @@ -1,4 +1,4 @@ -Chinese translated version of Documentation/io_ordering.rst +Chinese translated version of Documentation/driver-api/io_ordering.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem @@ -8,7 +8,7 @@ or if there is a problem with the translation. Chinese maintainer: Lin Yongting --------------------------------------------------------------------- -Documentation/io_ordering.rst 的中文翻译 +Documentation/driver-api/io_ordering.rst 的中文翻译 如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 diff --git a/Documentation/w1/w1.netlink b/Documentation/w1/w1.netlink index ef2727192d69..94ad4c420828 100644 --- a/Documentation/w1/w1.netlink +++ b/Documentation/w1/w1.netlink @@ -183,7 +183,7 @@ acknowledge number is set to seq+1. Additional documantion, source code examples. ============================================ -1. Documentation/connector +1. Documentation/driver-api/connector.rst 2. http://www.ioremap.net/archive/w1 This archive includes userspace application w1d.c which uses read/write/search commands for all master/slave devices found on the bus. diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst index f4ba329f011f..437456bd91a4 100644 --- a/Documentation/watchdog/hpwdt.rst +++ b/Documentation/watchdog/hpwdt.rst @@ -44,7 +44,7 @@ Last reviewed: 08/20/2018 NOTE: More information about watchdog drivers in general, including the ioctl interface to /dev/watchdog can be found in - Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.rst. + Documentation/watchdog/watchdog-api.rst and Documentation/driver-api/ipmi.rst. Due to limitations in the iLO hardware, the NMI pretimeout if enabled, can only be set to 9 seconds. Attempts to set pretimeout to other diff --git a/MAINTAINERS b/MAINTAINERS index 98723afdbf0b..85a6f090ccc0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4588,7 +4588,7 @@ DELL SYSTEMS MANAGEMENT BASE DRIVER (dcdbas) M: Stuart Hayes L: platform-driver-x86@vger.kernel.org S: Maintained -F: Documentation/dcdbas.rst +F: Documentation/driver-api/dcdbas.rst F: drivers/platform/x86/dcdbas.* DELL WMI NOTIFICATIONS DRIVER @@ -4966,7 +4966,7 @@ M: Greg Kroah-Hartman R: "Rafael J. Wysocki" T: git git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core.git S: Supported -F: Documentation/kobject.rst +F: Documentation/driver-api/kobject.rst F: drivers/base/ F: fs/debugfs/ F: fs/sysfs/ @@ -6584,7 +6584,7 @@ F: include/linux/futex.h F: include/uapi/linux/futex.h F: tools/testing/selftests/futex/ F: tools/perf/bench/futex* -F: Documentation/*futex* +F: Documentation/driver-api/*futex* GCC PLUGINS M: Kees Cook @@ -6594,7 +6594,7 @@ S: Maintained F: scripts/gcc-plugins/ F: scripts/gcc-plugin.sh F: scripts/Makefile.gcc-plugins -F: Documentation/gcc-plugins.rst +F: Documentation/driver-api/gcc-plugins.rst GASKET DRIVER FRAMEWORK M: Rob Springer @@ -7022,7 +7022,7 @@ L: linux-remoteproc@vger.kernel.org S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/ohad/hwspinlock.git F: Documentation/devicetree/bindings/hwlock/ -F: Documentation/hwspinlock.rst +F: Documentation/driver-api/hwspinlock.rst F: drivers/hwspinlock/ F: include/linux/hwspinlock.h @@ -8292,7 +8292,7 @@ L: openipmi-developer@lists.sourceforge.net (moderated for non-subscribers) W: http://openipmi.sourceforge.net/ S: Supported F: Documentation/devicetree/bindings/ipmi/ -F: Documentation/IPMI.rst +F: Documentation/driver-api/ipmi.rst F: drivers/char/ipmi/ F: include/linux/ipmi* F: include/uapi/linux/ipmi* @@ -8333,7 +8333,7 @@ IRQ DOMAINS (IRQ NUMBER MAPPING LIBRARY) M: Marc Zyngier S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git irq/core -F: Documentation/IRQ-domain.rst +F: Documentation/driver-api/irq-domain.rst F: include/linux/irqdomain.h F: kernel/irq/irqdomain.c F: kernel/irq/msi.c @@ -8358,7 +8358,7 @@ F: drivers/irqchip/ ISA M: William Breathitt Gray S: Maintained -F: Documentation/isa.rst +F: Documentation/driver-api/isa.rst F: drivers/base/isa.c F: include/linux/isa.h @@ -8373,7 +8373,7 @@ F: drivers/media/radio/radio-isa* ISAPNP M: Jaroslav Kysela S: Maintained -F: Documentation/isapnp.rst +F: Documentation/driver-api/isapnp.rst F: drivers/pnp/isapnp/ F: include/linux/isapnp.h @@ -8823,7 +8823,7 @@ M: Anil S Keshavamurthy M: "David S. Miller" M: Masami Hiramatsu S: Maintained -F: Documentation/kprobes.rst +F: Documentation/driver-api/kprobes.rst F: include/linux/kprobes.h F: include/asm-generic/kprobes.h F: kernel/kprobes.c @@ -9182,7 +9182,7 @@ L: linux-arch@vger.kernel.org S: Supported T: git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git dev F: tools/memory-model/ -F: Documentation/atomic_bitops.rst +F: Documentation/driver-api/atomic_bitops.rst F: Documentation/atomic_t.txt F: Documentation/core-api/atomic_ops.rst F: Documentation/core-api/refcount-vs-atomic.rst @@ -10240,7 +10240,7 @@ M: Johannes Thumshirn S: Maintained F: drivers/mcb/ F: include/linux/mcb.h -F: Documentation/men-chameleon-bus.rst +F: Documentation/driver-api/men-chameleon-bus.rst MEN F21BMC (Board Management Controller) M: Andreas Werner @@ -11923,7 +11923,7 @@ L: linux-crypto@vger.kernel.org S: Maintained F: kernel/padata.c F: include/linux/padata.h -F: Documentation/padata.rst +F: Documentation/driver-api/padata.rst PANASONIC LAPTOP ACPI EXTRAS DRIVER M: Harald Welte @@ -11947,7 +11947,7 @@ F: drivers/parport/ F: include/linux/parport*.h F: drivers/char/ppdev.c F: include/uapi/linux/ppdev.h -F: Documentation/parport*.rst +F: Documentation/driver-api/parport*.rst PARAVIRT_OPS INTERFACE M: Juergen Gross @@ -12122,7 +12122,7 @@ M: Kurt Schwemmer M: Logan Gunthorpe L: linux-pci@vger.kernel.org S: Maintained -F: Documentation/switchtec.rst +F: Documentation/driver-api/switchtec.rst F: Documentation/ABI/testing/sysfs-class-switchtec F: drivers/pci/switch/switchtec* F: include/uapi/linux/switchtec_ioctl.h @@ -12884,7 +12884,7 @@ M: Thierry Reding L: linux-pwm@vger.kernel.org S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/thierry.reding/linux-pwm.git -F: Documentation/pwm.rst +F: Documentation/driver-api/pwm.rst F: Documentation/devicetree/bindings/pwm/ F: include/linux/pwm.h F: drivers/pwm/ @@ -13405,7 +13405,7 @@ T: git git://git.kernel.org/pub/scm/linux/kernel/git/ohad/remoteproc.git S: Maintained F: Documentation/devicetree/bindings/remoteproc/ F: Documentation/ABI/testing/sysfs-class-remoteproc -F: Documentation/remoteproc.rst +F: Documentation/driver-api/remoteproc.rst F: drivers/remoteproc/ F: include/linux/remoteproc.h F: include/linux/remoteproc/ @@ -13417,7 +13417,7 @@ L: linux-remoteproc@vger.kernel.org T: git git://git.kernel.org/pub/scm/linux/kernel/git/ohad/rpmsg.git S: Maintained F: drivers/rpmsg/ -F: Documentation/rpmsg.rst +F: Documentation/driver-api/rpmsg.rst F: Documentation/ABI/testing/sysfs-bus-rpmsg F: include/linux/rpmsg.h F: include/linux/rpmsg/ @@ -13503,7 +13503,7 @@ W: http://wireless.kernel.org/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git S: Maintained -F: Documentation/rfkill.rst +F: Documentation/driver-api/rfkill.rst F: Documentation/ABI/stable/sysfs-class-rfkill F: net/rfkill/ F: include/linux/rfkill.h @@ -15211,7 +15211,7 @@ F: drivers/dma-buf/dma-fence* F: drivers/dma-buf/sw_sync.c F: include/linux/sync_file.h F: include/uapi/linux/sync_file.h -F: Documentation/sync_file.rst +F: Documentation/driver-api/sync_file.rst T: git git://anongit.freedesktop.org/drm/drm-misc SYNOPSYS ARC ARCHITECTURE @@ -15537,7 +15537,7 @@ S: Maintained F: include/linux/tee_drv.h F: include/uapi/linux/tee.h F: drivers/tee/ -F: Documentation/tee.rst +F: Documentation/driver-api/tee.rst TEGRA ARCHITECTURE SUPPORT M: Thierry Reding @@ -16706,7 +16706,7 @@ R: Cornelia Huck L: kvm@vger.kernel.org T: git git://github.com/awilliam/linux-vfio.git S: Maintained -F: Documentation/vfio.rst +F: Documentation/driver-api/vfio.rst F: drivers/vfio/ F: include/linux/vfio.h F: include/uapi/linux/vfio.h @@ -16715,7 +16715,7 @@ VFIO MEDIATED DEVICE DRIVERS M: Kirti Wankhede L: kvm@vger.kernel.org S: Maintained -F: Documentation/vfio-mediated-device.rst +F: Documentation/driver-api/vfio-mediated-device.rst F: drivers/vfio/mdev/ F: include/linux/mdev.h F: samples/vfio-mdev/ diff --git a/arch/Kconfig b/arch/Kconfig index c2f2bee5b17b..bfc372208609 100644 --- a/arch/Kconfig +++ b/arch/Kconfig @@ -141,7 +141,7 @@ config HAVE_64BIT_ALIGNED_ACCESS accesses are required to be 64 bit aligned in this way even though it is not a 64 bit architecture. - See Documentation/unaligned-memory-access.rst for more + See Documentation/driver-api/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config HAVE_EFFICIENT_UNALIGNED_ACCESS @@ -160,7 +160,7 @@ config HAVE_EFFICIENT_UNALIGNED_ACCESS problems with received packets if doing so would not help much. - See Documentation/unaligned-memory-access.rst for more + See Documentation/driver-api/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config ARCH_USE_BUILTIN_BSWAP diff --git a/arch/unicore32/include/asm/io.h b/arch/unicore32/include/asm/io.h index 86877df4b1ee..e396d4f658f9 100644 --- a/arch/unicore32/include/asm/io.h +++ b/arch/unicore32/include/asm/io.h @@ -31,7 +31,7 @@ extern void __uc32_iounmap(volatile void __iomem *addr); * ioremap and friends. * * ioremap takes a PCI memory address, as specified in - * Documentation/io-mapping.rst. + * Documentation/driver-api/io-mapping.rst. * */ #define ioremap(cookie, size) __uc32_ioremap(cookie, size) diff --git a/drivers/base/core.c b/drivers/base/core.c index f98b33e9ec19..e40e4a171cdd 100644 --- a/drivers/base/core.c +++ b/drivers/base/core.c @@ -1063,7 +1063,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.rst.\n", + WARN(1, KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/driver-api/kobject.rst.\n", dev_name(dev)); kfree(p); } diff --git a/drivers/char/ipmi/Kconfig b/drivers/char/ipmi/Kconfig index e59ee81bc22f..d7f89cce656f 100644 --- a/drivers/char/ipmi/Kconfig +++ b/drivers/char/ipmi/Kconfig @@ -14,7 +14,7 @@ menuconfig IPMI_HANDLER IPMI is a standard for managing sensors (temperature, voltage, etc.) in a system. - See for more details on the driver. + See for more details on the driver. If unsure, say N. diff --git a/drivers/char/ipmi/ipmi_si_hotmod.c b/drivers/char/ipmi/ipmi_si_hotmod.c index 2032f4ac52ac..4fbb4e18bae2 100644 --- a/drivers/char/ipmi/ipmi_si_hotmod.c +++ b/drivers/char/ipmi/ipmi_si_hotmod.c @@ -18,7 +18,7 @@ static int hotmod_handler(const char *val, const struct kernel_param *kp); module_param_call(hotmod, hotmod_handler, NULL, NULL, 0200); MODULE_PARM_DESC(hotmod, "Add and remove interfaces. See" - " Documentation/IPMI.rst in the kernel sources for the" + " Documentation/driver-api/ipmi.rst in the kernel sources for the" " gory details."); /* diff --git a/drivers/char/ipmi/ipmi_si_intf.c b/drivers/char/ipmi/ipmi_si_intf.c index 7f729609979c..4a0258f886cf 100644 --- a/drivers/char/ipmi/ipmi_si_intf.c +++ b/drivers/char/ipmi/ipmi_si_intf.c @@ -977,7 +977,7 @@ static inline int ipmi_thread_busy_wait(enum si_sm_result smi_result, * that are not BT and do not have interrupts. It starts spinning * when an operation is complete or until max_busy tells it to stop * (if that is enabled). See the paragraph on kimid_max_busy_us in - * Documentation/IPMI.rst for details. + * Documentation/driver-api/ipmi.rst for details. */ static int ipmi_thread(void *data) { diff --git a/drivers/dma-buf/Kconfig b/drivers/dma-buf/Kconfig index 9afc7bb638c3..b6a9c2f1bc41 100644 --- a/drivers/dma-buf/Kconfig +++ b/drivers/dma-buf/Kconfig @@ -15,7 +15,7 @@ config SYNC_FILE associated with a buffer. When a job is submitted to the GPU a fence is attached to the buffer and is transferred via userspace, using Sync Files fds, to the DRM driver for example. More details at - Documentation/sync_file.rst. + Documentation/driver-api/sync_file.rst. config SW_SYNC bool "Sync File Validation Framework" diff --git a/drivers/gpio/Kconfig b/drivers/gpio/Kconfig index 85cecf58bcf5..49f04621279c 100644 --- a/drivers/gpio/Kconfig +++ b/drivers/gpio/Kconfig @@ -1300,7 +1300,7 @@ config GPIO_BT8XX The card needs to be physically altered for using it as a GPIO card. For more information on how to build a GPIO card from a BT8xx TV card, see the documentation file at - Documentation/bt8xxgpio.rst + Documentation/driver-api/bt8xxgpio.rst If unsure, say N. diff --git a/drivers/gpu/drm/Kconfig b/drivers/gpu/drm/Kconfig index c3a6dd284c91..3c2cd3bf9ffc 100644 --- a/drivers/gpu/drm/Kconfig +++ b/drivers/gpu/drm/Kconfig @@ -141,7 +141,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/EDID/howto.rst. + EDID data are given in Documentation/driver-api/edid.rst. config DRM_DP_CEC bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support" diff --git a/drivers/pci/switch/Kconfig b/drivers/pci/switch/Kconfig index c1f5226cd0e5..d370f4ce0492 100644 --- a/drivers/pci/switch/Kconfig +++ b/drivers/pci/switch/Kconfig @@ -9,7 +9,7 @@ config PCI_SW_SWITCHTEC Enables support for the management interface for the MicroSemi Switchtec series of PCIe switches. Supports userspace access to submit MRPC commands to the switch via /dev/switchtecX - devices. See for more + devices. See for more information. endmenu diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig index 6cd4a620115d..9d866b6753fe 100644 --- a/drivers/platform/x86/Kconfig +++ b/drivers/platform/x86/Kconfig @@ -118,7 +118,7 @@ config DCDBAS Interrupts (SMIs) and Host Control Actions (system power cycle or power off after OS shutdown) on certain Dell systems. - See for more details on the driver + See for more details on the driver and the Dell systems on which Dell systems management software makes use of this driver. @@ -259,7 +259,7 @@ config DELL_RBU DELL system. Note you need a Dell OpenManage or Dell Update package (DUP) supporting application to communicate with the BIOS regarding the new image for the image update to take effect. - See for more details on the driver. + See for more details on the driver. config FUJITSU_LAPTOP diff --git a/drivers/platform/x86/dcdbas.c b/drivers/platform/x86/dcdbas.c index ba8dff3511ec..84f4cc839cc3 100644 --- a/drivers/platform/x86/dcdbas.c +++ b/drivers/platform/x86/dcdbas.c @@ -7,7 +7,7 @@ * and Host Control Actions (power cycle or power off after OS shutdown) on * Dell systems. * - * See Documentation/dcdbas.rst for more information. + * See Documentation/driver-api/dcdbas.rst for more information. * * Copyright (C) 1995-2006 Dell Inc. */ diff --git a/drivers/platform/x86/dell_rbu.c b/drivers/platform/x86/dell_rbu.c index 18400bb38e09..3691391fea6b 100644 --- a/drivers/platform/x86/dell_rbu.c +++ b/drivers/platform/x86/dell_rbu.c @@ -24,7 +24,7 @@ * on every time the packet data is written. This driver requires an * application to break the BIOS image in to fixed sized packet chunks. * - * See Documentation/dell_rbu.rst for more info. + * See Documentation/driver-api/dell_rbu.rst for more info. */ #include #include diff --git a/drivers/pnp/isapnp/Kconfig b/drivers/pnp/isapnp/Kconfig index c4ddf41c7fb8..d0479a563123 100644 --- a/drivers/pnp/isapnp/Kconfig +++ b/drivers/pnp/isapnp/Kconfig @@ -7,6 +7,6 @@ config ISAPNP depends on ISA || COMPILE_TEST help Say Y here if you would like support for ISA Plug and Play devices. - Some information is in . + Some information is in . If unsure, say Y. diff --git a/drivers/tty/Kconfig b/drivers/tty/Kconfig index 1cb50f19d58c..ee51b9514225 100644 --- a/drivers/tty/Kconfig +++ b/drivers/tty/Kconfig @@ -93,7 +93,7 @@ config VT_HW_CONSOLE_BINDING select the console driver that will serve as the backend for the virtual terminals. - See for more + See for more information. For framebuffer console users, please refer to . diff --git a/drivers/vfio/Kconfig b/drivers/vfio/Kconfig index 5d6151392571..fd17db9b432f 100644 --- a/drivers/vfio/Kconfig +++ b/drivers/vfio/Kconfig @@ -25,7 +25,7 @@ menuconfig VFIO select VFIO_IOMMU_TYPE1 if (X86 || S390 || ARM || ARM64) help VFIO provides a framework for secure userspace device drivers. - See Documentation/vfio.rst for more details. + See Documentation/driver-api/vfio.rst for more details. If you don't know what to do here, say N. diff --git a/drivers/vfio/mdev/Kconfig b/drivers/vfio/mdev/Kconfig index 10ec404acbfc..5da27f2100f9 100644 --- a/drivers/vfio/mdev/Kconfig +++ b/drivers/vfio/mdev/Kconfig @@ -6,7 +6,7 @@ config VFIO_MDEV default n help Provides a framework to virtualize devices. - See Documentation/vfio-mediated-device.rst for more details. + See Documentation/driver-api/vfio-mediated-device.rst for more details. If you don't know what do here, say N. diff --git a/drivers/w1/Kconfig b/drivers/w1/Kconfig index 160053c0baea..3e7ad7b232fe 100644 --- a/drivers/w1/Kconfig +++ b/drivers/w1/Kconfig @@ -19,7 +19,7 @@ config W1_CON default y ---help--- This allows to communicate with userspace using connector. For more - information see . + information see . There are three types of messages between w1 core and userspace: 1. Events. They are generated each time new master or slave device found either due to automatic or requested search. diff --git a/include/asm-generic/bitops/atomic.h b/include/asm-generic/bitops/atomic.h index 6ee11717bb65..0afe930eec72 100644 --- a/include/asm-generic/bitops/atomic.h +++ b/include/asm-generic/bitops/atomic.h @@ -8,7 +8,7 @@ /* * Implementation of atomic bitops using atomic-fetch ops. - * See Documentation/atomic_bitops.rst for details. + * See Documentation/driver-api/atomic_bitops.rst for details. */ static inline void set_bit(unsigned int nr, volatile unsigned long *p) diff --git a/include/linux/io-mapping.h b/include/linux/io-mapping.h index b90c540696a4..c8bf4852b352 100644 --- a/include/linux/io-mapping.h +++ b/include/linux/io-mapping.h @@ -28,7 +28,7 @@ * The io_mapping mechanism provides an abstraction for mapping * individual pages from an io device to the CPU in an efficient fashion. * - * See Documentation/io-mapping.rst + * See Documentation/driver-api/io-mapping.rst */ struct io_mapping { diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h index c3947cab2d27..32bdce895487 100644 --- a/include/linux/jump_label.h +++ b/include/linux/jump_label.h @@ -68,7 +68,7 @@ * Lacking toolchain and or architecture support, static keys fall back to a * simple conditional branch. * - * Additional babbling in: Documentation/static-keys.rst + * Additional babbling in: Documentation/driver-api/static-keys.rst */ #ifndef __ASSEMBLY__ diff --git a/include/linux/kobject.h b/include/linux/kobject.h index 16f66fe28ec2..d32720743004 100644 --- a/include/linux/kobject.h +++ b/include/linux/kobject.h @@ -7,7 +7,7 @@ * Copyright (c) 2006-2008 Greg Kroah-Hartman * Copyright (c) 2006-2008 Novell Inc. * - * Please read Documentation/kobject.rst before using the kobject + * Please read Documentation/driver-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */ diff --git a/include/linux/kobject_ns.h b/include/linux/kobject_ns.h index 8c86c4641739..b5b7d387d63d 100644 --- a/include/linux/kobject_ns.h +++ b/include/linux/kobject_ns.h @@ -8,7 +8,7 @@ * * Split from kobject.h by David Howells (dhowells@redhat.com) * - * Please read Documentation/kobject.rst before using the kobject + * Please read Documentation/driver-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */ diff --git a/include/linux/rbtree.h b/include/linux/rbtree.h index 2c579b6000a5..d49f78a8be37 100644 --- a/include/linux/rbtree.h +++ b/include/linux/rbtree.h @@ -11,7 +11,7 @@ I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... - See Documentation/rbtree.rst for documentation and samples. + See Documentation/driver-api/rbtree.rst for documentation and samples. */ #ifndef _LINUX_RBTREE_H diff --git a/include/linux/rbtree_augmented.h b/include/linux/rbtree_augmented.h index b3f64a2935ae..5f31af0da0a9 100644 --- a/include/linux/rbtree_augmented.h +++ b/include/linux/rbtree_augmented.h @@ -21,7 +21,7 @@ * rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * - * See Documentation/rbtree.rst for documentation and samples. + * See Documentation/driver-api/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks { diff --git a/init/Kconfig b/init/Kconfig index e02cfae73ce5..b9cfef1452e3 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -1807,7 +1807,7 @@ config MMAP_ALLOW_UNINITIALIZED userspace. Since that isn't generally a problem on no-MMU systems, it is normally safe to say Y here. - See Documentation/nommu-mmap.rst for more information. + See Documentation/driver-api/nommu-mmap.rst for more information. config SYSTEM_DATA_VERIFICATION def_bool n diff --git a/kernel/padata.c b/kernel/padata.c index a567973bb1ba..fa3fb3b4705e 100644 --- a/kernel/padata.c +++ b/kernel/padata.c @@ -2,7 +2,7 @@ /* * padata.c - generic interface to process data streams in parallel * - * See Documentation/padata.rst for an api documentation. + * See Documentation/driver-api/padata.rst for an api documentation. * * Copyright (C) 2008, 2009 secunet Security Networks AG * Copyright (C) 2008, 2009 Steffen Klassert diff --git a/lib/Kconfig b/lib/Kconfig index 58e9dae6f424..f4785afbfd10 100644 --- a/lib/Kconfig +++ b/lib/Kconfig @@ -420,7 +420,7 @@ config INTERVAL_TREE See: - Documentation/rbtree.rst + Documentation/driver-api/rbtree.rst for more information. diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index ce47efa5f4e4..47072d67fca1 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -1682,7 +1682,7 @@ config PROVIDE_OHCI1394_DMA_INIT This code (~1k) is freed after boot. By then, the firewire stack in charge of the OHCI-1394 controllers should be used instead. - See Documentation/debugging-via-ohci1394.rst for more information. + See Documentation/driver-api/debugging-via-ohci1394.rst for more information. menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing" diff --git a/lib/crc32.c b/lib/crc32.c index 0de37ccc70dd..78d4cd8b709e 100644 --- a/lib/crc32.c +++ b/lib/crc32.c @@ -24,7 +24,7 @@ * Version 2. See the file COPYING for more details. */ -/* see: Documentation/crc32.rst for a description of algorithms */ +/* see: Documentation/driver-api/crc32.rst for a description of algorithms */ #include #include diff --git a/lib/kobject.c b/lib/kobject.c index 03157ff88495..fe01ed0504e2 100644 --- a/lib/kobject.c +++ b/lib/kobject.c @@ -6,7 +6,7 @@ * Copyright (c) 2006-2007 Greg Kroah-Hartman * Copyright (c) 2006-2007 Novell Inc. * - * Please see the file Documentation/kobject.rst for critical information + * Please see the file Documentation/driver-api/kobject.rst for critical information * about using the kobject interface. */ @@ -668,7 +668,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.rst.\n", + pr_debug("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/driver-api/kobject.rst.\n", kobject_name(kobj), kobj); /* send "remove" if the caller did not do it but sent "add" */ diff --git a/lib/lzo/lzo1x_decompress_safe.c b/lib/lzo/lzo1x_decompress_safe.c index 1642c28e6627..27401806c355 100644 --- a/lib/lzo/lzo1x_decompress_safe.c +++ b/lib/lzo/lzo1x_decompress_safe.c @@ -32,7 +32,7 @@ * depending on the base count. Since the base count is taken from a u8 * and a few bits, it is safe to assume that it will always be lower than * or equal to 2*255, thus we can always prevent any overflow by accepting - * two less 255 steps. See Documentation/lzo.rst for more information. + * two less 255 steps. See Documentation/driver-api/lzo.rst for more information. */ #define MAX_255_COUNT ((((size_t)~0) / 255) - 2) diff --git a/lib/xz/Kconfig b/lib/xz/Kconfig index 314a89c13545..9d8a66fdea9b 100644 --- a/lib/xz/Kconfig +++ b/lib/xz/Kconfig @@ -5,7 +5,7 @@ config XZ_DEC help LZMA2 compression algorithm and BCJ filters are supported using the .xz file format as the container. For integrity checking, - CRC32 is supported. See Documentation/xz.rst for more information. + CRC32 is supported. See Documentation/driver-api/xz.rst for more information. if XZ_DEC diff --git a/mm/Kconfig b/mm/Kconfig index ed5fe68590f4..9a0bbbeafb58 100644 --- a/mm/Kconfig +++ b/mm/Kconfig @@ -369,7 +369,7 @@ config NOMMU_INITIAL_TRIM_EXCESS This option specifies the initial value of this option. The default of 1 says that all excess pages should be trimmed. - See Documentation/nommu-mmap.rst for more information. + See Documentation/driver-api/nommu-mmap.rst for more information. config TRANSPARENT_HUGEPAGE bool "Transparent Hugepage Support" diff --git a/mm/nommu.c b/mm/nommu.c index 30a071ba838d..d44944512f07 100644 --- a/mm/nommu.c +++ b/mm/nommu.c @@ -5,7 +5,7 @@ * Replacement code for mm functions to support CPU's that don't * have any form of memory management unit (thus no virtual memory). * - * See Documentation/nommu-mmap.rst + * See Documentation/driver-api/nommu-mmap.rst * * Copyright (c) 2004-2008 David Howells * Copyright (c) 2000-2003 David McCullough diff --git a/samples/Kconfig b/samples/Kconfig index 9ec524b2e003..2b1b4d241e47 100644 --- a/samples/Kconfig +++ b/samples/Kconfig @@ -100,7 +100,7 @@ config SAMPLE_CONNECTOR When enabled, this builds both a sample kernel module for the connector interface and a user space tool to communicate with it. - See also Documentation/connector/connector.rst + See also Documentation/driver-api/connector.rst config SAMPLE_SECCOMP bool "Build seccomp sample code" diff --git a/samples/kprobes/kprobe_example.c b/samples/kprobes/kprobe_example.c index d76fd05304a5..1928cef27fd1 100644 --- a/samples/kprobes/kprobe_example.c +++ b/samples/kprobes/kprobe_example.c @@ -5,7 +5,7 @@ * stack trace and selected registers when _do_fork() is called. * * For more information on theory of operation of kprobes, see - * Documentation/kprobes.rst + * Documentation/driver-api/kprobes.rst * * You will see the trace data in /var/log/messages and on the console * whenever _do_fork() is invoked to create a new process. diff --git a/samples/kprobes/kretprobe_example.c b/samples/kprobes/kretprobe_example.c index 9a2234ae0286..d007feaa92d4 100644 --- a/samples/kprobes/kretprobe_example.c +++ b/samples/kprobes/kretprobe_example.c @@ -11,7 +11,7 @@ * If no func_name is specified, _do_fork is instrumented * * For more information on theory of operation of kretprobes, see - * Documentation/kprobes.rst + * Documentation/driver-api/kprobes.rst * * Build and insert the kernel module as done in the kprobe example. * You will see the trace data in /var/log/messages and on the console diff --git a/scripts/gcc-plugins/Kconfig b/scripts/gcc-plugins/Kconfig index b4dc5b116bfe..4a568069728d 100644 --- a/scripts/gcc-plugins/Kconfig +++ b/scripts/gcc-plugins/Kconfig @@ -23,7 +23,7 @@ config GCC_PLUGINS GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis. - See Documentation/gcc-plugins.rst for details. + See Documentation/driver-api/gcc-plugins.rst for details. menu "GCC plugins" depends on GCC_PLUGINS diff --git a/tools/include/linux/rbtree.h b/tools/include/linux/rbtree.h index e96d7120ce2b..0a36c807f65d 100644 --- a/tools/include/linux/rbtree.h +++ b/tools/include/linux/rbtree.h @@ -11,7 +11,7 @@ I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... - See Documentation/rbtree.rst for documentation and samples. + See Documentation/driver-api/rbtree.rst for documentation and samples. */ #ifndef __TOOLS_LINUX_PERF_RBTREE_H diff --git a/tools/include/linux/rbtree_augmented.h b/tools/include/linux/rbtree_augmented.h index c251bb16f2e9..201a873c2111 100644 --- a/tools/include/linux/rbtree_augmented.h +++ b/tools/include/linux/rbtree_augmented.h @@ -23,7 +23,7 @@ * rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * - * See Documentation/rbtree.rst for documentation and samples. + * See Documentation/driver-api/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks {