* [PATCH 28/39] docs: admin-guide: add a series of orphaned documents [not found] <cover.1561724493.git.mchehab+samsung@kernel.org> @ 2019-06-28 12:30 ` Mauro Carvalho Chehab 2019-06-28 12:43 ` Alexandre Belloni 2019-06-28 12:54 ` Bartlomiej Zolnierkiewicz 2019-06-28 12:30 ` [PATCH 37/39] docs: adds some directories to the main documentation index Mauro Carvalho Chehab 1 sibling, 2 replies; 5+ messages in thread From: Mauro Carvalho Chehab @ 2019-06-28 12:30 UTC (permalink / raw) To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Alasdair Kergon, Mike Snitzer, dm-devel, Ard Biesheuvel, Matt Mackall, Herbert Xu, Willy Tarreau, Ksenija Stanojevic, Richard Russon (FlatCap), Alessandro Zummo, Alexandre Belloni, Martin Mares, Bartlomiej Zolnierkiewicz, Thomas Gleixner, Ingo Molnar, Borislav Petkov 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 <mchehab+samsung@kernel.org> --- 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 <linux-mm@kvack.org> 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/<disk>/<part>/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 <ard.biesheuvel@linaro.org> 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 <herbert@gondor.apana.org.au> 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)" <ldm@flatcap.org> 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 <willy@haproxy.com> M: Ksenija Stanojevic <ksenija.stanojevic@gmail.com> 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 <mj@ucw.cz> 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 <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://tldp.org/HOWTO/SMP-HOWTO.html>. 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 <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. 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 <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. 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 <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. 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 <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. 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 <file:Documentation/ldm.txt>. + For a fuller description read <file:Documentation/admin-guide/ldm.rst>. 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 <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> 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 <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> 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 <m@bues.ch> * 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 -- 2.21.0 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 28/39] docs: admin-guide: add a series of orphaned documents 2019-06-28 12:30 ` [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Mauro Carvalho Chehab @ 2019-06-28 12:43 ` Alexandre Belloni 2019-06-28 12:54 ` Bartlomiej Zolnierkiewicz 1 sibling, 0 replies; 5+ messages in thread From: Alexandre Belloni @ 2019-06-28 12:43 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Alasdair Kergon, Mike Snitzer, dm-devel, Ard Biesheuvel, Matt Mackall, Herbert Xu, Willy Tarreau, Ksenija Stanojevic, Richard Russon (FlatCap), Alessandro Zummo, Martin Mares, Bartlomiej Zolnierkiewicz, Thomas Gleixner, Ingo Molnar, Borislav Petkov, H. Peter Anvin, x86 On 28/06/2019 09:30:21-0300, Mauro Carvalho Chehab wrote: > 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 <mchehab+samsung@kernel.org> Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com> > --- > 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 <linux-mm@kvack.org> > 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/<disk>/<part>/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 <ard.biesheuvel@linaro.org> > 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 <herbert@gondor.apana.org.au> > 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)" <ldm@flatcap.org> > 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 <willy@haproxy.com> > M: Ksenija Stanojevic <ksenija.stanojevic@gmail.com> > 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 <mj@ucw.cz> > 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 <file:Documentation/x86/i386/IO-APIC.rst>, > - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at > + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at > <http://tldp.org/HOWTO/SMP-HOWTO.html>. > > 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 <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO > + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO > available at <http://www.tldp.org/docs.html#howto>. > > 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 <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO > + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO > available at <http://www.tldp.org/docs.html#howto>. > > 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 <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO > + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO > available at <http://www.tldp.org/docs.html#howto>. > > 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 <file:Documentation/x86/i386/IO-APIC.rst>, > - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at > + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at > <http://www.tldp.org/docs.html#howto>. > > 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 <file:Documentation/ldm.txt>. > + For a fuller description read <file:Documentation/admin-guide/ldm.rst>. > > 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 <file:Documentation/rtc.txt> > + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> > 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 <file:Documentation/rtc.txt> > + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> > 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 <m@bues.ch> > * 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 > -- > 2.21.0 > -- Alexandre Belloni, Bootlin Embedded Linux and Kernel engineering https://bootlin.com ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH 28/39] docs: admin-guide: add a series of orphaned documents 2019-06-28 12:30 ` [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Mauro Carvalho Chehab 2019-06-28 12:43 ` Alexandre Belloni @ 2019-06-28 12:54 ` Bartlomiej Zolnierkiewicz 1 sibling, 0 replies; 5+ messages in thread From: Bartlomiej Zolnierkiewicz @ 2019-06-28 12:54 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: Alexandre Belloni, Rich Felker, Mike Snitzer, Linux Doc Mailing List, Richard Russon (FlatCap), linux-fbdev, dri-devel, James E.J. Bottomley, dm-devel, linux-efi, Willy Tarreau, H. Peter Anvin, sparclinux, Alasdair Kergon, linux-rtc, Herbert Xu, Ksenija Stanojevic, Jonathan Corbet, linux-sh, Helge Deller, x86, Russell King, Ingo Molnar, Arnd Bergmann, Mauro Carvalho Chehab On 6/28/19 2:30 PM, Mauro Carvalho Chehab wrote: > 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 <mchehab+samsung@kernel.org> Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> > --- > 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%) Best regards, -- Bartlomiej Zolnierkiewicz Samsung R&D Institute Poland Samsung Electronics ^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 37/39] docs: adds some directories to the main documentation index [not found] <cover.1561724493.git.mchehab+samsung@kernel.org> 2019-06-28 12:30 ` [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Mauro Carvalho Chehab @ 2019-06-28 12:30 ` Mauro Carvalho Chehab 2019-06-28 12:55 ` Bartlomiej Zolnierkiewicz 1 sibling, 1 reply; 5+ messages in thread From: Mauro Carvalho Chehab @ 2019-06-28 12:30 UTC (permalink / raw) To: Linux Doc Mailing List Cc: linux-fbdev, Len Brown, linux-fpga, Dominik Brodowski, Masahiro Yamada, target-devel, Pavel Machek, Mauro Carvalho Chehab, live-patching, Miroslav Benes, Joe Lawrence, Paul Moore, linux-scsi, Jonathan Corbet, linux-kbuild, Guenter Roeck, Petr Mladek, linux-watchdog, Bartlomiej Zolnierkiewicz, Jiri Kosina, Akinobu Mita, Mauro Carvalho Chehab, Moritz Fischer, dri-devel 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 <mchehab+samsung@kernel.org> --- 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 -- 2.21.0 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 37/39] docs: adds some directories to the main documentation index 2019-06-28 12:30 ` [PATCH 37/39] docs: adds some directories to the main documentation index Mauro Carvalho Chehab @ 2019-06-28 12:55 ` Bartlomiej Zolnierkiewicz 0 siblings, 0 replies; 5+ messages in thread From: Bartlomiej Zolnierkiewicz @ 2019-06-28 12:55 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: linux-fbdev, Len Brown, linux-fpga, Dominik Brodowski, Masahiro Yamada, target-devel, Pavel Machek, live-patching, Miroslav Benes, Joe Lawrence, Paul Moore, linux-scsi, Jonathan Corbet, Linux Doc Mailing List, Guenter Roeck, Petr Mladek, linux-watchdog, linux-kbuild, Jiri Kosina, Akinobu Mita, Mauro Carvalho Chehab, Moritz Fischer, dri-devel, Josh Poimboeuf, Thomas Gleixner On 6/28/19 2:30 PM, Mauro Carvalho Chehab wrote: > 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 <mchehab+samsung@kernel.org> Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> > --- > 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(-) Best regards, -- Bartlomiej Zolnierkiewicz Samsung R&D Institute Poland Samsung Electronics ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2019-06-28 12:55 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <cover.1561724493.git.mchehab+samsung@kernel.org>
2019-06-28 12:30 ` [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Mauro Carvalho Chehab
2019-06-28 12:43 ` Alexandre Belloni
2019-06-28 12:54 ` Bartlomiej Zolnierkiewicz
2019-06-28 12:30 ` [PATCH 37/39] docs: adds some directories to the main documentation index Mauro Carvalho Chehab
2019-06-28 12:55 ` Bartlomiej Zolnierkiewicz
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).