docs: admin-guide: add a series of orphaned documents

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>
Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2019-06-27 14:56:51 -03:00
parent da82c92f11
commit 4f4cfa6c56
40 changed files with 47 additions and 33 deletions

View File

@ -61,7 +61,7 @@ Date: October 2002
Contact: Linux Memory Management list <linux-mm@kvack.org> Contact: Linux Memory Management list <linux-mm@kvack.org>
Description: Description:
The node's hit/miss statistics, in units of pages. 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 What: /sys/devices/system/node/nodeX/distance
Date: October 2002 Date: October 2002

View File

@ -29,4 +29,4 @@ Description:
17 - sectors discarded 17 - sectors discarded
18 - time spent discarding 18 - time spent discarding
For more details refer to Documentation/iostats.txt For more details refer to Documentation/admin-guide/iostats.rst

View File

@ -15,7 +15,7 @@ Description:
9 - I/Os currently in progress 9 - I/Os currently in progress
10 - time spent doing I/Os (ms) 10 - time spent doing I/Os (ms)
11 - weighted 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 What: /sys/block/<disk>/<part>/stat

View File

@ -34,7 +34,7 @@ Description: CPU topology files that describe kernel limits related to
present: cpus that have been identified as being present in present: cpus that have been identified as being present in
the system. the system.
See Documentation/cputopology.txt for more information. See Documentation/admin-guide/cputopology.rst for more information.
What: /sys/devices/system/cpu/probe 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 thread_siblings_list: human-readable list of cpu#'s hardware
threads within the same core as cpu# 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 What: /sys/devices/system/cpu/cpuidle/current_driver

View File

@ -13,7 +13,7 @@ the range specified.
The I/O statistics counters for each step-sized area of a region are 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: 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 provided: total time spent reading and writing. When the histogram
argument is used, the 14th parameter is reported that represents the argument is used, the 14th parameter is reported that represents the
histogram of latencies. All these counters may be accessed by sending 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 The first 11 counters have the same meaning as
`/sys/block/*/stat or /proc/diskstats`. `/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 1. the number of reads completed
2. the number of reads merged 2. the number of reads merged

View File

@ -241,7 +241,7 @@ Guest mitigation mechanisms
For further information about confining guests to a single or to a group For further information about confining guests to a single or to a group
of cores consult the cpusets documentation: 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: .. _interrupt_isolation:

View File

@ -85,8 +85,25 @@ configure specific aspects of kernel behavior to your liking.
perf-security perf-security
acpi/index acpi/index
aoe/index aoe/index
btmrvl
clearing-warn-once
cpu-load
cputopology
device-mapper/index device-mapper/index
efi-stub
highuid
hw_random
iostats
kernel-per-CPU-kthreads
laptops/index laptops/index
lcd-panel-cgram
ldm
lockup-watchdogs
numastat
pnp
rtc
svga
video-output
.. only:: subproject and html .. only:: subproject and html

View File

@ -5066,7 +5066,7 @@
vga= [BOOT,X86-32] Select a particular video mode vga= [BOOT,X86-32] Select a particular video mode
See Documentation/x86/boot.rst and See Documentation/x86/boot.rst and
Documentation/svga.txt. Documentation/admin-guide/svga.rst.
Use vga=ask for menu. Use vga=ask for menu.
This is actually a boot loader parameter; the value is This is actually a boot loader parameter; the value is
passed to the kernel using a special protocol. passed to the kernel using a special protocol.

View File

@ -1,5 +1,3 @@
:orphan:
====================================== ======================================
Parallel port LCD/Keypad Panel support Parallel port LCD/Keypad Panel support
====================================== ======================================

View File

@ -1,5 +1,3 @@
:orphan:
===================== =====================
CMA Debugfs Interface CMA Debugfs Interface
===================== =====================

View File

@ -26,6 +26,7 @@ the Linux memory management.
:maxdepth: 1 :maxdepth: 1
concepts concepts
cma_debugfs
hugetlbpage hugetlbpage
idle_page_tracking idle_page_tracking
ksm ksm

View File

@ -327,7 +327,7 @@ when a hard lockup is detected.
0 - don't panic on hard lockup 0 - don't panic on hard lockup
1 - 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. also be set using the nmi_watchdog kernel parameter.

View File

@ -30,7 +30,7 @@ How to use it?
============== ==============
Switching modes is done using the vga=... boot parameter. Read 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 You should compile in both vgacon (for text mode) and vesafb (for
graphics mode). Which of them takes over the console depends on graphics mode). Which of them takes over the console depends on

View File

@ -9,7 +9,7 @@ representation in the kernel. Update/change when doing changes to the
respective code. respective code.
The architecture-agnostic topology definitions are in 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 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 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. with the generic one and look at this one in parallel for the x86 specifics.

View File

@ -6080,7 +6080,7 @@ M: Ard Biesheuvel <ard.biesheuvel@linaro.org>
L: linux-efi@vger.kernel.org L: linux-efi@vger.kernel.org
T: git git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi.git
S: Maintained S: Maintained
F: Documentation/efi-stub.txt F: Documentation/admin-guide/efi-stub.rst
F: arch/*/kernel/efi.c F: arch/*/kernel/efi.c
F: arch/x86/boot/compressed/eboot.[ch] F: arch/x86/boot/compressed/eboot.[ch]
F: arch/*/include/asm/efi.h F: arch/*/include/asm/efi.h
@ -7088,7 +7088,7 @@ M: Herbert Xu <herbert@gondor.apana.org.au>
L: linux-crypto@vger.kernel.org L: linux-crypto@vger.kernel.org
S: Odd fixes S: Odd fixes
F: Documentation/devicetree/bindings/rng/ F: Documentation/devicetree/bindings/rng/
F: Documentation/hw_random.txt F: Documentation/admin-guide/hw_random.rst
F: drivers/char/hw_random/ F: drivers/char/hw_random/
F: include/linux/hw_random.h F: include/linux/hw_random.h
@ -9398,7 +9398,7 @@ M: "Richard Russon (FlatCap)" <ldm@flatcap.org>
L: linux-ntfs-dev@lists.sourceforge.net L: linux-ntfs-dev@lists.sourceforge.net
W: http://www.linux-ntfs.org/content/view/19/37/ W: http://www.linux-ntfs.org/content/view/19/37/
S: Maintained S: Maintained
F: Documentation/ldm.txt F: Documentation/admin-guide/ldm.rst
F: block/partitions/ldm.* F: block/partitions/ldm.*
LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI) LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI)
@ -12058,7 +12058,7 @@ PARALLEL LCD/KEYPAD PANEL DRIVER
M: Willy Tarreau <willy@haproxy.com> M: Willy Tarreau <willy@haproxy.com>
M: Ksenija Stanojevic <ksenija.stanojevic@gmail.com> M: Ksenija Stanojevic <ksenija.stanojevic@gmail.com>
S: Odd Fixes S: Odd Fixes
F: Documentation/auxdisplay/lcd-panel-cgram.rst F: Documentation/admin-guide/lcd-panel-cgram.rst
F: drivers/auxdisplay/panel.c F: drivers/auxdisplay/panel.c
PARALLEL PORT SUBSYSTEM PARALLEL PORT SUBSYSTEM
@ -13476,7 +13476,7 @@ Q: http://patchwork.ozlabs.org/project/rtc-linux/list/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux.git
S: Maintained S: Maintained
F: Documentation/devicetree/bindings/rtc/ F: Documentation/devicetree/bindings/rtc/
F: Documentation/rtc.txt F: Documentation/admin-guide/rtc.rst
F: drivers/rtc/ F: drivers/rtc/
F: include/linux/rtc.h F: include/linux/rtc.h
F: include/uapi/linux/rtc.h F: include/uapi/linux/rtc.h
@ -15306,7 +15306,7 @@ SVGA HANDLING
M: Martin Mares <mj@ucw.cz> M: Martin Mares <mj@ucw.cz>
L: linux-video@atrey.karlin.mff.cuni.cz L: linux-video@atrey.karlin.mff.cuni.cz
S: Maintained S: Maintained
F: Documentation/svga.txt F: Documentation/admin-guide/svga.rst
F: arch/x86/boot/video* F: arch/x86/boot/video*
SWIOTLB SUBSYSTEM SWIOTLB SUBSYSTEM

View File

@ -1297,7 +1297,7 @@ config SMP
will run faster if you say N here. will run faster if you say N here.
See also <file:Documentation/x86/i386/IO-APIC.rst>, 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>. <http://tldp.org/HOWTO/SMP-HOWTO.html>.
If you don't know what to do here, say N. If you don't know what to do here, say N.

View File

@ -277,7 +277,7 @@ config SMP
machines, but will use only one CPU of a multiprocessor machine. machines, but will use only one CPU of a multiprocessor machine.
On a uniprocessor machine, the kernel will run faster if you say N. 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>. available at <http://www.tldp.org/docs.html#howto>.
If you don't know what to do here, say N. If you don't know what to do here, say N.

View File

@ -679,7 +679,7 @@ config SMP
People using multiprocessor machines who say Y here should also say People using multiprocessor machines who say Y here should also say
Y to "Enhanced Real Time Clock Support", below. 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>. available at <http://www.tldp.org/docs.html#howto>.
If you don't know what to do here, say N. If you don't know what to do here, say N.

View File

@ -180,7 +180,7 @@ config SMP
Y to "Enhanced Real Time Clock Support", below. The "Advanced Power Y to "Enhanced Real Time Clock Support", below. The "Advanced Power
Management" code will be disabled if you say Y here. 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>. available at <http://www.tldp.org/docs.html#howto>.
If you don't know what to do here, say N. If you don't know what to do here, say N.

View File

@ -402,7 +402,7 @@ config SMP
Management" code will be disabled if you say Y here. Management" code will be disabled if you say Y here.
See also <file:Documentation/x86/i386/IO-APIC.rst>, 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>. <http://www.tldp.org/docs.html#howto>.
If you don't know what to do here, say N. 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 This kernel feature allows a bzImage to be loaded directly
by EFI firmware without the use of a bootloader. 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 config EFI_MIXED
bool "EFI mixed-mode support" bool "EFI mixed-mode support"

View File

@ -194,7 +194,7 @@ config LDM_PARTITION
Normal partitions are now called Basic Disks under Windows 2000, XP, Normal partitions are now called Basic Disks under Windows 2000, XP,
and Vista. 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. If unsure, say N.

View File

@ -291,7 +291,7 @@ config RTC
and set the RTC in an SMP compatible fashion. and set the RTC in an SMP compatible fashion.
If you think you have a use for such a device (such as periodic data 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. for details.
To compile this driver as a module, choose M here: the To compile this driver as a module, choose M here: the
@ -313,7 +313,7 @@ config JS_RTC
/dev/rtc. /dev/rtc.
If you think you have a use for such a device (such as periodic data 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. for details.
To compile this driver as a module, choose M here: the To compile this driver as a module, choose M here: the

View File

@ -4,7 +4,7 @@
* Copyright 2006 Michael Buesch <m@bues.ch> * Copyright 2006 Michael Buesch <m@bues.ch>
* Copyright 2005 (c) MontaVista Software, Inc. * 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 * This software may be used and distributed according to the terms
* of the GNU General Public License, incorporated herein by reference. * of the GNU General Public License, incorporated herein by reference.

View File

@ -1,7 +1,7 @@
/* /*
Hardware Random Number Generator 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 This software may be used and distributed according to the terms