From patchwork Fri Jun 28 12:30:21 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: 11022281 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 695C9924 for ; Fri, 28 Jun 2019 12:31:44 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 58A2E28783 for ; Fri, 28 Jun 2019 12:31:44 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4C4B3287EF; Fri, 28 Jun 2019 12:31:44 +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 DB0E128783 for ; Fri, 28 Jun 2019 12:31:42 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 27B636E91C; Fri, 28 Jun 2019 12:31:42 +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 CD9D26E91C for ; Fri, 28 Jun 2019 12:31:40 +0000 (UTC) Received: from [186.213.242.156] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hgq1U-00055h-OB; Fri, 28 Jun 2019 12:30:37 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hgq1S-0005TB-Lz; Fri, 28 Jun 2019 09:30:34 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Date: Fri, 28 Jun 2019 09:30:21 -0300 Message-Id: <7ee0e33575633f689203f582259c2cbdce477176.1561724493.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: 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=t2SlvlYO6vN68ooBWcFQh21aLIzOtka8Klr/M76soBU=; b=GPcFupf5dzfyT165XdM5l7atm7 NpunVR4RVyW430xRFKelq2/bs7dtPeXB4qL/NAe4wUu90z3hkDS/UIfIGdcLRgNR2UNHiStAIHDWk b5ipZ/rh5zP1MANqlxnbENYD/fVy7fINuTz8hI/7Xxd5uRjSAc/v12+G6v77fOA6pvH51AXLu2qLr m1H6iZl3askKHReK+jify63bqpxZ2aZmSjKnEi33cR7epWYwKUNyxM6iw0XhbwlMf1Q1R8eIlnGAY g2vrko1I5YdrDNVcbwUdqvarlbeC++auL6Ldh/LGX2VSxCdN+UgvNr4MOiHvRW17Y0Xbs+VJlMxkY FFszEwYQ==; 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: Alexandre Belloni , Rich Felker , Mike Snitzer , linux-sh@vger.kernel.org, "Richard Russon \(FlatCap\)" , linux-fbdev@vger.kernel.org, dri-devel@lists.freedesktop.org, "James E.J. Bottomley" , sparclinux@vger.kernel.org, dm-devel@redhat.com, linux-efi@vger.kernel.org, Willy Tarreau , "H. Peter Anvin" , Mauro Carvalho Chehab , Alasdair Kergon , linux-rtc@vger.kernel.org, Herbert Xu , Ksenija Stanojevic , Jonathan Corbet , Helge Deller , x86@kernel.org, Russell King , Ingo Molnar , Arnd Bergmann , Bartlomiej Zolnierkiewicz , Mauro Carvalho Chehab , linux-block@vger.kernel.org, Borislav Petkov , Matt Mackall , Thomas Gleixner , linux-arm-kernel@lists.infradead.org, Jens Axboe , Alessandro Zummo , Yoshinori Sato , linux-parisc@vger.kernel.org, Ard Biesheuvel , linux-ntfs-dev@lists.sourceforge.net, Greg Kroah-Hartman , linux-kernel@vger.kernel.org, Martin Mares , linux-crypto@vger.kernel.org, linux-video@atrey.karlin.mff.cuni.cz, "David S. Miller" Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP There are lots of documents that belong to the admin-guide but are on random places (most under Documentation root dir). Move them to the admin guide. Signed-off-by: Mauro Carvalho Chehab Acked-by: Bartlomiej Zolnierkiewicz --- 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 ++-- .../{btmrvl.txt => admin-guide/btmrvl.rst} | 0 .../clearing-warn-once.rst} | 0 .../{cpu-load.txt => admin-guide/cpu-load.rst} | 0 .../cputopology.rst} | 0 .../admin-guide/device-mapper/statistics.rst | 4 ++-- .../{efi-stub.txt => admin-guide/efi-stub.rst} | 0 .../{highuid.txt => admin-guide/highuid.rst} | 0 Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- .../hw_random.rst} | 0 Documentation/admin-guide/index.rst | 17 +++++++++++++++++ .../{iostats.txt => admin-guide/iostats.rst} | 0 Documentation/admin-guide/kernel-parameters.txt | 2 +- .../kernel-per-CPU-kthreads.rst} | 0 .../lcd-panel-cgram.rst | 2 -- Documentation/{ldm.txt => admin-guide/ldm.rst} | 0 .../lockup-watchdogs.rst} | 0 .../mm/cma_debugfs.rst} | 2 -- Documentation/admin-guide/mm/index.rst | 1 + .../{numastat.txt => admin-guide/numastat.rst} | 0 Documentation/{pnp.txt => admin-guide/pnp.rst} | 0 Documentation/{rtc.txt => admin-guide/rtc.rst} | 0 .../{svga.txt => admin-guide/svga.rst} | 0 Documentation/admin-guide/sysctl/kernel.rst | 2 +- .../video-output.rst} | 0 Documentation/fb/vesafb.rst | 2 +- Documentation/x86/topology.rst | 2 +- MAINTAINERS | 12 ++++++------ arch/arm/Kconfig | 2 +- arch/parisc/Kconfig | 2 +- arch/sh/Kconfig | 2 +- arch/sparc/Kconfig | 2 +- arch/x86/Kconfig | 4 ++-- block/partitions/Kconfig | 2 +- drivers/char/Kconfig | 4 ++-- drivers/char/hw_random/core.c | 2 +- include/linux/hw_random.h | 2 +- 40 files changed, 47 insertions(+), 33 deletions(-) rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%) rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%) rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%) rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%) rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%) rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%) rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%) rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%) rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (100%) rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%) rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%) rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%) rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%) rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%) rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%) rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%) rename Documentation/{svga.txt => admin-guide/svga.rst} (100%) rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index f7ce68fbd4b9..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.txt + 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 abac31d216de..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.txt + 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 dfad7427817c..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.txt + 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 d404603c6b52..5f7d7b14fa44 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/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.txt for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/cpuidle/current_driver diff --git a/Documentation/btmrvl.txt b/Documentation/admin-guide/btmrvl.rst similarity index 100% rename from Documentation/btmrvl.txt rename to Documentation/admin-guide/btmrvl.rst diff --git a/Documentation/clearing-warn-once.txt b/Documentation/admin-guide/clearing-warn-once.rst similarity index 100% rename from Documentation/clearing-warn-once.txt rename to Documentation/admin-guide/clearing-warn-once.rst diff --git a/Documentation/cpu-load.txt b/Documentation/admin-guide/cpu-load.rst similarity index 100% rename from Documentation/cpu-load.txt rename to Documentation/admin-guide/cpu-load.rst diff --git a/Documentation/cputopology.txt b/Documentation/admin-guide/cputopology.rst similarity index 100% rename from Documentation/cputopology.txt rename to Documentation/admin-guide/cputopology.rst diff --git a/Documentation/admin-guide/device-mapper/statistics.rst b/Documentation/admin-guide/device-mapper/statistics.rst index 3d80a9f850cc..41ded0bc5933 100644 --- a/Documentation/admin-guide/device-mapper/statistics.rst +++ b/Documentation/admin-guide/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/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.txt 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/efi-stub.txt b/Documentation/admin-guide/efi-stub.rst similarity index 100% rename from Documentation/efi-stub.txt rename to Documentation/admin-guide/efi-stub.rst diff --git a/Documentation/highuid.txt b/Documentation/admin-guide/highuid.rst similarity index 100% rename from Documentation/highuid.txt rename to Documentation/admin-guide/highuid.rst diff --git a/Documentation/admin-guide/hw-vuln/l1tf.rst b/Documentation/admin-guide/hw-vuln/l1tf.rst index 656aee262e23..f83212fae4d5 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.txt b/Documentation/admin-guide/hw_random.rst similarity index 100% rename from Documentation/hw_random.txt rename to Documentation/admin-guide/hw_random.rst diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index d5064f1802c1..2c20607e90cd 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -84,8 +84,25 @@ configure specific aspects of kernel behavior to your liking. perf-security acpi/index aoe/index + btmrvl + clearing-warn-once + cpu-load + cputopology device-mapper/index + efi-stub + highuid + hw_random + iostats + kernel-per-CPU-kthreads laptops/index + lcd-panel-cgram + ldm + lockup-watchdogs + numastat + pnp + rtc + svga + video-output .. only:: subproject and html diff --git a/Documentation/iostats.txt b/Documentation/admin-guide/iostats.rst similarity index 100% rename from Documentation/iostats.txt rename to Documentation/admin-guide/iostats.rst diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index e833133c8897..713d6f378fbe 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -5092,7 +5092,7 @@ vga= [BOOT,X86-32] Select a particular video mode See Documentation/x86/boot.rst and - Documentation/svga.txt. + 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.txt b/Documentation/admin-guide/kernel-per-CPU-kthreads.rst similarity index 100% rename from Documentation/kernel-per-CPU-kthreads.txt rename to Documentation/admin-guide/kernel-per-CPU-kthreads.rst 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.txt b/Documentation/admin-guide/ldm.rst similarity index 100% rename from Documentation/ldm.txt rename to Documentation/admin-guide/ldm.rst diff --git a/Documentation/lockup-watchdogs.txt b/Documentation/admin-guide/lockup-watchdogs.rst similarity index 100% rename from Documentation/lockup-watchdogs.txt rename to Documentation/admin-guide/lockup-watchdogs.rst 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/index.rst b/Documentation/admin-guide/mm/index.rst index 5f61a6c429e0..11db46448354 100644 --- a/Documentation/admin-guide/mm/index.rst +++ b/Documentation/admin-guide/mm/index.rst @@ -26,6 +26,7 @@ the Linux memory management. :maxdepth: 1 concepts + cma_debugfs hugetlbpage idle_page_tracking ksm diff --git a/Documentation/numastat.txt b/Documentation/admin-guide/numastat.rst similarity index 100% rename from Documentation/numastat.txt rename to Documentation/admin-guide/numastat.rst diff --git a/Documentation/pnp.txt b/Documentation/admin-guide/pnp.rst similarity index 100% rename from Documentation/pnp.txt rename to Documentation/admin-guide/pnp.rst diff --git a/Documentation/rtc.txt b/Documentation/admin-guide/rtc.rst similarity index 100% rename from Documentation/rtc.txt rename to Documentation/admin-guide/rtc.rst diff --git a/Documentation/svga.txt b/Documentation/admin-guide/svga.rst similarity index 100% rename from Documentation/svga.txt rename to Documentation/admin-guide/svga.rst diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst index a0c1d4ce403a..032c7cd3cede 100644 --- a/Documentation/admin-guide/sysctl/kernel.rst +++ b/Documentation/admin-guide/sysctl/kernel.rst @@ -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/admin-guide/lockup-watchdogs.rst for more information. This can also be set using the nmi_watchdog kernel parameter. diff --git a/Documentation/video-output.txt b/Documentation/admin-guide/video-output.rst similarity index 100% rename from Documentation/video-output.txt rename to Documentation/admin-guide/video-output.rst diff --git a/Documentation/fb/vesafb.rst b/Documentation/fb/vesafb.rst index 2ed0dfb661cf..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.txt 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/x86/topology.rst b/Documentation/x86/topology.rst index 8e9704f61017..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.txt. 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/MAINTAINERS b/MAINTAINERS index 82222aa618c5..76b52a20663e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -6054,7 +6054,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/admin-guide/efi-stub.rst F: arch/*/kernel/efi.c F: arch/x86/boot/compressed/eboot.[ch] F: arch/*/include/asm/efi.h @@ -7033,7 +7033,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/admin-guide/hw_random.rst F: drivers/char/hw_random/ F: include/linux/hw_random.h @@ -9347,7 +9347,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/admin-guide/ldm.rst F: block/partitions/ldm.* LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI) @@ -12000,7 +12000,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 @@ -13419,7 +13419,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/admin-guide/rtc.rst F: drivers/rtc/ F: include/linux/rtc.h F: include/uapi/linux/rtc.h @@ -15248,7 +15248,7 @@ SVGA HANDLING M: Martin Mares L: linux-video@atrey.karlin.mff.cuni.cz S: Maintained -F: Documentation/svga.txt +F: Documentation/admin-guide/svga.rst F: arch/x86/boot/video* SWIOTLB SUBSYSTEM diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig index d5bd4350fcbd..b1ab350b9d60 100644 --- a/arch/arm/Kconfig +++ b/arch/arm/Kconfig @@ -1286,7 +1286,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 42875ff15671..6d732e451071 100644 --- a/arch/parisc/Kconfig +++ b/arch/parisc/Kconfig @@ -277,7 +277,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 c2858ac6a46a..6b1b5941b618 100644 --- a/arch/sh/Kconfig +++ b/arch/sh/Kconfig @@ -679,7 +679,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 e9f5d62e9817..7926a2e11bdc 100644 --- a/arch/sparc/Kconfig +++ b/arch/sparc/Kconfig @@ -180,7 +180,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 489fd833b980..2ca471ae6756 100644 --- a/arch/x86/Kconfig +++ b/arch/x86/Kconfig @@ -402,7 +402,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. @@ -1959,7 +1959,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/admin-guide/efi-stub.rst for more information. config EFI_MIXED bool "EFI mixed-mode support" diff --git a/block/partitions/Kconfig b/block/partitions/Kconfig index 37b9710cc80a..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 442403abd73a..3e866885a405 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..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.txt 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/hw_random.h b/include/linux/hw_random.h index c0b93e0ff0c0..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.txt 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 From patchwork Fri Jun 28 12:30:22 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: 11022269 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 0CC78924 for ; Fri, 28 Jun 2019 12:31:37 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id EF3A928782 for ; Fri, 28 Jun 2019 12:31:36 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id E2D95287F2; Fri, 28 Jun 2019 12:31:36 +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 F248128782 for ; Fri, 28 Jun 2019 12:31:33 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id F27EF6E919; Fri, 28 Jun 2019 12:31:32 +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 C51D56E919 for ; Fri, 28 Jun 2019 12:31:31 +0000 (UTC) Received: from [186.213.242.156] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hgq1U-00055q-Os; Fri, 28 Jun 2019 12:30:37 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hgq1S-0005TF-Mz; Fri, 28 Jun 2019 09:30:34 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH 29/39] docs: driver-api: add a series of orphaned documents Date: Fri, 28 Jun 2019 09:30:22 -0300 Message-Id: <8ac86487399c5cfa180f3d6dad5de944a40c3520.1561724493.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: 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=rvTdQlpn8lGG+XUWnSR+mtd4lHpPxHbkHHRJa35+NkE=; b=WrG4mJUVZFYoLrANkgfTc0lcVh KSMI5GCzuHqio29G7t3/rDKxO/l/kokSVXrrbJFOuDjked5pAX5/xT58qBezzIFLEoX9gvt5OFven htvtxSX3Z7fpPocErec0zMJAXAQsLpAhuhHBvg1SuaB+OkAXvB7rS23awKtZihuzYxw90vNqRS4C4 H/jCQ1Ew6AJNY5FvH4v1DB9Ig+g+G0JvX9X/0zW8GjV4h8U2pRi1mcHTC+mK1M/Vqm+04nOgPVjwB pZLjiurOZzn/oyyDtB45x6XUugpUIuvDUjAAI6PzVxM5ASxRN6qdTN+lNtKNhgH0uL+pMGaLSFeUK ZzpKpBwA==; 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, Maxime Ripard , Farhan Ali , Heiko Carstens , dri-devel@lists.freedesktop.org, Jaroslav Kysela , Kirti Wankhede , Thierry Reding , Manivannan Sadhasivam , Mauro Carvalho Chehab , Evgeniy Polyakov , linux-s390@vger.kernel.org, Jonathan Corbet , "Rafael J. Wysocki" , Halil Pasic , Christian Borntraeger , Jiri Slaby , Darren Hart , linux-pwm@vger.kernel.org, Eric Farman , Vasily Gorbik , Bartlomiej Zolnierkiewicz , David Airlie , William Breathitt Gray , Mauro Carvalho Chehab , linaro-mm-sig@lists.linaro.org, linux-gpio@vger.kernel.org, Alex Williamson , Bjorn Helgaas , Kurt Schwemmer , platform-driver-x86@vger.kernel.org, Sean Paul , linux-arm-kernel@lists.infradead.org, Johannes Thumshirn , linux-pci@vger.kernel.org, Greg Kroah-Hartman , Cornelia Huck , linux-wireless@vger.kernel.org, linux-kernel@vger.kernel.org, =?utf-8?q?Andreas_F=C3=A4rber?= , Stuart Hayes , Bartosz Golaszewski , Johannes Berg , Logan Gunthorpe , Sudip Mukherjee , Andy Shevchenko Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP There are lots of documents under Documentation/*.txt and a few other orphan documents elsehwere that belong to the driver-API book. Move them to their right place. Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Cornelia Huck [vfio-related parts] --- Documentation/ABI/removed/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-class-rfkill | 2 +- .../ABI/testing/sysfs-class-switchtec | 2 +- .../admin-guide/kernel-parameters.txt | 2 +- .../admin-guide/laptops/thinkpad-acpi.rst | 6 ++--- .../bt8xxgpio.rst} | 0 .../{connector => driver-api}/connector.rst | 2 +- .../{console => driver-api}/console.rst | 2 +- .../{dcdbas.txt => driver-api/dcdbas.rst} | 0 .../{dell_rbu.txt => driver-api/dell_rbu.rst} | 0 .../{EDID/howto.rst => driver-api/edid.rst} | 2 +- .../{eisa.txt => driver-api/eisa.rst} | 0 Documentation/driver-api/index.rst | 26 +++++++++++++++++++ Documentation/{isa.txt => driver-api/isa.rst} | 0 .../{isapnp.txt => driver-api/isapnp.rst} | 0 .../pblk.txt => driver-api/lightnvm-pblk.rst} | 0 .../men-chameleon-bus.rst} | 0 Documentation/{ntb.txt => driver-api/ntb.rst} | 0 Documentation/{nvmem => driver-api}/nvmem.rst | 2 +- .../parport-lowlevel.rst} | 0 .../{pti => driver-api}/pti_intel_mid.rst | 2 +- Documentation/{pwm.txt => driver-api/pwm.rst} | 0 .../{rfkill.txt => driver-api/rfkill.rst} | 0 .../{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} | 0 .../{SM501.txt => driver-api/sm501.rst} | 0 .../smsc_ece1099.rst} | 0 .../switchtec.rst} | 2 +- .../sync_file.rst} | 0 .../vfio-mediated-device.rst} | 2 +- .../{vfio.txt => driver-api/vfio.rst} | 0 .../{xillybus.txt => driver-api/xillybus.rst} | 0 .../{zorro.txt => driver-api/zorro.rst} | 0 Documentation/fb/fbcon.rst | 4 +-- Documentation/s390/vfio-ccw.rst | 6 ++--- Documentation/w1/w1.netlink | 2 +- MAINTAINERS | 22 ++++++++-------- Next/merge.log | 4 +-- 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 +- samples/Kconfig | 2 +- 50 files changed, 73 insertions(+), 47 deletions(-) rename Documentation/{bt8xxgpio.txt => driver-api/bt8xxgpio.rst} (100%) rename Documentation/{connector => driver-api}/connector.rst (99%) rename Documentation/{console => driver-api}/console.rst (99%) rename Documentation/{dcdbas.txt => driver-api/dcdbas.rst} (100%) rename Documentation/{dell_rbu.txt => driver-api/dell_rbu.rst} (100%) rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (98%) rename Documentation/{eisa.txt => driver-api/eisa.rst} (100%) rename Documentation/{isa.txt => driver-api/isa.rst} (100%) rename Documentation/{isapnp.txt => driver-api/isapnp.rst} (100%) rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%) rename Documentation/{men-chameleon-bus.txt => driver-api/men-chameleon-bus.rst} (100%) rename Documentation/{ntb.txt => driver-api/ntb.rst} (100%) rename Documentation/{nvmem => driver-api}/nvmem.rst (99%) rename Documentation/{parport-lowlevel.txt => driver-api/parport-lowlevel.rst} (100%) rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%) rename Documentation/{pwm.txt => driver-api/pwm.rst} (100%) rename Documentation/{rfkill.txt => driver-api/rfkill.rst} (100%) rename Documentation/{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} (100%) rename Documentation/{SM501.txt => driver-api/sm501.rst} (100%) rename Documentation/{smsc_ece1099.txt => driver-api/smsc_ece1099.rst} (100%) rename Documentation/{switchtec.txt => driver-api/switchtec.rst} (97%) rename Documentation/{sync_file.txt => driver-api/sync_file.rst} (100%) rename Documentation/{vfio-mediated-device.txt => driver-api/vfio-mediated-device.rst} (99%) rename Documentation/{vfio.txt => driver-api/vfio.rst} (100%) rename Documentation/{xillybus.txt => driver-api/xillybus.rst} (100%) rename Documentation/{zorro.txt => driver-api/zorro.rst} (100%) diff --git a/Documentation/ABI/removed/sysfs-class-rfkill b/Documentation/ABI/removed/sysfs-class-rfkill index 3ce6231f20b2..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.txt. +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 80151a409d67..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.txt. +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 48cb4c15e430..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.txt. +For details on this subsystem look at Documentation/driver-api/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017 diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index 713d6f378fbe..de1c40167a26 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 diff --git a/Documentation/admin-guide/laptops/thinkpad-acpi.rst b/Documentation/admin-guide/laptops/thinkpad-acpi.rst index 19d52fc3c5e9..adea0bf2acc5 100644 --- a/Documentation/admin-guide/laptops/thinkpad-acpi.rst +++ b/Documentation/admin-guide/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/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.txt 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.txt for details. + Documentation/driver-api/rfkill.rst for details. Adaptive keyboard ----------------- diff --git a/Documentation/bt8xxgpio.txt b/Documentation/driver-api/bt8xxgpio.rst similarity index 100% rename from Documentation/bt8xxgpio.txt rename to Documentation/driver-api/bt8xxgpio.rst 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..c100c7482289 100644 --- a/Documentation/connector/connector.rst +++ b/Documentation/driver-api/connector.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================ 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..8394ad7747ac 100644 --- a/Documentation/console/console.rst +++ b/Documentation/driver-api/console.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============== Console Drivers diff --git a/Documentation/dcdbas.txt b/Documentation/driver-api/dcdbas.rst similarity index 100% rename from Documentation/dcdbas.txt rename to Documentation/driver-api/dcdbas.rst diff --git a/Documentation/dell_rbu.txt b/Documentation/driver-api/dell_rbu.rst similarity index 100% rename from Documentation/dell_rbu.txt rename to Documentation/driver-api/dell_rbu.rst diff --git a/Documentation/EDID/howto.rst b/Documentation/driver-api/edid.rst similarity index 98% rename from Documentation/EDID/howto.rst rename to Documentation/driver-api/edid.rst index 725fd49a88ca..b1b5acd501ed 100644 --- a/Documentation/EDID/howto.rst +++ b/Documentation/driver-api/edid.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ==== EDID diff --git a/Documentation/eisa.txt b/Documentation/driver-api/eisa.rst similarity index 100% rename from Documentation/eisa.txt rename to Documentation/driver-api/eisa.rst diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index 93d187bf4853..bba01cb95162 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -68,7 +68,33 @@ available subsections can be seen below. fpga/index acpi/index backlight/lp855x-driver.rst + bt8xxgpio + connector + console + dcdbas + dell_rbu + edid + eisa + isa + isapnp generic-counter + lightnvm-pblk + men-chameleon-bus + ntb + nvmem + parport-lowlevel + pti_intel_mid + pwm + rfkill + sgi-ioc4 + sm501 + smsc_ece1099 + switchtec + sync_file + vfio-mediated-device + vfio + xillybus + zorro .. only:: subproject and html diff --git a/Documentation/isa.txt b/Documentation/driver-api/isa.rst similarity index 100% rename from Documentation/isa.txt rename to Documentation/driver-api/isa.rst diff --git a/Documentation/isapnp.txt b/Documentation/driver-api/isapnp.rst similarity index 100% rename from Documentation/isapnp.txt rename to Documentation/driver-api/isapnp.rst 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/men-chameleon-bus.txt b/Documentation/driver-api/men-chameleon-bus.rst similarity index 100% rename from Documentation/men-chameleon-bus.txt rename to Documentation/driver-api/men-chameleon-bus.rst diff --git a/Documentation/ntb.txt b/Documentation/driver-api/ntb.rst similarity index 100% rename from Documentation/ntb.txt rename to Documentation/driver-api/ntb.rst 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..d9d958d5c824 100644 --- a/Documentation/nvmem/nvmem.rst +++ b/Documentation/driver-api/nvmem.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============== NVMEM Subsystem diff --git a/Documentation/parport-lowlevel.txt b/Documentation/driver-api/parport-lowlevel.rst similarity index 100% rename from Documentation/parport-lowlevel.txt rename to Documentation/driver-api/parport-lowlevel.rst 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..20f1cff42d5f 100644 --- a/Documentation/pti/pti_intel_mid.rst +++ b/Documentation/driver-api/pti_intel_mid.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ============= Intel MID PTI diff --git a/Documentation/pwm.txt b/Documentation/driver-api/pwm.rst similarity index 100% rename from Documentation/pwm.txt rename to Documentation/driver-api/pwm.rst diff --git a/Documentation/rfkill.txt b/Documentation/driver-api/rfkill.rst similarity index 100% rename from Documentation/rfkill.txt rename to Documentation/driver-api/rfkill.rst diff --git a/Documentation/sgi-ioc4.txt b/Documentation/driver-api/sgi-ioc4.rst similarity index 100% rename from Documentation/sgi-ioc4.txt rename to Documentation/driver-api/sgi-ioc4.rst diff --git a/Documentation/SM501.txt b/Documentation/driver-api/sm501.rst similarity index 100% rename from Documentation/SM501.txt rename to Documentation/driver-api/sm501.rst diff --git a/Documentation/smsc_ece1099.txt b/Documentation/driver-api/smsc_ece1099.rst similarity index 100% rename from Documentation/smsc_ece1099.txt rename to Documentation/driver-api/smsc_ece1099.rst diff --git a/Documentation/switchtec.txt b/Documentation/driver-api/switchtec.rst similarity index 97% rename from Documentation/switchtec.txt rename to Documentation/driver-api/switchtec.rst index 30d6a64e53f7..7611fdc53e19 100644 --- a/Documentation/switchtec.txt +++ b/Documentation/driver-api/switchtec.rst @@ -97,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.txt 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.txt b/Documentation/driver-api/sync_file.rst similarity index 100% rename from Documentation/sync_file.txt rename to Documentation/driver-api/sync_file.rst diff --git a/Documentation/vfio-mediated-device.txt b/Documentation/driver-api/vfio-mediated-device.rst similarity index 99% rename from Documentation/vfio-mediated-device.txt rename to Documentation/driver-api/vfio-mediated-device.rst index c3f69bcaf96e..25eb7d5b834b 100644 --- a/Documentation/vfio-mediated-device.txt +++ b/Documentation/driver-api/vfio-mediated-device.rst @@ -408,7 +408,7 @@ card. References ========== -1. See Documentation/vfio.txt 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.txt b/Documentation/driver-api/vfio.rst similarity index 100% rename from Documentation/vfio.txt rename to Documentation/driver-api/vfio.rst diff --git a/Documentation/xillybus.txt b/Documentation/driver-api/xillybus.rst similarity index 100% rename from Documentation/xillybus.txt rename to Documentation/driver-api/xillybus.rst diff --git a/Documentation/zorro.txt b/Documentation/driver-api/zorro.rst similarity index 100% rename from Documentation/zorro.txt rename to Documentation/driver-api/zorro.rst diff --git a/Documentation/fb/fbcon.rst b/Documentation/fb/fbcon.rst index 26bc5cdaabab..ebca41785abe 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/s390/vfio-ccw.rst b/Documentation/s390/vfio-ccw.rst index 1f6d0b56d53e..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.txt +- 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.txt -6. Documentation/vfio-mediated-device.txt +5. Documentation/driver-api/vfio.rst +6. Documentation/driver-api/vfio-mediated-device.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/MAINTAINERS b/MAINTAINERS index 76b52a20663e..055db86fdd77 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4603,7 +4603,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/driver-api/dcdbas.rst F: drivers/platform/x86/dcdbas.* DELL WMI NOTIFICATIONS DRIVER @@ -8409,7 +8409,7 @@ F: drivers/irqchip/ ISA M: William Breathitt Gray S: Maintained -F: Documentation/isa.txt +F: Documentation/driver-api/isa.rst F: drivers/base/isa.c F: include/linux/isa.h @@ -8424,7 +8424,7 @@ F: drivers/media/radio/radio-isa* ISAPNP M: Jaroslav Kysela S: Maintained -F: Documentation/isapnp.txt +F: Documentation/driver-api/isapnp.rst F: drivers/pnp/isapnp/ F: include/linux/isapnp.h @@ -10309,7 +10309,7 @@ M: Johannes Thumshirn S: Maintained F: drivers/mcb/ F: include/linux/mcb.h -F: Documentation/men-chameleon-bus.txt +F: Documentation/driver-api/men-chameleon-bus.rst MEN F21BMC (Board Management Controller) M: Andreas Werner @@ -12012,7 +12012,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/driver-api/parport*.rst PARAVIRT_OPS INTERFACE M: Juergen Gross @@ -12187,7 +12187,7 @@ M: Kurt Schwemmer M: Logan Gunthorpe L: linux-pci@vger.kernel.org S: Maintained -F: Documentation/switchtec.txt +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 @@ -12949,7 +12949,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/driver-api/pwm.rst F: Documentation/devicetree/bindings/pwm/ F: include/linux/pwm.h F: drivers/pwm/ @@ -13568,7 +13568,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/driver-api/rfkill.rst F: Documentation/ABI/stable/sysfs-class-rfkill F: net/rfkill/ F: include/linux/rfkill.h @@ -15285,7 +15285,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/driver-api/sync_file.rst T: git git://anongit.freedesktop.org/drm/drm-misc SYNOPSYS ARC ARCHITECTURE @@ -16781,7 +16781,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/driver-api/vfio.rst F: drivers/vfio/ F: include/linux/vfio.h F: include/uapi/linux/vfio.h @@ -16790,7 +16790,7 @@ VFIO MEDIATED DEVICE DRIVERS M: Kirti Wankhede L: kvm@vger.kernel.org S: Maintained -F: Documentation/vfio-mediated-device.txt +F: Documentation/driver-api/vfio-mediated-device.rst F: drivers/vfio/mdev/ F: include/linux/mdev.h F: samples/vfio-mdev/ diff --git a/Next/merge.log b/Next/merge.log index 2cb0ee66fa51..e9f5123f59ca 100644 --- a/Next/merge.log +++ b/Next/merge.log @@ -13842,7 +13842,7 @@ Merge made by the 'recursive' strategy. .../devicetree/bindings/pwm/pwm-sifive.txt | 33 ++ .../devicetree/bindings/pwm/pwm-stm32-lp.txt | 9 +- .../devicetree/bindings/pwm/pwm-stm32.txt | 3 + - Documentation/pwm.txt | 7 + + Documentation/driver-api/pwm.rst | 7 + drivers/leds/leds-pwm.c | 45 ++- drivers/pwm/Kconfig | 11 + drivers/pwm/Makefile | 1 + @@ -14162,7 +14162,7 @@ Auto-merging drivers/ntb/hw/mscc/ntb_hw_switchtec.c Auto-merging drivers/ntb/Makefile Auto-merging drivers/ntb/Kconfig Merge made by the 'recursive' strategy. - Documentation/ntb.txt | 27 ++ + Documentation/driver-api/ntb.rst | 27 ++ drivers/ntb/Kconfig | 11 + drivers/ntb/Makefile | 3 + drivers/ntb/{ntb.c => core.c} | 0 diff --git a/drivers/dma-buf/Kconfig b/drivers/dma-buf/Kconfig index d5f915830b68..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.txt. + 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 c377c989000c..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.txt + Documentation/driver-api/bt8xxgpio.rst If unsure, say N. diff --git a/drivers/gpu/drm/Kconfig b/drivers/gpu/drm/Kconfig index ee01afbbcd90..503a907d5ae5 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 aee28a5bb98f..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 85101c678693..e09aa0087024 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..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.txt 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 a58fc10293ee..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.txt 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 4b58a3dcb52b..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 e5a7a454fe17..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.txt 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 ba94a076887f..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.txt 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/samples/Kconfig b/samples/Kconfig index 155da47dc6a4..c8dacb4dda80 100644 --- a/samples/Kconfig +++ b/samples/Kconfig @@ -99,7 +99,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_HIDRAW bool "hidraw sample" From patchwork Fri Jun 28 12:30:30 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: 11022259 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 0709476 for ; Fri, 28 Jun 2019 12:31:27 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id EBD6028782 for ; Fri, 28 Jun 2019 12:31:26 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id DD509287E5; Fri, 28 Jun 2019 12:31:26 +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 53EBB28782 for ; Fri, 28 Jun 2019 12:31:26 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 155406E918; Fri, 28 Jun 2019 12:31:24 +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 A14506E918 for ; Fri, 28 Jun 2019 12:31:22 +0000 (UTC) Received: from [186.213.242.156] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.92 #3 (Red Hat Linux)) id 1hgq1W-00054w-6k; Fri, 28 Jun 2019 12:30:38 +0000 Received: from mchehab by bombadil.infradead.org with local (Exim 4.92) (envelope-from ) id 1hgq1S-0005Tu-Ta; Fri, 28 Jun 2019 09:30:34 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH 37/39] docs: adds some directories to the main documentation index Date: Fri, 28 Jun 2019 09:30:30 -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=V/HBcP10AaKg9f7QXCB/xlHhS75hL4oliVjFK2WwiWw=; b=DJ/WCxxkcrYW8G3KYkrHJnkf2P jVRL0+UHsVSIf8VtGu+GJ+NK1gVs4f5L9BvDhdSkrkObRcuIcNwh2ckXwuFieia/rKgL36WvMuY9Z nT6Huh3yl0ut6x0Rf6Y6sz2cdaYXiy4rO0wROl5LruZdy9aIj8Om8dOt6vWBqldhQ8ZRGOC88ma64 OFQp1WxYj3pk+dzTAvSUbFUgAbYZl7CWLsPeAzeYBMiW0VyvKiQQYnT4iHs9pYsGgFzLfwMG6XVwm MePcBZkCo2f+oz0eiS7lY82L4KICcgRa9NnZD/K3rytV4FuomrWxv11teHb5arzgZjfDBfeN8hU6i gjFHMc4Q==; 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, Len Brown , linux-fpga@vger.kernel.org, Dominik Brodowski , Masahiro Yamada , target-devel@vger.kernel.org, Pavel Machek , Mauro Carvalho Chehab , live-patching@vger.kernel.org, Miroslav Benes , Joe Lawrence , Paul Moore , linux-scsi@vger.kernel.org, Jonathan Corbet , linux-kbuild@vger.kernel.org, Guenter Roeck , Petr Mladek , linux-watchdog@vger.kernel.org, Bartlomiej Zolnierkiewicz , Jiri Kosina , Akinobu Mita , Mauro Carvalho Chehab , Moritz Fischer , dri-devel@lists.freedesktop.org, Josh Poimboeuf , Thomas Gleixner , Wim Van Sebroeck , Jens Axboe , Michal Marek , "Martin K. Petersen" , linux-ide@vger.kernel.org, netdev@vger.kernel.org, linux-pm@vger.kernel.org, "Rafael J. Wysocki" , linux-kernel@vger.kernel.org, linux-security-module@vger.kernel.org, "David S. Miller" Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP The contents of those directories were orphaned at the documentation body. While those directories could likely be moved to be inside some guide, I'm opting to just adding their indexes to the main one, removing the :orphan: and adding the SPDX header. For the drivers, the rationale is that the documentation contains a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on separate directories, as we've be doing with similar subsystem-specific docs that were not split yet. For the others, well... I'm too lazy to do the move. Also, it seems to make sense to keep at least some of those at the main dir (like kbuild, for example). In any case, a latter patch could do the move. Signed-off-by: Mauro Carvalho Chehab Acked-by: Bartlomiej Zolnierkiewicz --- Documentation/cdrom/index.rst | 2 +- Documentation/fault-injection/index.rst | 2 +- Documentation/fb/index.rst | 2 +- Documentation/fpga/index.rst | 2 +- Documentation/ide/index.rst | 2 +- Documentation/index.rst | 14 ++++++++++++++ Documentation/kbuild/index.rst | 2 +- Documentation/livepatch/index.rst | 2 +- Documentation/netlabel/index.rst | 2 +- Documentation/pcmcia/index.rst | 2 +- Documentation/power/index.rst | 2 +- Documentation/target/index.rst | 2 +- Documentation/timers/index.rst | 2 +- Documentation/watchdog/index.rst | 2 +- 14 files changed, 27 insertions(+), 13 deletions(-) diff --git a/Documentation/cdrom/index.rst b/Documentation/cdrom/index.rst index efbd5d111825..338ad5f94e7c 100644 --- a/Documentation/cdrom/index.rst +++ b/Documentation/cdrom/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ===== cdrom diff --git a/Documentation/fault-injection/index.rst b/Documentation/fault-injection/index.rst index 92b5639ed07a..8408a8a91b34 100644 --- a/Documentation/fault-injection/index.rst +++ b/Documentation/fault-injection/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============== fault-injection diff --git a/Documentation/fb/index.rst b/Documentation/fb/index.rst index d47313714635..baf02393d8ee 100644 --- a/Documentation/fb/index.rst +++ b/Documentation/fb/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ============ Frame Buffer diff --git a/Documentation/fpga/index.rst b/Documentation/fpga/index.rst index 2c87d1ea084f..f80f95667ca2 100644 --- a/Documentation/fpga/index.rst +++ b/Documentation/fpga/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ==== fpga diff --git a/Documentation/ide/index.rst b/Documentation/ide/index.rst index 45bc12d3957f..813dfe611a31 100644 --- a/Documentation/ide/index.rst +++ b/Documentation/ide/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================================== Integrated Drive Electronics (IDE) diff --git a/Documentation/index.rst b/Documentation/index.rst index e69d2fde7735..075c732501a2 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -35,6 +35,7 @@ trying to get it to work optimally on a given system. :maxdepth: 2 admin-guide/index + kbuild/index Firmware-related documentation ------------------------------ @@ -77,6 +78,9 @@ merged much easier. kernel-hacking/index trace/index maintainer/index + fault-injection/index + livepatch/index + Kernel API documentation ------------------------ @@ -94,12 +98,22 @@ needed). core-api/index accounting/index block/index + cdrom/index + ide/index + fb/index + fpga/index hid/index iio/index infiniband/index leds/index media/index + netlabel/index networking/index + pcmcia/index + power/index + target/index + timers/index + watchdog/index input/index hwmon/index gpu/index diff --git a/Documentation/kbuild/index.rst b/Documentation/kbuild/index.rst index 42d4cbe4460c..e323a3f2cc81 100644 --- a/Documentation/kbuild/index.rst +++ b/Documentation/kbuild/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =================== Kernel Build System diff --git a/Documentation/livepatch/index.rst b/Documentation/livepatch/index.rst index edd291d51847..17674a9e21b2 100644 --- a/Documentation/livepatch/index.rst +++ b/Documentation/livepatch/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =================== Kernel Livepatching diff --git a/Documentation/netlabel/index.rst b/Documentation/netlabel/index.rst index 47f1e0e5acd1..984e1b191b12 100644 --- a/Documentation/netlabel/index.rst +++ b/Documentation/netlabel/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ======== NetLabel diff --git a/Documentation/pcmcia/index.rst b/Documentation/pcmcia/index.rst index 779c8527109e..7ae1f62fca14 100644 --- a/Documentation/pcmcia/index.rst +++ b/Documentation/pcmcia/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ====== pcmcia diff --git a/Documentation/power/index.rst b/Documentation/power/index.rst index 20415f21e48a..002e42745263 100644 --- a/Documentation/power/index.rst +++ b/Documentation/power/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================ Power Management diff --git a/Documentation/target/index.rst b/Documentation/target/index.rst index b68f48982392..4b24f81f747e 100644 --- a/Documentation/target/index.rst +++ b/Documentation/target/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================== TCM Virtual Device diff --git a/Documentation/timers/index.rst b/Documentation/timers/index.rst index 91f6f8263c48..df510ad0c989 100644 --- a/Documentation/timers/index.rst +++ b/Documentation/timers/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ====== timers diff --git a/Documentation/watchdog/index.rst b/Documentation/watchdog/index.rst index 33a0de631e84..c177645081d8 100644 --- a/Documentation/watchdog/index.rst +++ b/Documentation/watchdog/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ====================== Linux Watchdog Support