* [PATCH 16/39] docs: admin-guide: move sysctl directory to it
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, Alexey Dobriyan, David S. Miller, linux-fsdevel,
netdev, linux-mm
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The stuff under sysctl describes /sys interface from userspace
point of view. So, add it to the admin-guide and remove the
:orphan: from its index file.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
CREDITS | 2 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.txt | 2 +-
Documentation/admin-guide/mm/index.rst | 2 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
Documentation/{ => admin-guide}/sysctl/abi.rst | 0
Documentation/{ => admin-guide}/sysctl/fs.rst | 0
Documentation/{ => admin-guide}/sysctl/index.rst | 2 --
Documentation/{ => admin-guide}/sysctl/kernel.rst | 0
Documentation/{ => admin-guide}/sysctl/net.rst | 0
Documentation/{ => admin-guide}/sysctl/sunrpc.rst | 0
Documentation/{ => admin-guide}/sysctl/user.rst | 0
Documentation/{ => admin-guide}/sysctl/vm.rst | 0
Documentation/core-api/printk-formats.rst | 2 +-
Documentation/filesystems/proc.txt | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/vm/unevictable-lru.rst | 2 +-
fs/proc/Kconfig | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
20 files changed, 12 insertions(+), 13 deletions(-)
rename Documentation/{ => admin-guide}/sysctl/abi.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/fs.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/index.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/kernel.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/net.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/sunrpc.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/user.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/vm.rst (100%)
diff --git a/CREDITS b/CREDITS
index beac0c81d081..401c5092bbf9 100644
--- a/CREDITS
+++ b/CREDITS
@@ -3120,7 +3120,7 @@ S: France
N: Rik van Riel
E: riel@redhat.com
W: http://www.surriel.com/
-D: Linux-MM site, Documentation/sysctl/*, swap/mm readaround
+D: Linux-MM site, Documentation/admin-guide/sysctl/*, swap/mm readaround
D: kswapd fixes, random kernel hacker, rmap VM,
D: nl.linux.org administrator, minor scheduler additions
S: Red Hat Boston
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index e0763c51b024..acd0efa46e9d 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -16,6 +16,7 @@ etc.
README
kernel-parameters
devices
+ sysctl/index
This section describes CPU vulnerabilities and their mitigations.
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index b2007fb4daf0..a3d3da5baacb 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -3170,7 +3170,7 @@
numa_zonelist_order= [KNL, BOOT] Select zonelist order for NUMA.
'node', 'default' can be specified
This can be set from sysctl after boot.
- See Documentation/sysctl/vm.rst for details.
+ See Documentation/admin-guide/sysctl/vm.rst for details.
ohci1394_dma=early [HW] enable debugging via the ohci1394 driver.
See Documentation/debugging-via-ohci1394.txt for more
diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index f5e92f33f96e..5f61a6c429e0 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -11,7 +11,7 @@ processes address space and many other cool things.
Linux memory management is a complex system with many configurable
settings. Most of these settings are available via ``/proc``
filesystem and can be quired and adjusted using ``sysctl``. These APIs
-are described in Documentation/sysctl/vm.rst and in `man 5 proc`_.
+are described in Documentation/admin-guide/sysctl/vm.rst and in `man 5 proc`_.
.. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
diff --git a/Documentation/admin-guide/mm/ksm.rst b/Documentation/admin-guide/mm/ksm.rst
index 7b2b8767c0b4..874eb0c77d34 100644
--- a/Documentation/admin-guide/mm/ksm.rst
+++ b/Documentation/admin-guide/mm/ksm.rst
@@ -59,7 +59,7 @@ MADV_UNMERGEABLE is applied to a range which was never MADV_MERGEABLE.
If a region of memory must be split into at least one new MADV_MERGEABLE
or MADV_UNMERGEABLE region, the madvise may return ENOMEM if the process
-will exceed ``vm.max_map_count`` (see Documentation/sysctl/vm.rst).
+will exceed ``vm.max_map_count`` (see Documentation/admin-guide/sysctl/vm.rst).
Like other madvise calls, they are intended for use on mapped areas of
the user address space: they will report ENOMEM if the specified range
diff --git a/Documentation/sysctl/abi.rst b/Documentation/admin-guide/sysctl/abi.rst
similarity index 100%
rename from Documentation/sysctl/abi.rst
rename to Documentation/admin-guide/sysctl/abi.rst
diff --git a/Documentation/sysctl/fs.rst b/Documentation/admin-guide/sysctl/fs.rst
similarity index 100%
rename from Documentation/sysctl/fs.rst
rename to Documentation/admin-guide/sysctl/fs.rst
diff --git a/Documentation/sysctl/index.rst b/Documentation/admin-guide/sysctl/index.rst
similarity index 99%
rename from Documentation/sysctl/index.rst
rename to Documentation/admin-guide/sysctl/index.rst
index efbcde8c1c9c..03346f98c7b9 100644
--- a/Documentation/sysctl/index.rst
+++ b/Documentation/admin-guide/sysctl/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
Documentation for /proc/sys
===========================
diff --git a/Documentation/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
similarity index 100%
rename from Documentation/sysctl/kernel.rst
rename to Documentation/admin-guide/sysctl/kernel.rst
diff --git a/Documentation/sysctl/net.rst b/Documentation/admin-guide/sysctl/net.rst
similarity index 100%
rename from Documentation/sysctl/net.rst
rename to Documentation/admin-guide/sysctl/net.rst
diff --git a/Documentation/sysctl/sunrpc.rst b/Documentation/admin-guide/sysctl/sunrpc.rst
similarity index 100%
rename from Documentation/sysctl/sunrpc.rst
rename to Documentation/admin-guide/sysctl/sunrpc.rst
diff --git a/Documentation/sysctl/user.rst b/Documentation/admin-guide/sysctl/user.rst
similarity index 100%
rename from Documentation/sysctl/user.rst
rename to Documentation/admin-guide/sysctl/user.rst
diff --git a/Documentation/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
similarity index 100%
rename from Documentation/sysctl/vm.rst
rename to Documentation/admin-guide/sysctl/vm.rst
diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index 1d8e748f909f..c6224d039bcb 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -119,7 +119,7 @@ Kernel Pointers
For printing kernel pointers which should be hidden from unprivileged
users. The behaviour of %pK depends on the kptr_restrict sysctl - see
-Documentation/sysctl/kernel.rst for more details.
+Documentation/admin-guide/sysctl/kernel.rst for more details.
Unmodified Addresses
--------------------
diff --git a/Documentation/filesystems/proc.txt b/Documentation/filesystems/proc.txt
index 52ec004a4a8b..be56af8dbb88 100644
--- a/Documentation/filesystems/proc.txt
+++ b/Documentation/filesystems/proc.txt
@@ -1479,7 +1479,7 @@ review the kernel documentation in the directory /usr/src/linux/Documentation.
This chapter is heavily based on the documentation included in the pre 2.2
kernels, and became part of it in version 2.2.1 of the Linux kernel.
-Please see: Documentation/sysctl/ directory for descriptions of these
+Please see: Documentation/admin-guide/sysctl/ directory for descriptions of these
entries.
------------------------------------------------------------------------------
diff --git a/Documentation/networking/ip-sysctl.txt b/Documentation/networking/ip-sysctl.txt
index 0f8e1c544e1e..864a5921e9d7 100644
--- a/Documentation/networking/ip-sysctl.txt
+++ b/Documentation/networking/ip-sysctl.txt
@@ -2284,7 +2284,7 @@ addr_scope_policy - INTEGER
/proc/sys/net/core/*
- Please see: Documentation/sysctl/net.rst for descriptions of these entries.
+ Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
/proc/sys/net/unix/*
diff --git a/Documentation/vm/unevictable-lru.rst b/Documentation/vm/unevictable-lru.rst
index 8ba656f37cd8..109052215bce 100644
--- a/Documentation/vm/unevictable-lru.rst
+++ b/Documentation/vm/unevictable-lru.rst
@@ -439,7 +439,7 @@ Compacting MLOCKED Pages
The unevictable LRU can be scanned for compactable regions and the default
behavior is to do so. /proc/sys/vm/compact_unevictable_allowed controls
-this behavior (see Documentation/sysctl/vm.rst). Once scanning of the
+this behavior (see Documentation/admin-guide/sysctl/vm.rst). Once scanning of the
unevictable LRU is enabled, the work of compaction is mostly handled by
the page migration code and the same work flow as described in MIGRATING
MLOCKED PAGES will apply.
diff --git a/fs/proc/Kconfig b/fs/proc/Kconfig
index cba429db95d9..cb5629bd5fff 100644
--- a/fs/proc/Kconfig
+++ b/fs/proc/Kconfig
@@ -73,7 +73,7 @@ config PROC_SYSCTL
interface is through /proc/sys. If you say Y here a tree of
modifiable sysctl entries will be generated beneath the
/proc/sys directory. They are explained in the files
- in <file:Documentation/sysctl/>. Note that enabling this
+ in <file:Documentation/admin-guide/sysctl/>. Note that enabling this
option will enlarge the kernel by at least 8 KB.
As it is generally a good thing, you should say Y here unless
diff --git a/kernel/panic.c b/kernel/panic.c
index e0ea74bbb41d..057540b6eee9 100644
--- a/kernel/panic.c
+++ b/kernel/panic.c
@@ -372,7 +372,7 @@ const struct taint_flag taint_flags[TAINT_FLAGS_COUNT] = {
/**
* print_tainted - return a string to represent the kernel taint state.
*
- * For individual taint flag meanings, see Documentation/sysctl/kernel.rst
+ * For individual taint flag meanings, see Documentation/admin-guide/sysctl/kernel.rst
*
* The string is overwritten by the next call to print_tainted(),
* but is always NULL terminated.
diff --git a/mm/swap.c b/mm/swap.c
index 83a2a15f4836..ae300397dfda 100644
--- a/mm/swap.c
+++ b/mm/swap.c
@@ -8,7 +8,7 @@
/*
* This file contains the default values for the operation of the
* Linux VM subsystem. Fine-tuning documentation can be found in
- * Documentation/sysctl/vm.rst.
+ * Documentation/admin-guide/sysctl/vm.rst.
* Started 18.12.91
* Swap aging added 23.2.95, Stephen Tweedie.
* Buffermem limits added 12.3.98, Rik van Riel.
--
2.21.0
^ permalink raw reply related
* [PATCH 03/39] docs: perf: move to the admin-guide
From: Mauro Carvalho Chehab @ 2019-06-28 12:29 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Shaokun Zhang, Khuong Dinh, Will Deacon,
Mark Rutland, Andy Gross, linux-arm-kernel, linux-arm-msm
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The perf infrastructure is used for userspace to track issues.
At least a good part of what's described here is related to
it.
So, add it to the admin-guide.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/admin-guide/index.rst | 1 +
Documentation/{ => admin-guide}/perf/arm-ccn.rst | 0
Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst | 0
Documentation/{ => admin-guide}/perf/hisi-pmu.rst | 0
Documentation/{ => admin-guide}/perf/index.rst | 2 --
Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst | 0
Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst | 0
Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst | 0
Documentation/{ => admin-guide}/perf/xgene-pmu.rst | 0
MAINTAINERS | 4 ++--
drivers/perf/qcom_l3_pmu.c | 2 +-
11 files changed, 4 insertions(+), 5 deletions(-)
rename Documentation/{ => admin-guide}/perf/arm-ccn.rst (100%)
rename Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/hisi-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/index.rst (95%)
rename Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/xgene-pmu.rst (100%)
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 0066b198cad4..b7e6d18f80ca 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -38,6 +38,7 @@ problems and bugs in particular.
ramoops
dynamic-debug-howto
init
+ perf/index
This is the beginning of a section with information of interest to
application developers. Documents covering various aspects of the kernel
diff --git a/Documentation/perf/arm-ccn.rst b/Documentation/admin-guide/perf/arm-ccn.rst
similarity index 100%
rename from Documentation/perf/arm-ccn.rst
rename to Documentation/admin-guide/perf/arm-ccn.rst
diff --git a/Documentation/perf/arm_dsu_pmu.rst b/Documentation/admin-guide/perf/arm_dsu_pmu.rst
similarity index 100%
rename from Documentation/perf/arm_dsu_pmu.rst
rename to Documentation/admin-guide/perf/arm_dsu_pmu.rst
diff --git a/Documentation/perf/hisi-pmu.rst b/Documentation/admin-guide/perf/hisi-pmu.rst
similarity index 100%
rename from Documentation/perf/hisi-pmu.rst
rename to Documentation/admin-guide/perf/hisi-pmu.rst
diff --git a/Documentation/perf/index.rst b/Documentation/admin-guide/perf/index.rst
similarity index 95%
rename from Documentation/perf/index.rst
rename to Documentation/admin-guide/perf/index.rst
index 4bf848e27f26..9d445451ea18 100644
--- a/Documentation/perf/index.rst
+++ b/Documentation/admin-guide/perf/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
Performance monitor support
===========================
diff --git a/Documentation/perf/qcom_l2_pmu.rst b/Documentation/admin-guide/perf/qcom_l2_pmu.rst
similarity index 100%
rename from Documentation/perf/qcom_l2_pmu.rst
rename to Documentation/admin-guide/perf/qcom_l2_pmu.rst
diff --git a/Documentation/perf/qcom_l3_pmu.rst b/Documentation/admin-guide/perf/qcom_l3_pmu.rst
similarity index 100%
rename from Documentation/perf/qcom_l3_pmu.rst
rename to Documentation/admin-guide/perf/qcom_l3_pmu.rst
diff --git a/Documentation/perf/thunderx2-pmu.rst b/Documentation/admin-guide/perf/thunderx2-pmu.rst
similarity index 100%
rename from Documentation/perf/thunderx2-pmu.rst
rename to Documentation/admin-guide/perf/thunderx2-pmu.rst
diff --git a/Documentation/perf/xgene-pmu.rst b/Documentation/admin-guide/perf/xgene-pmu.rst
similarity index 100%
rename from Documentation/perf/xgene-pmu.rst
rename to Documentation/admin-guide/perf/xgene-pmu.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 9d3a408f5ce1..55996c9f2e0a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1139,7 +1139,7 @@ APPLIED MICRO (APM) X-GENE SOC PMU
M: Khuong Dinh <khuong@os.amperecomputing.com>
S: Supported
F: drivers/perf/xgene_pmu.c
-F: Documentation/perf/xgene-pmu.rst
+F: Documentation/admin-guide/perf/xgene-pmu.rst
F: Documentation/devicetree/bindings/perf/apm-xgene-pmu.txt
APTINA CAMERA SENSOR PLL
@@ -7207,7 +7207,7 @@ M: Shaokun Zhang <zhangshaokun@hisilicon.com>
W: http://www.hisilicon.com
S: Supported
F: drivers/perf/hisilicon
-F: Documentation/perf/hisi-pmu.rst
+F: Documentation/admin-guide/perf/hisi-pmu.rst
HISILICON ROCE DRIVER
M: Lijun Ou <oulijun@huawei.com>
diff --git a/drivers/perf/qcom_l3_pmu.c b/drivers/perf/qcom_l3_pmu.c
index 90f88ce5192b..656e830798d9 100644
--- a/drivers/perf/qcom_l3_pmu.c
+++ b/drivers/perf/qcom_l3_pmu.c
@@ -8,7 +8,7 @@
* the slices. User space needs to aggregate to individual counts to provide
* a global picture.
*
- * See Documentation/perf/qcom_l3_pmu.rst for more details.
+ * See Documentation/admin-guide/perf/qcom_l3_pmu.rst for more details.
*
* Copyright (c) 2015-2017, The Linux Foundation. All rights reserved.
*/
--
2.21.0
^ permalink raw reply related
* [PATCH 06/39] docs: mtd: move it to the driver-api book
From: Mauro Carvalho Chehab @ 2019-06-28 12:29 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Miquel Raynal, Richard Weinberger,
David Woodhouse, Brian Norris, Marek Vasut, Vignesh Raghavendra,
linux-mtd
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
While I was tempted to move it to admin-guide, as some docs
there are more userspace-faced, there are some very technical
discussions about memory error correction code from the Kernel
implementer's PoV. So, let's place it inside the driver-api
book.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/mtd/index.rst | 2 --
Documentation/{ => driver-api}/mtd/intel-spi.rst | 0
Documentation/{ => driver-api}/mtd/nand_ecc.rst | 0
Documentation/{ => driver-api}/mtd/spi-nor.rst | 0
drivers/mtd/nand/raw/nand_ecc.c | 2 +-
6 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{ => driver-api}/mtd/index.rst (94%)
rename Documentation/{ => driver-api}/mtd/intel-spi.rst (100%)
rename Documentation/{ => driver-api}/mtd/nand_ecc.rst (100%)
rename Documentation/{ => driver-api}/mtd/spi-nor.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 41f5ce7dc34c..488c0347fa98 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -43,6 +43,7 @@ available subsections can be seen below.
mtdnand
miscellaneous
mei/index
+ mtd/index
nvdimm/index
w1
rapidio/index
diff --git a/Documentation/mtd/index.rst b/Documentation/driver-api/mtd/index.rst
similarity index 94%
rename from Documentation/mtd/index.rst
rename to Documentation/driver-api/mtd/index.rst
index 4fdae418ac97..2e0e7cc4055e 100644
--- a/Documentation/mtd/index.rst
+++ b/Documentation/driver-api/mtd/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
==============================
Memory Technology Device (MTD)
==============================
diff --git a/Documentation/mtd/intel-spi.rst b/Documentation/driver-api/mtd/intel-spi.rst
similarity index 100%
rename from Documentation/mtd/intel-spi.rst
rename to Documentation/driver-api/mtd/intel-spi.rst
diff --git a/Documentation/mtd/nand_ecc.rst b/Documentation/driver-api/mtd/nand_ecc.rst
similarity index 100%
rename from Documentation/mtd/nand_ecc.rst
rename to Documentation/driver-api/mtd/nand_ecc.rst
diff --git a/Documentation/mtd/spi-nor.rst b/Documentation/driver-api/mtd/spi-nor.rst
similarity index 100%
rename from Documentation/mtd/spi-nor.rst
rename to Documentation/driver-api/mtd/spi-nor.rst
diff --git a/drivers/mtd/nand/raw/nand_ecc.c b/drivers/mtd/nand/raw/nand_ecc.c
index f6a7808db818..09fdced659f5 100644
--- a/drivers/mtd/nand/raw/nand_ecc.c
+++ b/drivers/mtd/nand/raw/nand_ecc.c
@@ -11,7 +11,7 @@
* Thomas Gleixner (tglx@linutronix.de)
*
* Information on how this algorithm works and how it was developed
- * can be found in Documentation/mtd/nand_ecc.rst
+ * can be found in Documentation/driver-api/mtd/nand_ecc.rst
*/
#include <linux/types.h>
--
2.21.0
^ permalink raw reply related
* [PATCH 25/39] docs: add some documentation dirs to the driver-api book
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
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
Those are subsystem docs, with a mix of kABI and user-faced
docs. While they're not split, keep the dirs where they are,
adding just a pointer to the main index.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/accounting/index.rst | 2 +-
Documentation/block/index.rst | 2 +-
Documentation/hid/index.rst | 2 +-
Documentation/iio/index.rst | 2 +-
Documentation/index.rst | 4 ++++
5 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/accounting/index.rst b/Documentation/accounting/index.rst
index e1f6284b5ff3..9369d8bf32be 100644
--- a/Documentation/accounting/index.rst
+++ b/Documentation/accounting/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
==========
Accounting
diff --git a/Documentation/block/index.rst b/Documentation/block/index.rst
index 8cd226a0e86e..3fa7a52fafa4 100644
--- a/Documentation/block/index.rst
+++ b/Documentation/block/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=====
Block
diff --git a/Documentation/hid/index.rst b/Documentation/hid/index.rst
index af4324902622..737d66dc16a1 100644
--- a/Documentation/hid/index.rst
+++ b/Documentation/hid/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=============================
Human Interface Devices (HID)
diff --git a/Documentation/iio/index.rst b/Documentation/iio/index.rst
index 0593dca89a94..58b7a4ebac51 100644
--- a/Documentation/iio/index.rst
+++ b/Documentation/iio/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
==============
Industrial I/O
diff --git a/Documentation/index.rst b/Documentation/index.rst
index f898def833f4..879849b60c02 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -92,6 +92,10 @@ needed).
driver-api/index
core-api/index
+ accounting/index
+ block/index
+ hid/index
+ iio/index
leds/index
media/index
networking/index
--
2.21.0
^ permalink raw reply related
* [PATCH 32/39] docs: serial: move it to the driver-api
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, Greg Kroah-Hartman, Jiri Slaby, Timur Tabi,
linuxppc-dev, linux-serial
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The contents of this directory is mostly driver-api stuff.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/serial/cyclades_z.rst | 0
Documentation/{ => driver-api}/serial/driver.rst | 2 +-
Documentation/{ => driver-api}/serial/index.rst | 2 +-
Documentation/{ => driver-api}/serial/moxa-smartio.rst | 0
Documentation/{ => driver-api}/serial/n_gsm.rst | 0
Documentation/{ => driver-api}/serial/rocket.rst | 0
Documentation/{ => driver-api}/serial/serial-iso7816.rst | 0
Documentation/{ => driver-api}/serial/serial-rs485.rst | 0
Documentation/{ => driver-api}/serial/tty.rst | 0
MAINTAINERS | 6 +++---
drivers/tty/Kconfig | 4 ++--
drivers/tty/serial/ucc_uart.c | 2 +-
include/linux/serial_core.h | 2 +-
14 files changed, 10 insertions(+), 9 deletions(-)
rename Documentation/{ => driver-api}/serial/cyclades_z.rst (100%)
rename Documentation/{ => driver-api}/serial/driver.rst (99%)
rename Documentation/{ => driver-api}/serial/index.rst (90%)
rename Documentation/{ => driver-api}/serial/moxa-smartio.rst (100%)
rename Documentation/{ => driver-api}/serial/n_gsm.rst (100%)
rename Documentation/{ => driver-api}/serial/rocket.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-iso7816.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-rs485.rst (100%)
rename Documentation/{ => driver-api}/serial/tty.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index f44a3140f95d..d6f532c8d824 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -88,6 +88,7 @@ available subsections can be seen below.
pti_intel_mid
pwm
rfkill
+ serial/index
sgi-ioc4
sm501
smsc_ece1099
diff --git a/Documentation/serial/cyclades_z.rst b/Documentation/driver-api/serial/cyclades_z.rst
similarity index 100%
rename from Documentation/serial/cyclades_z.rst
rename to Documentation/driver-api/serial/cyclades_z.rst
diff --git a/Documentation/serial/driver.rst b/Documentation/driver-api/serial/driver.rst
similarity index 99%
rename from Documentation/serial/driver.rst
rename to Documentation/driver-api/serial/driver.rst
index 4537119bf624..31bd4e16fb1f 100644
--- a/Documentation/serial/driver.rst
+++ b/Documentation/driver-api/serial/driver.rst
@@ -311,7 +311,7 @@ hardware.
This call must not sleep
set_ldisc(port,termios)
- Notifier for discipline change. See Documentation/serial/tty.rst.
+ Notifier for discipline change. See Documentation/driver-api/serial/tty.rst.
Locking: caller holds tty_port->mutex
diff --git a/Documentation/serial/index.rst b/Documentation/driver-api/serial/index.rst
similarity index 90%
rename from Documentation/serial/index.rst
rename to Documentation/driver-api/serial/index.rst
index d0ba22ea23bf..33ad10d05b26 100644
--- a/Documentation/serial/index.rst
+++ b/Documentation/driver-api/serial/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
==========================
Support for Serial devices
diff --git a/Documentation/serial/moxa-smartio.rst b/Documentation/driver-api/serial/moxa-smartio.rst
similarity index 100%
rename from Documentation/serial/moxa-smartio.rst
rename to Documentation/driver-api/serial/moxa-smartio.rst
diff --git a/Documentation/serial/n_gsm.rst b/Documentation/driver-api/serial/n_gsm.rst
similarity index 100%
rename from Documentation/serial/n_gsm.rst
rename to Documentation/driver-api/serial/n_gsm.rst
diff --git a/Documentation/serial/rocket.rst b/Documentation/driver-api/serial/rocket.rst
similarity index 100%
rename from Documentation/serial/rocket.rst
rename to Documentation/driver-api/serial/rocket.rst
diff --git a/Documentation/serial/serial-iso7816.rst b/Documentation/driver-api/serial/serial-iso7816.rst
similarity index 100%
rename from Documentation/serial/serial-iso7816.rst
rename to Documentation/driver-api/serial/serial-iso7816.rst
diff --git a/Documentation/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst
similarity index 100%
rename from Documentation/serial/serial-rs485.rst
rename to Documentation/driver-api/serial/serial-rs485.rst
diff --git a/Documentation/serial/tty.rst b/Documentation/driver-api/serial/tty.rst
similarity index 100%
rename from Documentation/serial/tty.rst
rename to Documentation/driver-api/serial/tty.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 055db86fdd77..856db8015edd 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -10723,7 +10723,7 @@ F: include/uapi/linux/meye.h
MOXA SMARTIO/INDUSTIO/INTELLIO SERIAL CARD
M: Jiri Slaby <jirislaby@gmail.com>
S: Maintained
-F: Documentation/serial/moxa-smartio.rst
+F: Documentation/driver-api/serial/moxa-smartio.rst
F: drivers/tty/mxser.*
MR800 AVERMEDIA USB FM RADIO DRIVER
@@ -13637,7 +13637,7 @@ ROCKETPORT DRIVER
P: Comtrol Corp.
W: http://www.comtrol.com
S: Maintained
-F: Documentation/serial/rocket.rst
+F: Documentation/driver-api/serial/rocket.rst
F: drivers/tty/rocket*
ROCKETPORT EXPRESS/INFINITY DRIVER
@@ -16170,7 +16170,7 @@ M: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
M: Jiri Slaby <jslaby@suse.com>
S: Supported
T: git git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty.git
-F: Documentation/serial/
+F: Documentation/driver-api/serial/
F: drivers/tty/
F: drivers/tty/serial/serial_core.c
F: include/linux/serial_core.h
diff --git a/drivers/tty/Kconfig b/drivers/tty/Kconfig
index ee51b9514225..c7623f99ac0f 100644
--- a/drivers/tty/Kconfig
+++ b/drivers/tty/Kconfig
@@ -175,7 +175,7 @@ config ROCKETPORT
This driver supports Comtrol RocketPort and RocketModem PCI boards.
These boards provide 2, 4, 8, 16, or 32 high-speed serial ports or
modems. For information about the RocketPort/RocketModem boards
- and this driver read <file:Documentation/serial/rocket.rst>.
+ and this driver read <file:Documentation/driver-api/serial/rocket.rst>.
To compile this driver as a module, choose M here: the
module will be called rocket.
@@ -193,7 +193,7 @@ config CYCLADES
your Linux box, for instance in order to become a dial-in server.
For information about the Cyclades-Z card, read
- <file:Documentation/serial/cyclades_z.rst>.
+ <file:Documentation/driver-api/serial/cyclades_z.rst>.
To compile this driver as a module, choose M here: the
module will be called cyclades.
diff --git a/drivers/tty/serial/ucc_uart.c b/drivers/tty/serial/ucc_uart.c
index 6e3c66ab0e62..a0555ae2b1ef 100644
--- a/drivers/tty/serial/ucc_uart.c
+++ b/drivers/tty/serial/ucc_uart.c
@@ -1081,7 +1081,7 @@ static int qe_uart_verify_port(struct uart_port *port,
}
/* UART operations
*
- * Details on these functions can be found in Documentation/serial/driver.rst
+ * Details on these functions can be found in Documentation/driver-api/serial/driver.rst
*/
static const struct uart_ops qe_uart_pops = {
.tx_empty = qe_uart_tx_empty,
diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h
index 05b179015d6c..2b78cc734719 100644
--- a/include/linux/serial_core.h
+++ b/include/linux/serial_core.h
@@ -32,7 +32,7 @@ struct device;
/*
* This structure describes all the operations that can be done on the
- * physical hardware. See Documentation/serial/driver.rst for details.
+ * physical hardware. See Documentation/driver-api/serial/driver.rst for details.
*/
struct uart_ops {
unsigned int (*tx_empty)(struct uart_port *);
--
2.21.0
^ permalink raw reply related
* [PATCH 02/39] docs: rapidio: add it to the driver API
From: Mauro Carvalho Chehab @ 2019-06-28 12:29 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Matt Porter, Alexandre Bounine
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
This is actually a subsystem description, with contains both
kAPI and uAPI.
While it should ideally be slplit, let's place it at driver-api,
as most things are related to kAPI and driver-specific info.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/admin-guide/index.rst | 1 +
Documentation/{driver-api => admin-guide}/rapidio.rst | 0
Documentation/driver-api/index.rst | 2 +-
Documentation/{ => driver-api}/rapidio/index.rst | 2 --
Documentation/{ => driver-api}/rapidio/mport_cdev.rst | 0
Documentation/{ => driver-api}/rapidio/rapidio.rst | 0
Documentation/{ => driver-api}/rapidio/rio_cm.rst | 0
Documentation/{ => driver-api}/rapidio/sysfs.rst | 0
Documentation/{ => driver-api}/rapidio/tsi721.rst | 0
drivers/rapidio/Kconfig | 2 +-
10 files changed, 3 insertions(+), 4 deletions(-)
rename Documentation/{driver-api => admin-guide}/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/index.rst (94%)
rename Documentation/{ => driver-api}/rapidio/mport_cdev.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rio_cm.rst (100%)
rename Documentation/{ => driver-api}/rapidio/sysfs.rst (100%)
rename Documentation/{ => driver-api}/rapidio/tsi721.rst (100%)
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 8001917ee012..0066b198cad4 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -61,6 +61,7 @@ configure specific aspects of kernel behavior to your liking.
parport
md
module-signing
+ rapidio
sysrq
unicode
vga-softcursor
diff --git a/Documentation/driver-api/rapidio.rst b/Documentation/admin-guide/rapidio.rst
similarity index 100%
rename from Documentation/driver-api/rapidio.rst
rename to Documentation/admin-guide/rapidio.rst
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 4e503e360860..93c6c9a98c41 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -44,7 +44,7 @@ available subsections can be seen below.
miscellaneous
mei/index
w1
- rapidio
+ rapidio/index
s390-drivers
vme
80211/index
diff --git a/Documentation/rapidio/index.rst b/Documentation/driver-api/rapidio/index.rst
similarity index 94%
rename from Documentation/rapidio/index.rst
rename to Documentation/driver-api/rapidio/index.rst
index ab7b5541b346..4c5e51a05134 100644
--- a/Documentation/rapidio/index.rst
+++ b/Documentation/driver-api/rapidio/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
The Linux RapidIO Subsystem
===========================
diff --git a/Documentation/rapidio/mport_cdev.rst b/Documentation/driver-api/rapidio/mport_cdev.rst
similarity index 100%
rename from Documentation/rapidio/mport_cdev.rst
rename to Documentation/driver-api/rapidio/mport_cdev.rst
diff --git a/Documentation/rapidio/rapidio.rst b/Documentation/driver-api/rapidio/rapidio.rst
similarity index 100%
rename from Documentation/rapidio/rapidio.rst
rename to Documentation/driver-api/rapidio/rapidio.rst
diff --git a/Documentation/rapidio/rio_cm.rst b/Documentation/driver-api/rapidio/rio_cm.rst
similarity index 100%
rename from Documentation/rapidio/rio_cm.rst
rename to Documentation/driver-api/rapidio/rio_cm.rst
diff --git a/Documentation/rapidio/sysfs.rst b/Documentation/driver-api/rapidio/sysfs.rst
similarity index 100%
rename from Documentation/rapidio/sysfs.rst
rename to Documentation/driver-api/rapidio/sysfs.rst
diff --git a/Documentation/rapidio/tsi721.rst b/Documentation/driver-api/rapidio/tsi721.rst
similarity index 100%
rename from Documentation/rapidio/tsi721.rst
rename to Documentation/driver-api/rapidio/tsi721.rst
diff --git a/drivers/rapidio/Kconfig b/drivers/rapidio/Kconfig
index 467e8fa06904..677d1aff61b7 100644
--- a/drivers/rapidio/Kconfig
+++ b/drivers/rapidio/Kconfig
@@ -86,7 +86,7 @@ config RAPIDIO_CHMAN
This option includes RapidIO channelized messaging driver which
provides socket-like interface to allow sharing of single RapidIO
messaging mailbox between multiple user-space applications.
- See "Documentation/rapidio/rio_cm.rst" for driver description.
+ See "Documentation/driver-api/rapidio/rio_cm.rst" for driver description.
config RAPIDIO_MPORT_CDEV
tristate "RapidIO /dev mport device driver"
--
2.21.0
^ permalink raw reply related
* [PATCH 23/39] docs: lp855x-driver.rst: add it to the driver-api book
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, Milo Kim
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The content of this file is intended for backlight Kernel
developers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/{ => driver-api}/backlight/lp855x-driver.rst | 2 --
Documentation/driver-api/index.rst | 1 +
MAINTAINERS | 2 +-
3 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{ => driver-api}/backlight/lp855x-driver.rst (99%)
diff --git a/Documentation/backlight/lp855x-driver.rst b/Documentation/driver-api/backlight/lp855x-driver.rst
similarity index 99%
rename from Documentation/backlight/lp855x-driver.rst
rename to Documentation/driver-api/backlight/lp855x-driver.rst
index 62b7ed847a77..1e0b224fc397 100644
--- a/Documentation/backlight/lp855x-driver.rst
+++ b/Documentation/driver-api/backlight/lp855x-driver.rst
@@ -1,5 +1,3 @@
-:orphan:
-
====================
Kernel driver lp855x
====================
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index d41d1c561f01..fea0034afa56 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -66,6 +66,7 @@ available subsections can be seen below.
thermal/index
fpga/index
acpi/index
+ backlight/lp855x-driver.rst
generic-counter
.. only:: subproject and html
diff --git a/MAINTAINERS b/MAINTAINERS
index f723371dccd0..664e2a827544 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -15906,7 +15906,7 @@ F: sound/soc/codecs/isabelle*
TI LP855x BACKLIGHT DRIVER
M: Milo Kim <milo.kim@ti.com>
S: Maintained
-F: Documentation/backlight/lp855x-driver.rst
+F: Documentation/driver-api/backlight/lp855x-driver.rst
F: drivers/video/backlight/lp855x_bl.c
F: include/linux/platform_data/lp855x.h
--
2.21.0
^ permalink raw reply related
* [PATCH 00/39] Don't let ReST documents orphaned
From: Mauro Carvalho Chehab @ 2019-06-28 12:29 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet
The goal on this series is to not let ReST documents orphaned.
It moves files that are already on ReST format to a better place,
when needed, and add them to the documentation body.
On my past attempt, I was too "aggressive" trying to move all files
under Documentation/*.txt to some place. It ends that I did some
mistakes, so, on this series, I opted to do the reverse: I only moved
files that seemed to obviously belong to some place.
So, after this patch series, there will still 44 orphaned document
files under Documentation/*.txt, to be addressed on a next Kernel
version.
After this series, there will be "only" 386 files with the .txt extension:
$ find Documentation/ -name '*.txt'|grep -v features/|grep -v devicetree|grep -v output|wc -l
386
(I'm excluding features, as those aren't really a text file, but a sort
of textual database)
The end result of this patch series (plus the other ones I sent today)
is at:
https://www.infradead.org/~mchehab/rst_conversion/
And the full documentation patch series at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=convert_rst_renames_v7.1
Mauro Carvalho Chehab (39):
docs: thermal: add it to the driver API
docs: rapidio: add it to the driver API
docs: perf: move to the admin-guide
docs: nvdimm: add it to the driver-api book
docs: namespace: move it to the admin-guide
docs: mtd: move it to the driver-api book
docs: nfc: add it to the driver-api book
docs: mmc: move it to the driver-api
docs: md: move it to the driver-api book
docs: leds: add it to the driver-api book
docs: ioctl: add it to the uAPI guide
docs: interconnect.rst: add it to the driver-api guide
docs: add arch doc directories to the index
docs: device-mapper: move it to the admin-guide
docs: early-userspace: move to driver-api guide
docs: admin-guide: move sysctl directory to it
docs: admin-guide: add laptops documentation
docs: admin-guide: add kdump documentation into it
docs: blockdev: add it to the admin-guide
docs: security: move some books to it and update
docs: x86: move two x86-specific files to x86 arch dir
docs: ocxl.rst: add it to the uAPI book
docs: lp855x-driver.rst: add it to the driver-api book
docs: driver-model: move it to the driver-api book
docs: add some documentation dirs to the driver-api book
docs: aoe: add it to the driver-api book
docs: cgroup-v1: add it to the admin-guide book
docs: admin-guide: add a series of orphaned documents
docs: driver-api: add a series of orphaned documents
docs: driver-api: add xilinx driver API documentation
docs: driver-api: add remaining converted dirs to it
docs: serial: move it to the driver-api
docs: phy: place documentation under driver-api
docs: add a memory-devices subdir to driver-api
docs: infiniband: add it to the driver-api bookset
docs: add SPDX tags to new index files
docs: adds some directories to the main documentation index
docs: locking: add it to the main index
docs: gpio: add sysfs interface to the admin-guide
CREDITS | 2 +-
Documentation/ABI/obsolete/sysfs-gpio | 2 +-
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-diskstats | 2 +-
Documentation/ABI/testing/sysfs-block | 2 +-
Documentation/ABI/testing/sysfs-block-device | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
.../ABI/testing/sysfs-devices-system-cpu | 4 +-
.../ABI/testing/sysfs-platform-asus-laptop | 2 +-
Documentation/accounting/index.rst | 2 +-
Documentation/{ => admin-guide}/aoe/aoe.rst | 4 +-
.../{ => admin-guide}/aoe/autoload.sh | 0
.../{ => admin-guide}/aoe/examples.rst | 0
Documentation/{ => admin-guide}/aoe/index.rst | 2 -
Documentation/{ => admin-guide}/aoe/status.sh | 0
Documentation/{ => admin-guide}/aoe/todo.rst | 0
.../{ => admin-guide}/aoe/udev-install.sh | 0
Documentation/{ => admin-guide}/aoe/udev.txt | 2 +-
.../blockdev/drbd/DRBD-8.3-data-packets.svg | 0
.../blockdev/drbd/DRBD-data-packets.svg | 0
.../blockdev/drbd/conn-states-8.dot | 0
.../blockdev/drbd/data-structure-v9.rst | 0
.../blockdev/drbd/disk-states-8.dot | 0
.../drbd/drbd-connection-state-overview.dot | 0
.../blockdev/drbd/figures.rst | 2 +
.../{ => admin-guide}/blockdev/drbd/index.rst | 0
.../blockdev/drbd/node-states-8.dot | 1 -
.../{ => admin-guide}/blockdev/floppy.rst | 0
.../{ => admin-guide}/blockdev/index.rst | 2 +-
.../{ => admin-guide}/blockdev/nbd.rst | 0
.../{ => admin-guide}/blockdev/paride.rst | 0
.../{ => admin-guide}/blockdev/ramdisk.rst | 0
.../{ => admin-guide}/blockdev/zram.rst | 0
.../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
Documentation/admin-guide/bug-hunting.rst | 4 +-
.../cgroup-v1/blkio-controller.rst | 0
.../{ => admin-guide}/cgroup-v1/cgroups.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/cpuacct.rst | 0
.../{ => admin-guide}/cgroup-v1/cpusets.rst | 2 +-
.../{ => admin-guide}/cgroup-v1/devices.rst | 0
.../cgroup-v1/freezer-subsystem.rst | 0
.../{ => admin-guide}/cgroup-v1/hugetlb.rst | 0
.../{ => admin-guide}/cgroup-v1/index.rst | 2 -
.../cgroup-v1/memcg_test.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/memory.rst | 0
.../{ => admin-guide}/cgroup-v1/net_cls.rst | 0
.../{ => admin-guide}/cgroup-v1/net_prio.rst | 0
.../{ => admin-guide}/cgroup-v1/pids.rst | 0
.../{ => admin-guide}/cgroup-v1/rdma.rst | 0
Documentation/admin-guide/cgroup-v2.rst | 2 +-
.../clearing-warn-once.rst} | 0
.../cpu-load.rst} | 0
.../cputopology.rst} | 0
.../device-mapper/cache-policies.rst | 0
.../{ => admin-guide}/device-mapper/cache.rst | 0
.../{ => admin-guide}/device-mapper/delay.rst | 0
.../device-mapper/dm-crypt.rst | 0
.../device-mapper/dm-dust.txt | 0
.../device-mapper/dm-flakey.rst | 0
.../device-mapper/dm-init.rst | 0
.../device-mapper/dm-integrity.rst | 0
.../{ => admin-guide}/device-mapper/dm-io.rst | 0
.../device-mapper/dm-log.rst | 0
.../device-mapper/dm-queue-length.rst | 0
.../device-mapper/dm-raid.rst | 0
.../device-mapper/dm-service-time.rst | 0
.../device-mapper/dm-uevent.rst | 0
.../device-mapper/dm-zoned.rst | 0
.../{ => admin-guide}/device-mapper/era.rst | 0
.../{ => admin-guide}/device-mapper/index.rst | 2 -
.../device-mapper/kcopyd.rst | 0
.../device-mapper/linear.rst | 0
.../device-mapper/log-writes.rst | 0
.../device-mapper/persistent-data.rst | 0
.../device-mapper/snapshot.rst | 0
.../device-mapper/statistics.rst | 4 +-
.../device-mapper/striped.rst | 0
.../device-mapper/switch.rst | 0
.../device-mapper/thin-provisioning.rst | 0
.../device-mapper/unstriped.rst | 0
.../device-mapper/verity.rst | 0
.../device-mapper/writecache.rst | 0
.../{ => admin-guide}/device-mapper/zero.rst | 0
.../efi-stub.rst} | 0
.../{ => admin-guide}/gpio/index.rst | 2 +-
.../{ => admin-guide}/gpio/sysfs.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 | 28 +++++++
.../{iostats.txt => admin-guide/iostats.rst} | 0
.../{ => admin-guide}/kdump/gdbmacros.txt | 0
.../{ => admin-guide}/kdump/index.rst | 1 -
.../{ => admin-guide}/kdump/kdump.rst | 0
.../{ => admin-guide}/kdump/vmcoreinfo.rst | 0
.../admin-guide/kernel-parameters.txt | 36 ++++----
.../kernel-per-CPU-kthreads.rst} | 2 +-
.../{ => admin-guide}/laptops/asus-laptop.rst | 0
.../laptops/disk-shock-protection.rst | 0
.../{ => admin-guide}/laptops/index.rst | 2 +-
.../{ => admin-guide}/laptops/laptop-mode.rst | 0
.../{ => admin-guide}/laptops/lg-laptop.rst | 1 -
.../{ => admin-guide}/laptops/sony-laptop.rst | 0
.../{ => admin-guide}/laptops/sonypi.rst | 0
.../laptops/thinkpad-acpi.rst | 6 +-
.../laptops/toshiba_haps.rst | 0
.../lcd-panel-cgram.rst | 2 -
.../{ldm.txt => admin-guide/ldm.rst} | 0
.../lockup-watchdogs.rst} | 0
.../mm/cma_debugfs.rst} | 2 -
Documentation/admin-guide/mm/index.rst | 3 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
.../admin-guide/mm/numa_memory_policy.rst | 2 +-
.../namespaces/compatibility-list.rst | 0
.../{ => admin-guide}/namespaces/index.rst | 2 +-
.../namespaces/resource-control.rst | 0
.../numastat.rst} | 0
.../{ => admin-guide}/perf/arm-ccn.rst | 0
.../{ => admin-guide}/perf/arm_dsu_pmu.rst | 0
.../{ => admin-guide}/perf/hisi-pmu.rst | 0
.../{ => admin-guide}/perf/index.rst | 2 +-
.../{ => admin-guide}/perf/qcom_l2_pmu.rst | 0
.../{ => admin-guide}/perf/qcom_l3_pmu.rst | 0
.../{ => admin-guide}/perf/thunderx2-pmu.rst | 0
.../{ => admin-guide}/perf/xgene-pmu.rst | 0
.../{pnp.txt => admin-guide/pnp.rst} | 0
.../{driver-api => admin-guide}/rapidio.rst | 0
.../{rtc.txt => admin-guide/rtc.rst} | 0
.../{svga.txt => admin-guide/svga.rst} | 0
.../{ => admin-guide}/sysctl/abi.rst | 0
Documentation/{ => admin-guide}/sysctl/fs.rst | 0
.../{ => admin-guide}/sysctl/index.rst | 2 -
.../{ => admin-guide}/sysctl/kernel.rst | 2 +-
.../{ => admin-guide}/sysctl/net.rst | 0
.../{ => admin-guide}/sysctl/sunrpc.rst | 0
.../{ => admin-guide}/sysctl/user.rst | 0
Documentation/{ => admin-guide}/sysctl/vm.rst | 4 +-
.../video-output.rst} | 0
Documentation/arm/index.rst | 2 +-
Documentation/arm/nwfpe/index.rst | 2 +
Documentation/arm/omap/index.rst | 2 +
Documentation/arm/sa1100/index.rst | 2 +
Documentation/arm/samsung-s3c24xx/index.rst | 2 +
Documentation/arm/samsung/index.rst | 2 +
Documentation/arm64/index.rst | 2 -
Documentation/block/bfq-iosched.rst | 2 +-
Documentation/block/index.rst | 2 +-
Documentation/cdrom/index.rst | 2 +-
Documentation/core-api/printk-formats.rst | 2 +-
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
.../devicetree/bindings/phy/phy-pxa-usb.txt | 2 +-
.../backlight/lp855x-driver.rst | 2 -
.../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
.../{ => driver-api}/driver-model/binding.rst | 0
.../{ => driver-api}/driver-model/bus.rst | 0
.../{ => driver-api}/driver-model/class.rst | 0
.../driver-model/design-patterns.rst | 0
.../{ => driver-api}/driver-model/device.rst | 0
.../{ => driver-api}/driver-model/devres.rst | 0
.../{ => driver-api}/driver-model/driver.rst | 0
.../{ => driver-api}/driver-model/index.rst | 2 -
.../driver-model/overview.rst | 0
.../driver-model/platform.rst | 0
.../{ => driver-api}/driver-model/porting.rst | 2 +-
.../early-userspace/buffer-format.rst | 0
.../early_userspace_support.rst | 0
.../early-userspace/index.rst | 2 +-
.../{EDID/howto.rst => driver-api/edid.rst} | 2 +-
.../{eisa.txt => driver-api/eisa.rst} | 4 +-
Documentation/driver-api/gpio/driver.rst | 2 +-
Documentation/driver-api/index.rst | 44 +++++++++-
.../interconnect.rst | 2 -
Documentation/{isa.txt => driver-api/isa.rst} | 0
.../{isapnp.txt => driver-api/isapnp.rst} | 0
.../pblk.txt => driver-api/lightnvm-pblk.rst} | 0
Documentation/{ => driver-api}/md/index.rst | 2 +-
.../{ => driver-api}/md/md-cluster.rst | 0
.../{ => driver-api}/md/raid5-cache.rst | 0
.../{ => driver-api}/md/raid5-ppl.rst | 0
.../driver-api/memory-devices/index.rst | 18 ++++
.../memory-devices/ti-emif.rst | 2 +-
.../memory-devices}/ti-gpmc.rst | 2 +-
.../men-chameleon-bus.rst} | 0
Documentation/{ => driver-api}/mmc/index.rst | 2 +-
.../{ => driver-api}/mmc/mmc-async-req.rst | 0
.../{ => driver-api}/mmc/mmc-dev-attrs.rst | 0
.../{ => driver-api}/mmc/mmc-dev-parts.rst | 0
.../{ => driver-api}/mmc/mmc-tools.rst | 0
Documentation/{ => driver-api}/mtd/index.rst | 2 +-
.../{ => driver-api}/mtd/intel-spi.rst | 0
.../{ => driver-api}/mtd/nand_ecc.rst | 0
.../{ => driver-api}/mtd/spi-nor.rst | 0
Documentation/{ => driver-api}/nfc/index.rst | 2 +-
.../{ => driver-api}/nfc/nfc-hci.rst | 0
.../{ => driver-api}/nfc/nfc-pn544.rst | 0
Documentation/{ntb.txt => driver-api/ntb.rst} | 0
Documentation/{ => driver-api}/nvdimm/btt.rst | 0
.../{ => driver-api}/nvdimm/index.rst | 2 +-
.../{ => driver-api}/nvdimm/nvdimm.rst | 0
.../{ => driver-api}/nvdimm/security.rst | 0
Documentation/{nvmem => driver-api}/nvmem.rst | 2 +-
.../parport-lowlevel.rst} | 0
Documentation/driver-api/phy/index.rst | 18 ++++
.../{phy.txt => driver-api/phy/phy.rst} | 0
.../{ => driver-api}/phy/samsung-usb2.rst | 2 -
Documentation/driver-api/pps.rst | 2 +-
.../{pti => driver-api}/pti_intel_mid.rst | 2 +-
Documentation/driver-api/ptp.rst | 2 +-
Documentation/{pwm.txt => driver-api/pwm.rst} | 0
.../{ => driver-api}/rapidio/index.rst | 2 +-
.../{ => driver-api}/rapidio/mport_cdev.rst | 0
.../{ => driver-api}/rapidio/rapidio.rst | 0
.../{ => driver-api}/rapidio/rio_cm.rst | 0
.../{ => driver-api}/rapidio/sysfs.rst | 0
.../{ => driver-api}/rapidio/tsi721.rst | 0
.../{rfkill.txt => driver-api/rfkill.rst} | 0
.../{ => driver-api}/serial/cyclades_z.rst | 0
.../{ => driver-api}/serial/driver.rst | 2 +-
.../{ => driver-api}/serial/index.rst | 2 +-
.../{ => driver-api}/serial/moxa-smartio.rst | 0
.../{ => driver-api}/serial/n_gsm.rst | 0
.../{ => driver-api}/serial/rocket.rst | 0
.../serial/serial-iso7816.rst | 0
.../{ => driver-api}/serial/serial-rs485.rst | 0
Documentation/{ => driver-api}/serial/tty.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
.../thermal/cpu-cooling-api.rst | 0
.../thermal/exynos_thermal.rst | 0
.../thermal/exynos_thermal_emulation.rst | 0
.../{ => driver-api}/thermal/index.rst | 2 +-
.../thermal/intel_powerclamp.rst | 0
.../thermal/nouveau_thermal.rst | 0
.../thermal/power_allocator.rst | 0
.../{ => driver-api}/thermal/sysfs-api.rst | 12 +--
.../thermal/x86_pkg_temperature_thermal.rst | 2 +-
.../vfio-mediated-device.rst} | 2 +-
.../{vfio.txt => driver-api/vfio.rst} | 0
.../{ => driver-api}/xilinx/eemi.rst | 0
.../{ => driver-api}/xilinx/index.rst | 1 -
.../{xillybus.txt => driver-api/xillybus.rst} | 0
.../{zorro.txt => driver-api/zorro.rst} | 0
Documentation/fault-injection/index.rst | 2 +-
Documentation/fb/fbcon.rst | 4 +-
Documentation/fb/index.rst | 2 +-
Documentation/fb/vesafb.rst | 2 +-
Documentation/filesystems/nfs/nfsroot.txt | 2 +-
Documentation/filesystems/proc.txt | 2 +-
.../filesystems/ramfs-rootfs-initramfs.txt | 4 +-
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/filesystems/tmpfs.txt | 2 +-
.../firmware-guide/acpi/enumeration.rst | 2 +-
Documentation/fpga/index.rst | 2 +-
Documentation/hid/index.rst | 2 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
Documentation/ia64/index.rst | 2 +-
Documentation/ide/index.rst | 2 +-
Documentation/iio/index.rst | 2 +-
Documentation/index.rst | 34 ++++++++
Documentation/infiniband/index.rst | 2 +-
Documentation/ioctl/index.rst | 2 +-
Documentation/ioctl/ioctl-number.rst | 2 -
Documentation/kbuild/index.rst | 2 +-
Documentation/leds/index.rst | 2 +-
Documentation/livepatch/index.rst | 2 +-
Documentation/locking/index.rst | 2 +-
Documentation/m68k/index.rst | 2 +-
Documentation/mic/index.rst | 2 -
Documentation/netlabel/index.rst | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/pcmcia/index.rst | 2 +-
Documentation/power/index.rst | 2 +-
.../powerpc/firmware-assisted-dump.rst | 2 +-
Documentation/powerpc/index.rst | 2 +-
Documentation/riscv/index.rst | 2 -
Documentation/s390/index.rst | 2 -
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/scheduler/index.rst | 2 -
Documentation/scheduler/sched-deadline.rst | 2 +-
Documentation/scheduler/sched-design-CFS.rst | 2 +-
Documentation/scheduler/sched-rt-group.rst | 2 +-
Documentation/security/index.rst | 5 +-
.../security/{LSM.rst => lsm-development.rst} | 0
Documentation/{lsm.txt => security/lsm.rst} | 0
Documentation/{SAK.txt => security/sak.rst} | 0
.../{siphash.txt => security/siphash.rst} | 0
Documentation/security/tpm/index.rst | 1 +
Documentation/security/tpm/xen-tpmfront.rst | 2 -
Documentation/sparc/index.rst | 2 -
Documentation/target/index.rst | 2 +-
Documentation/timers/index.rst | 2 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
Documentation/translations/zh_CN/gpio.txt | 4 +-
.../translations/zh_CN/oops-tracing.txt | 4 +-
.../{ => userspace-api}/accelerators/ocxl.rst | 2 -
Documentation/userspace-api/index.rst | 1 +
Documentation/vm/numa.rst | 4 +-
Documentation/vm/page_migration.rst | 2 +-
Documentation/vm/unevictable-lru.rst | 4 +-
Documentation/w1/w1.netlink | 2 +-
Documentation/watchdog/hpwdt.rst | 2 +-
Documentation/watchdog/index.rst | 2 +-
Documentation/x86/index.rst | 2 +
.../{Intel-IOMMU.txt => x86/intel-iommu.rst} | 0
.../{intel_txt.txt => x86/intel_txt.rst} | 0
Documentation/x86/topology.rst | 2 +-
.../x86/x86_64/fake-numa-for-cpusets.rst | 4 +-
Documentation/xtensa/index.rst | 2 +-
MAINTAINERS | 82 +++++++++----------
Next/merge.log | 4 +-
arch/arm/Kconfig | 4 +-
arch/arm64/Kconfig | 2 +-
arch/parisc/Kconfig | 2 +-
arch/sh/Kconfig | 4 +-
arch/sparc/Kconfig | 2 +-
arch/x86/Kconfig | 8 +-
block/Kconfig | 2 +-
block/partitions/Kconfig | 2 +-
drivers/base/platform.c | 2 +-
drivers/block/Kconfig | 8 +-
drivers/block/floppy.c | 2 +-
drivers/block/zram/Kconfig | 6 +-
drivers/char/Kconfig | 6 +-
drivers/char/hw_random/core.c | 2 +-
drivers/dma-buf/Kconfig | 2 +-
drivers/gpio/Kconfig | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/gpu/drm/Kconfig | 2 +-
drivers/md/Kconfig | 2 +-
drivers/md/dm-init.c | 2 +-
drivers/md/dm-raid.c | 2 +-
drivers/mtd/nand/raw/nand_ecc.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
drivers/nvdimm/Kconfig | 2 +-
drivers/pci/switch/Kconfig | 2 +-
drivers/perf/qcom_l3_pmu.c | 2 +-
drivers/platform/x86/Kconfig | 8 +-
drivers/platform/x86/dcdbas.c | 2 +-
drivers/platform/x86/dell_rbu.c | 2 +-
drivers/pnp/isapnp/Kconfig | 2 +-
drivers/rapidio/Kconfig | 2 +-
.../staging/unisys/Documentation/overview.txt | 4 +-
drivers/tty/Kconfig | 6 +-
drivers/tty/serial/ucc_uart.c | 2 +-
drivers/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
drivers/w1/Kconfig | 2 +-
fs/proc/Kconfig | 2 +-
include/linux/cgroup-defs.h | 2 +-
include/linux/device.h | 2 +-
include/linux/hw_random.h | 2 +-
include/linux/platform_device.h | 2 +-
include/linux/serial_core.h | 2 +-
include/linux/thermal.h | 4 +-
include/uapi/linux/bpf.h | 2 +-
init/Kconfig | 4 +-
kernel/cgroup/cpuset.c | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
samples/Kconfig | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
security/Kconfig | 2 +-
security/device_cgroup.c | 2 +-
tools/include/uapi/linux/bpf.h | 2 +-
tools/testing/selftests/zram/README | 2 +-
usr/Kconfig | 2 +-
375 files changed, 436 insertions(+), 318 deletions(-)
rename Documentation/{ => admin-guide}/aoe/aoe.rst (97%)
rename Documentation/{ => admin-guide}/aoe/autoload.sh (100%)
rename Documentation/{ => admin-guide}/aoe/examples.rst (100%)
rename Documentation/{ => admin-guide}/aoe/index.rst (95%)
rename Documentation/{ => admin-guide}/aoe/status.sh (100%)
rename Documentation/{ => admin-guide}/aoe/todo.rst (100%)
rename Documentation/{ => admin-guide}/aoe/udev-install.sh (100%)
rename Documentation/{ => admin-guide}/aoe/udev.txt (93%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-8.3-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/conn-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/data-structure-v9.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/disk-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/drbd-connection-state-overview.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/figures.rst (95%)
rename Documentation/{ => admin-guide}/blockdev/drbd/index.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/node-states-8.dot (99%)
rename Documentation/{ => admin-guide}/blockdev/floppy.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/index.rst (83%)
rename Documentation/{ => admin-guide}/blockdev/nbd.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/paride.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/ramdisk.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/zram.rst (100%)
rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/blkio-controller.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/devices.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/freezer-subsystem.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/index.rst (97%)
rename Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst (98%)
rename Documentation/{ => admin-guide}/cgroup-v1/memory.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/pids.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/rdma.rst (100%)
rename Documentation/{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/{ => admin-guide}/device-mapper/cache-policies.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/cache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/delay.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-crypt.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-dust.txt (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-flakey.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-init.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-integrity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-io.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-log.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-queue-length.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-raid.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-service-time.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-uevent.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-zoned.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/era.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/index.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/kcopyd.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/linear.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/log-writes.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/persistent-data.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/snapshot.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/statistics.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/striped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/switch.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/thin-provisioning.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/unstriped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/verity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/writecache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/zero.rst (100%)
rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
rename Documentation/{ => admin-guide}/gpio/index.rst (78%)
rename Documentation/{ => admin-guide}/gpio/sysfs.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/{ => admin-guide}/kdump/gdbmacros.txt (100%)
rename Documentation/{ => admin-guide}/kdump/index.rst (97%)
rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%)
rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%)
rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (99%)
rename Documentation/{ => admin-guide}/laptops/asus-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/disk-shock-protection.rst (100%)
rename Documentation/{ => admin-guide}/laptops/index.rst (84%)
rename Documentation/{ => admin-guide}/laptops/laptop-mode.rst (100%)
rename Documentation/{ => admin-guide}/laptops/lg-laptop.rst (99%)
rename Documentation/{ => admin-guide}/laptops/sony-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/sonypi.rst (100%)
rename Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst (99%)
rename Documentation/{ => admin-guide}/laptops/toshiba_haps.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/{ => admin-guide}/namespaces/compatibility-list.rst (100%)
rename Documentation/{ => admin-guide}/namespaces/index.rst (74%)
rename Documentation/{ => admin-guide}/namespaces/resource-control.rst (100%)
rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%)
rename Documentation/{ => admin-guide}/perf/arm-ccn.rst (100%)
rename Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/hisi-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/index.rst (85%)
rename Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/xgene-pmu.rst (100%)
rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%)
rename Documentation/{driver-api => admin-guide}/rapidio.rst (100%)
rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%)
rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
rename Documentation/{ => admin-guide}/sysctl/abi.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/fs.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/index.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/kernel.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/net.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/sunrpc.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/user.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/vm.rst (99%)
rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)
rename Documentation/{ => driver-api}/backlight/lp855x-driver.rst (99%)
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/{ => driver-api}/driver-model/binding.rst (100%)
rename Documentation/{ => driver-api}/driver-model/bus.rst (100%)
rename Documentation/{ => driver-api}/driver-model/class.rst (100%)
rename Documentation/{ => driver-api}/driver-model/design-patterns.rst (100%)
rename Documentation/{ => driver-api}/driver-model/device.rst (100%)
rename Documentation/{ => driver-api}/driver-model/devres.rst (100%)
rename Documentation/{ => driver-api}/driver-model/driver.rst (100%)
rename Documentation/{ => driver-api}/driver-model/index.rst (96%)
rename Documentation/{ => driver-api}/driver-model/overview.rst (100%)
rename Documentation/{ => driver-api}/driver-model/platform.rst (100%)
rename Documentation/{ => driver-api}/driver-model/porting.rst (99%)
rename Documentation/{ => driver-api}/early-userspace/buffer-format.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/early_userspace_support.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/index.rst (85%)
rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (98%)
rename Documentation/{eisa.txt => driver-api/eisa.rst} (98%)
rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)
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/{ => driver-api}/md/index.rst (71%)
rename Documentation/{ => driver-api}/md/md-cluster.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-cache.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-ppl.rst (100%)
create mode 100644 Documentation/driver-api/memory-devices/index.rst
rename Documentation/{ => driver-api}/memory-devices/ti-emif.rst (98%)
rename Documentation/{bus-devices => driver-api/memory-devices}/ti-gpmc.rst (99%)
rename Documentation/{men-chameleon-bus.txt => driver-api/men-chameleon-bus.rst} (100%)
rename Documentation/{ => driver-api}/mmc/index.rst (82%)
rename Documentation/{ => driver-api}/mmc/mmc-async-req.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-tools.rst (100%)
rename Documentation/{ => driver-api}/mtd/index.rst (81%)
rename Documentation/{ => driver-api}/mtd/intel-spi.rst (100%)
rename Documentation/{ => driver-api}/mtd/nand_ecc.rst (100%)
rename Documentation/{ => driver-api}/mtd/spi-nor.rst (100%)
rename Documentation/{ => driver-api}/nfc/index.rst (78%)
rename Documentation/{ => driver-api}/nfc/nfc-hci.rst (100%)
rename Documentation/{ => driver-api}/nfc/nfc-pn544.rst (100%)
rename Documentation/{ntb.txt => driver-api/ntb.rst} (100%)
rename Documentation/{ => driver-api}/nvdimm/btt.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/index.rst (82%)
rename Documentation/{ => driver-api}/nvdimm/nvdimm.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/security.rst (100%)
rename Documentation/{nvmem => driver-api}/nvmem.rst (99%)
rename Documentation/{parport-lowlevel.txt => driver-api/parport-lowlevel.rst} (100%)
create mode 100644 Documentation/driver-api/phy/index.rst
rename Documentation/{phy.txt => driver-api/phy/phy.rst} (100%)
rename Documentation/{ => driver-api}/phy/samsung-usb2.rst (99%)
rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%)
rename Documentation/{pwm.txt => driver-api/pwm.rst} (100%)
rename Documentation/{ => driver-api}/rapidio/index.rst (82%)
rename Documentation/{ => driver-api}/rapidio/mport_cdev.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rio_cm.rst (100%)
rename Documentation/{ => driver-api}/rapidio/sysfs.rst (100%)
rename Documentation/{ => driver-api}/rapidio/tsi721.rst (100%)
rename Documentation/{rfkill.txt => driver-api/rfkill.rst} (100%)
rename Documentation/{ => driver-api}/serial/cyclades_z.rst (100%)
rename Documentation/{ => driver-api}/serial/driver.rst (99%)
rename Documentation/{ => driver-api}/serial/index.rst (90%)
rename Documentation/{ => driver-api}/serial/moxa-smartio.rst (100%)
rename Documentation/{ => driver-api}/serial/n_gsm.rst (100%)
rename Documentation/{ => driver-api}/serial/rocket.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-iso7816.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-rs485.rst (100%)
rename Documentation/{ => driver-api}/serial/tty.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/{ => driver-api}/thermal/cpu-cooling-api.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal_emulation.rst (100%)
rename Documentation/{ => driver-api}/thermal/index.rst (86%)
rename Documentation/{ => driver-api}/thermal/intel_powerclamp.rst (100%)
rename Documentation/{ => driver-api}/thermal/nouveau_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/power_allocator.rst (100%)
rename Documentation/{ => driver-api}/thermal/sysfs-api.rst (98%)
rename Documentation/{ => driver-api}/thermal/x86_pkg_temperature_thermal.rst (94%)
rename Documentation/{vfio-mediated-device.txt => driver-api/vfio-mediated-device.rst} (99%)
rename Documentation/{vfio.txt => driver-api/vfio.rst} (100%)
rename Documentation/{ => driver-api}/xilinx/eemi.rst (100%)
rename Documentation/{ => driver-api}/xilinx/index.rst (94%)
rename Documentation/{xillybus.txt => driver-api/xillybus.rst} (100%)
rename Documentation/{zorro.txt => driver-api/zorro.rst} (100%)
rename Documentation/security/{LSM.rst => lsm-development.rst} (100%)
rename Documentation/{lsm.txt => security/lsm.rst} (100%)
rename Documentation/{SAK.txt => security/sak.rst} (100%)
rename Documentation/{siphash.txt => security/siphash.rst} (100%)
rename Documentation/{ => userspace-api}/accelerators/ocxl.rst (99%)
rename Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} (100%)
rename Documentation/{intel_txt.txt => x86/intel_txt.rst} (100%)
--
2.21.0
^ permalink raw reply
* [PATCH 35/39] docs: infiniband: add it to the driver-api bookset
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, Doug Ledford, Jason Gunthorpe, linux-rdma
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
While this contains some uAPI stuff, it was intended to be
read by a kernel doc. So, let's not move it to a different
dir, but, instead, just add it to the driver-api bookset.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/index.rst | 1 +
Documentation/infiniband/index.rst | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index ea33cbbccd9d..e69d2fde7735 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -96,6 +96,7 @@ needed).
block/index
hid/index
iio/index
+ infiniband/index
leds/index
media/index
networking/index
diff --git a/Documentation/infiniband/index.rst b/Documentation/infiniband/index.rst
index 22eea64de722..9cd7615438b9 100644
--- a/Documentation/infiniband/index.rst
+++ b/Documentation/infiniband/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
==========
InfiniBand
--
2.21.0
^ permalink raw reply related
* [PATCH 21/39] docs: x86: move two x86-specific files to x86 arch dir
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, Thomas Gleixner, Ingo Molnar, Borislav Petkov,
H. Peter Anvin, x86, Ning Sun, James Morris, Serge E. Hallyn,
tboot-devel, linux-security-module
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
Those two docs belong to the x86 architecture:
Documentation/Intel-IOMMU.txt -> Documentation/x86/intel-iommu.rst
Documentation/intel_txt.txt -> Documentation/x86/intel_txt.rst
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/x86/index.rst | 2 ++
Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} | 0
Documentation/{intel_txt.txt => x86/intel_txt.rst} | 0
MAINTAINERS | 2 +-
security/Kconfig | 2 +-
5 files changed, 4 insertions(+), 2 deletions(-)
rename Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} (100%)
rename Documentation/{intel_txt.txt => x86/intel_txt.rst} (100%)
diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst
index f2de1b2d3ac7..af64c4bb4447 100644
--- a/Documentation/x86/index.rst
+++ b/Documentation/x86/index.rst
@@ -20,6 +20,8 @@ x86-specific Documentation
mtrr
pat
intel_mpx
+ intel-iommu
+ intel_txt
amd-memory-encryption
pti
mds
diff --git a/Documentation/Intel-IOMMU.txt b/Documentation/x86/intel-iommu.rst
similarity index 100%
rename from Documentation/Intel-IOMMU.txt
rename to Documentation/x86/intel-iommu.rst
diff --git a/Documentation/intel_txt.txt b/Documentation/x86/intel_txt.rst
similarity index 100%
rename from Documentation/intel_txt.txt
rename to Documentation/x86/intel_txt.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 3f0f654d1166..29d1498ad39d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8259,7 +8259,7 @@ L: tboot-devel@lists.sourceforge.net
W: http://tboot.sourceforge.net
T: hg http://tboot.hg.sourceforge.net:8000/hgroot/tboot/tboot
S: Supported
-F: Documentation/intel_txt.txt
+F: Documentation/x86/intel_txt.rst
F: include/linux/tboot.h
F: arch/x86/kernel/tboot.c
diff --git a/security/Kconfig b/security/Kconfig
index 06a30851511a..0d65594b5196 100644
--- a/security/Kconfig
+++ b/security/Kconfig
@@ -121,7 +121,7 @@ config INTEL_TXT
See <http://www.intel.com/technology/security/> for more information
about Intel(R) TXT.
See <http://tboot.sourceforge.net> for more information about tboot.
- See Documentation/intel_txt.txt for a description of how to enable
+ See Documentation/x86/intel_txt.rst for a description of how to enable
Intel TXT support in a kernel boot.
If you are unsure as to whether this is required, answer N.
--
2.21.0
^ permalink raw reply related
* [PATCH 38/39] docs: locking: add it to the main index
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, Peter Zijlstra, Ingo Molnar, Will Deacon
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The locking directory is part of the Kernel API bookset. Add
it to the index file.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/index.rst | 1 +
Documentation/locking/index.rst | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 075c732501a2..13c3188f6a68 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -96,6 +96,7 @@ needed).
driver-api/index
core-api/index
+ locking/index
accounting/index
block/index
cdrom/index
diff --git a/Documentation/locking/index.rst b/Documentation/locking/index.rst
index ef5da7fe9aac..626a463f7e42 100644
--- a/Documentation/locking/index.rst
+++ b/Documentation/locking/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=======
locking
--
2.21.0
^ permalink raw reply related
* [PATCH 14/39] docs: device-mapper: move it to the admin-guide
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,
Shaohua Li, linux-raid
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The DM support describes lots of aspects related to mapped
disk partitions from the userspace PoV.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
.../{ => admin-guide}/device-mapper/cache-policies.rst | 0
Documentation/{ => admin-guide}/device-mapper/cache.rst | 0
Documentation/{ => admin-guide}/device-mapper/delay.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-crypt.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-dust.txt | 0
Documentation/{ => admin-guide}/device-mapper/dm-flakey.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-init.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-integrity.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-io.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-log.rst | 0
.../{ => admin-guide}/device-mapper/dm-queue-length.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-raid.rst | 0
.../{ => admin-guide}/device-mapper/dm-service-time.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-uevent.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-zoned.rst | 0
Documentation/{ => admin-guide}/device-mapper/era.rst | 0
Documentation/{ => admin-guide}/device-mapper/index.rst | 2 --
Documentation/{ => admin-guide}/device-mapper/kcopyd.rst | 0
Documentation/{ => admin-guide}/device-mapper/linear.rst | 0
Documentation/{ => admin-guide}/device-mapper/log-writes.rst | 0
.../{ => admin-guide}/device-mapper/persistent-data.rst | 0
Documentation/{ => admin-guide}/device-mapper/snapshot.rst | 0
Documentation/{ => admin-guide}/device-mapper/statistics.rst | 0
Documentation/{ => admin-guide}/device-mapper/striped.rst | 0
Documentation/{ => admin-guide}/device-mapper/switch.rst | 0
.../{ => admin-guide}/device-mapper/thin-provisioning.rst | 0
Documentation/{ => admin-guide}/device-mapper/unstriped.rst | 0
Documentation/{ => admin-guide}/device-mapper/verity.rst | 0
Documentation/{ => admin-guide}/device-mapper/writecache.rst | 0
Documentation/{ => admin-guide}/device-mapper/zero.rst | 0
Documentation/admin-guide/index.rst | 1 +
MAINTAINERS | 2 +-
drivers/md/Kconfig | 2 +-
drivers/md/dm-init.c | 2 +-
drivers/md/dm-raid.c | 2 +-
35 files changed, 5 insertions(+), 6 deletions(-)
rename Documentation/{ => admin-guide}/device-mapper/cache-policies.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/cache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/delay.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-crypt.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-dust.txt (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-flakey.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-init.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-integrity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-io.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-log.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-queue-length.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-raid.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-service-time.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-uevent.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-zoned.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/era.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/index.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/kcopyd.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/linear.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/log-writes.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/persistent-data.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/snapshot.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/statistics.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/striped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/switch.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/thin-provisioning.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/unstriped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/verity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/writecache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/zero.rst (100%)
diff --git a/Documentation/device-mapper/cache-policies.rst b/Documentation/admin-guide/device-mapper/cache-policies.rst
similarity index 100%
rename from Documentation/device-mapper/cache-policies.rst
rename to Documentation/admin-guide/device-mapper/cache-policies.rst
diff --git a/Documentation/device-mapper/cache.rst b/Documentation/admin-guide/device-mapper/cache.rst
similarity index 100%
rename from Documentation/device-mapper/cache.rst
rename to Documentation/admin-guide/device-mapper/cache.rst
diff --git a/Documentation/device-mapper/delay.rst b/Documentation/admin-guide/device-mapper/delay.rst
similarity index 100%
rename from Documentation/device-mapper/delay.rst
rename to Documentation/admin-guide/device-mapper/delay.rst
diff --git a/Documentation/device-mapper/dm-crypt.rst b/Documentation/admin-guide/device-mapper/dm-crypt.rst
similarity index 100%
rename from Documentation/device-mapper/dm-crypt.rst
rename to Documentation/admin-guide/device-mapper/dm-crypt.rst
diff --git a/Documentation/device-mapper/dm-dust.txt b/Documentation/admin-guide/device-mapper/dm-dust.txt
similarity index 100%
rename from Documentation/device-mapper/dm-dust.txt
rename to Documentation/admin-guide/device-mapper/dm-dust.txt
diff --git a/Documentation/device-mapper/dm-flakey.rst b/Documentation/admin-guide/device-mapper/dm-flakey.rst
similarity index 100%
rename from Documentation/device-mapper/dm-flakey.rst
rename to Documentation/admin-guide/device-mapper/dm-flakey.rst
diff --git a/Documentation/device-mapper/dm-init.rst b/Documentation/admin-guide/device-mapper/dm-init.rst
similarity index 100%
rename from Documentation/device-mapper/dm-init.rst
rename to Documentation/admin-guide/device-mapper/dm-init.rst
diff --git a/Documentation/device-mapper/dm-integrity.rst b/Documentation/admin-guide/device-mapper/dm-integrity.rst
similarity index 100%
rename from Documentation/device-mapper/dm-integrity.rst
rename to Documentation/admin-guide/device-mapper/dm-integrity.rst
diff --git a/Documentation/device-mapper/dm-io.rst b/Documentation/admin-guide/device-mapper/dm-io.rst
similarity index 100%
rename from Documentation/device-mapper/dm-io.rst
rename to Documentation/admin-guide/device-mapper/dm-io.rst
diff --git a/Documentation/device-mapper/dm-log.rst b/Documentation/admin-guide/device-mapper/dm-log.rst
similarity index 100%
rename from Documentation/device-mapper/dm-log.rst
rename to Documentation/admin-guide/device-mapper/dm-log.rst
diff --git a/Documentation/device-mapper/dm-queue-length.rst b/Documentation/admin-guide/device-mapper/dm-queue-length.rst
similarity index 100%
rename from Documentation/device-mapper/dm-queue-length.rst
rename to Documentation/admin-guide/device-mapper/dm-queue-length.rst
diff --git a/Documentation/device-mapper/dm-raid.rst b/Documentation/admin-guide/device-mapper/dm-raid.rst
similarity index 100%
rename from Documentation/device-mapper/dm-raid.rst
rename to Documentation/admin-guide/device-mapper/dm-raid.rst
diff --git a/Documentation/device-mapper/dm-service-time.rst b/Documentation/admin-guide/device-mapper/dm-service-time.rst
similarity index 100%
rename from Documentation/device-mapper/dm-service-time.rst
rename to Documentation/admin-guide/device-mapper/dm-service-time.rst
diff --git a/Documentation/device-mapper/dm-uevent.rst b/Documentation/admin-guide/device-mapper/dm-uevent.rst
similarity index 100%
rename from Documentation/device-mapper/dm-uevent.rst
rename to Documentation/admin-guide/device-mapper/dm-uevent.rst
diff --git a/Documentation/device-mapper/dm-zoned.rst b/Documentation/admin-guide/device-mapper/dm-zoned.rst
similarity index 100%
rename from Documentation/device-mapper/dm-zoned.rst
rename to Documentation/admin-guide/device-mapper/dm-zoned.rst
diff --git a/Documentation/device-mapper/era.rst b/Documentation/admin-guide/device-mapper/era.rst
similarity index 100%
rename from Documentation/device-mapper/era.rst
rename to Documentation/admin-guide/device-mapper/era.rst
diff --git a/Documentation/device-mapper/index.rst b/Documentation/admin-guide/device-mapper/index.rst
similarity index 98%
rename from Documentation/device-mapper/index.rst
rename to Documentation/admin-guide/device-mapper/index.rst
index 105e253bc231..c77c58b8f67b 100644
--- a/Documentation/device-mapper/index.rst
+++ b/Documentation/admin-guide/device-mapper/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
=============
Device Mapper
=============
diff --git a/Documentation/device-mapper/kcopyd.rst b/Documentation/admin-guide/device-mapper/kcopyd.rst
similarity index 100%
rename from Documentation/device-mapper/kcopyd.rst
rename to Documentation/admin-guide/device-mapper/kcopyd.rst
diff --git a/Documentation/device-mapper/linear.rst b/Documentation/admin-guide/device-mapper/linear.rst
similarity index 100%
rename from Documentation/device-mapper/linear.rst
rename to Documentation/admin-guide/device-mapper/linear.rst
diff --git a/Documentation/device-mapper/log-writes.rst b/Documentation/admin-guide/device-mapper/log-writes.rst
similarity index 100%
rename from Documentation/device-mapper/log-writes.rst
rename to Documentation/admin-guide/device-mapper/log-writes.rst
diff --git a/Documentation/device-mapper/persistent-data.rst b/Documentation/admin-guide/device-mapper/persistent-data.rst
similarity index 100%
rename from Documentation/device-mapper/persistent-data.rst
rename to Documentation/admin-guide/device-mapper/persistent-data.rst
diff --git a/Documentation/device-mapper/snapshot.rst b/Documentation/admin-guide/device-mapper/snapshot.rst
similarity index 100%
rename from Documentation/device-mapper/snapshot.rst
rename to Documentation/admin-guide/device-mapper/snapshot.rst
diff --git a/Documentation/device-mapper/statistics.rst b/Documentation/admin-guide/device-mapper/statistics.rst
similarity index 100%
rename from Documentation/device-mapper/statistics.rst
rename to Documentation/admin-guide/device-mapper/statistics.rst
diff --git a/Documentation/device-mapper/striped.rst b/Documentation/admin-guide/device-mapper/striped.rst
similarity index 100%
rename from Documentation/device-mapper/striped.rst
rename to Documentation/admin-guide/device-mapper/striped.rst
diff --git a/Documentation/device-mapper/switch.rst b/Documentation/admin-guide/device-mapper/switch.rst
similarity index 100%
rename from Documentation/device-mapper/switch.rst
rename to Documentation/admin-guide/device-mapper/switch.rst
diff --git a/Documentation/device-mapper/thin-provisioning.rst b/Documentation/admin-guide/device-mapper/thin-provisioning.rst
similarity index 100%
rename from Documentation/device-mapper/thin-provisioning.rst
rename to Documentation/admin-guide/device-mapper/thin-provisioning.rst
diff --git a/Documentation/device-mapper/unstriped.rst b/Documentation/admin-guide/device-mapper/unstriped.rst
similarity index 100%
rename from Documentation/device-mapper/unstriped.rst
rename to Documentation/admin-guide/device-mapper/unstriped.rst
diff --git a/Documentation/device-mapper/verity.rst b/Documentation/admin-guide/device-mapper/verity.rst
similarity index 100%
rename from Documentation/device-mapper/verity.rst
rename to Documentation/admin-guide/device-mapper/verity.rst
diff --git a/Documentation/device-mapper/writecache.rst b/Documentation/admin-guide/device-mapper/writecache.rst
similarity index 100%
rename from Documentation/device-mapper/writecache.rst
rename to Documentation/admin-guide/device-mapper/writecache.rst
diff --git a/Documentation/device-mapper/zero.rst b/Documentation/admin-guide/device-mapper/zero.rst
similarity index 100%
rename from Documentation/device-mapper/zero.rst
rename to Documentation/admin-guide/device-mapper/zero.rst
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 42819addebc6..e0763c51b024 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -79,6 +79,7 @@ configure specific aspects of kernel behavior to your liking.
namespaces/index
perf-security
acpi/index
+ device-mapper/index
.. only:: subproject and html
diff --git a/MAINTAINERS b/MAINTAINERS
index 524e2c4300dc..40d057631004 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4703,7 +4703,7 @@ Q: http://patchwork.kernel.org/project/dm-devel/list/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/device-mapper/linux-dm.git
T: quilt http://people.redhat.com/agk/patches/linux/editing/
S: Maintained
-F: Documentation/device-mapper/
+F: Documentation/admin-guide/device-mapper/
F: drivers/md/Makefile
F: drivers/md/Kconfig
F: drivers/md/dm*
diff --git a/drivers/md/Kconfig b/drivers/md/Kconfig
index 5ccac0b77f17..3834332f4963 100644
--- a/drivers/md/Kconfig
+++ b/drivers/md/Kconfig
@@ -453,7 +453,7 @@ config DM_INIT
Enable "dm-mod.create=" parameter to create mapped devices at init time.
This option is useful to allow mounting rootfs without requiring an
initramfs.
- See Documentation/device-mapper/dm-init.rst for dm-mod.create="..."
+ See Documentation/admin-guide/device-mapper/dm-init.rst for dm-mod.create="..."
format.
If unsure, say N.
diff --git a/drivers/md/dm-init.c b/drivers/md/dm-init.c
index b65faef2c4b5..b869316d3722 100644
--- a/drivers/md/dm-init.c
+++ b/drivers/md/dm-init.c
@@ -25,7 +25,7 @@ static char *create;
* Format: dm-mod.create=<name>,<uuid>,<minor>,<flags>,<table>[,<table>+][;<name>,<uuid>,<minor>,<flags>,<table>[,<table>+]+]
* Table format: <start_sector> <num_sectors> <target_type> <target_args>
*
- * See Documentation/device-mapper/dm-init.rst for dm-mod.create="..." format
+ * See Documentation/admin-guide/device-mapper/dm-init.rst for dm-mod.create="..." format
* details.
*/
diff --git a/drivers/md/dm-raid.c b/drivers/md/dm-raid.c
index 7a87a640f8ba..8a60a4a070ac 100644
--- a/drivers/md/dm-raid.c
+++ b/drivers/md/dm-raid.c
@@ -3558,7 +3558,7 @@ static void raid_status(struct dm_target *ti, status_type_t type,
* v1.5.0+:
*
* Sync action:
- * See Documentation/device-mapper/dm-raid.rst for
+ * See Documentation/admin-guide/device-mapper/dm-raid.rst for
* information on each of these states.
*/
DMEMIT(" %s", sync_action);
--
2.21.0
^ permalink raw reply related
* [PATCH 33/39] docs: phy: place documentation under driver-api
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, Kishon Vijay Abraham I, Rob Herring,
Mark Rutland, Kamil Debski, Sylwester Nawrocki, devicetree
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
This subsystem-specific documentation belongs to the
driver-api.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
.../devicetree/bindings/phy/phy-pxa-usb.txt | 2 +-
Documentation/driver-api/index.rst | 1 +
Documentation/driver-api/phy/index.rst | 16 ++++++++++++++++
.../{phy.txt => driver-api/phy/phy.rst} | 0
.../{ => driver-api}/phy/samsung-usb2.rst | 0
Documentation/index.rst | 1 -
MAINTAINERS | 2 +-
8 files changed, 20 insertions(+), 4 deletions(-)
create mode 100644 Documentation/driver-api/phy/index.rst
rename Documentation/{phy.txt => driver-api/phy/phy.rst} (100%)
rename Documentation/{ => driver-api}/phy/samsung-usb2.rst (100%)
diff --git a/Documentation/devicetree/bindings/phy/phy-bindings.txt b/Documentation/devicetree/bindings/phy/phy-bindings.txt
index a403b81d0679..c4eb38902533 100644
--- a/Documentation/devicetree/bindings/phy/phy-bindings.txt
+++ b/Documentation/devicetree/bindings/phy/phy-bindings.txt
@@ -1,5 +1,5 @@
This document explains only the device tree data binding. For general
-information about PHY subsystem refer to Documentation/phy.txt
+information about PHY subsystem refer to Documentation/driver-api/phy/phy.rst
PHY device node
===============
diff --git a/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt b/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt
index 93fc09c12954..d80e36a77ec5 100644
--- a/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt
+++ b/Documentation/devicetree/bindings/phy/phy-pxa-usb.txt
@@ -15,4 +15,4 @@ Example:
};
This document explains the device tree binding. For general
-information about PHY subsystem refer to Documentation/phy.txt
+information about PHY subsystem refer to Documentation/driver-api/phy/phy.rst
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index d6f532c8d824..12d68c3ab792 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -85,6 +85,7 @@ available subsections can be seen below.
parport-lowlevel
pps
ptp
+ phy/index
pti_intel_mid
pwm
rfkill
diff --git a/Documentation/driver-api/phy/index.rst b/Documentation/driver-api/phy/index.rst
new file mode 100644
index 000000000000..fce9ffae2812
--- /dev/null
+++ b/Documentation/driver-api/phy/index.rst
@@ -0,0 +1,16 @@
+=====================
+Generic PHY Framework
+=====================
+
+.. toctree::
+
+ phy
+ samsung-usb2
+
+.. only:: subproject and html
+
+ Indices
+ =======
+
+ * :ref:`genindex`
+
diff --git a/Documentation/phy.txt b/Documentation/driver-api/phy/phy.rst
similarity index 100%
rename from Documentation/phy.txt
rename to Documentation/driver-api/phy/phy.rst
diff --git a/Documentation/phy/samsung-usb2.rst b/Documentation/driver-api/phy/samsung-usb2.rst
similarity index 100%
rename from Documentation/phy/samsung-usb2.rst
rename to Documentation/driver-api/phy/samsung-usb2.rst
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 28e6b5ef17b4..ea33cbbccd9d 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -112,7 +112,6 @@ needed).
usb/index
misc-devices/index
mic/index
- phy/samsung-usb2
scheduler/index
Architecture-specific documentation
diff --git a/MAINTAINERS b/MAINTAINERS
index 856db8015edd..cda68bbd9d1c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -14031,7 +14031,7 @@ M: Sylwester Nawrocki <s.nawrocki@samsung.com>
L: linux-kernel@vger.kernel.org
S: Supported
F: Documentation/devicetree/bindings/phy/samsung-phy.txt
-F: Documentation/phy/samsung-usb2.rst
+F: Documentation/driver-api/phy/samsung-usb2.rst
F: drivers/phy/samsung/phy-exynos4210-usb2.c
F: drivers/phy/samsung/phy-exynos4x12-usb2.c
F: drivers/phy/samsung/phy-exynos5250-usb2.c
--
2.21.0
^ permalink raw reply related
* [PATCH 31/39] docs: driver-api: add remaining converted dirs to it
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, Rodolfo Giometti, Richard Cochran, Sudeep Dutt,
Ashutosh Dixit, netdev
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
There are a number of driver-specific descriptions that contain a
mix of userspace and kernelspace documentation. Just like we did
with other similar subsystems, add them at the driver-api
groupset, but don't move the directories.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 2 ++
Documentation/driver-api/pps.rst | 2 +-
Documentation/driver-api/ptp.rst | 2 +-
Documentation/index.rst | 3 +++
Documentation/mic/index.rst | 2 --
Documentation/phy/samsung-usb2.rst | 2 --
Documentation/scheduler/index.rst | 2 --
7 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 0bc5f2e3b98b..f44a3140f95d 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -83,6 +83,8 @@ available subsections can be seen below.
ntb
nvmem
parport-lowlevel
+ pps
+ ptp
pti_intel_mid
pwm
rfkill
diff --git a/Documentation/driver-api/pps.rst b/Documentation/driver-api/pps.rst
index 1456d2c32ebd..2d6b99766ee8 100644
--- a/Documentation/driver-api/pps.rst
+++ b/Documentation/driver-api/pps.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
======================
PPS - Pulse Per Second
diff --git a/Documentation/driver-api/ptp.rst b/Documentation/driver-api/ptp.rst
index b6e65d66d37a..a15192e32347 100644
--- a/Documentation/driver-api/ptp.rst
+++ b/Documentation/driver-api/ptp.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
===========================================
PTP hardware clock infrastructure for Linux
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 879849b60c02..28e6b5ef17b4 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -111,6 +111,9 @@ needed).
PCI/index
usb/index
misc-devices/index
+ mic/index
+ phy/samsung-usb2
+ scheduler/index
Architecture-specific documentation
-----------------------------------
diff --git a/Documentation/mic/index.rst b/Documentation/mic/index.rst
index 082fa8f6a260..3a8d06367ef1 100644
--- a/Documentation/mic/index.rst
+++ b/Documentation/mic/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
=============================================
Intel Many Integrated Core (MIC) architecture
=============================================
diff --git a/Documentation/phy/samsung-usb2.rst b/Documentation/phy/samsung-usb2.rst
index 98b5952fcb97..c48c8b9797b9 100644
--- a/Documentation/phy/samsung-usb2.rst
+++ b/Documentation/phy/samsung-usb2.rst
@@ -1,5 +1,3 @@
-:orphan:
-
====================================
Samsung USB 2.0 PHY adaptation layer
====================================
diff --git a/Documentation/scheduler/index.rst b/Documentation/scheduler/index.rst
index 058be77a4c34..69074e5de9c4 100644
--- a/Documentation/scheduler/index.rst
+++ b/Documentation/scheduler/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===============
Linux Scheduler
===============
--
2.21.0
^ permalink raw reply related
* [PATCH 27/39] docs: cgroup-v1: add it to the admin-guide book
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, Tejun Heo, Li Zefan, Johannes Weiner,
Paolo Valente, Jens Axboe, Thomas Gleixner, Ingo Molnar,
Borislav Petkov, H. Peter Anvin, x86, Alexei Starovoitov,
Daniel Borkmann, Martin KaFai Lau, Song Liu, Yonghong Song,
James Morris, Serge E. Hallyn, cgroups, linux-block, netdev, bpf,
linux-security-module
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
Those files belong to the admin guide, so add them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
.../{ => admin-guide}/cgroup-v1/blkio-controller.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst | 4 ++--
Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst | 2 +-
Documentation/{ => admin-guide}/cgroup-v1/devices.rst | 0
.../{ => admin-guide}/cgroup-v1/freezer-subsystem.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/index.rst | 2 --
Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst | 4 ++--
Documentation/{ => admin-guide}/cgroup-v1/memory.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/pids.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/rdma.rst | 0
Documentation/admin-guide/cgroup-v2.rst | 2 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.txt | 4 ++--
Documentation/admin-guide/mm/numa_memory_policy.rst | 2 +-
Documentation/block/bfq-iosched.rst | 2 +-
Documentation/filesystems/tmpfs.txt | 2 +-
Documentation/kernel-per-CPU-kthreads.txt | 2 +-
Documentation/scheduler/sched-deadline.rst | 2 +-
Documentation/scheduler/sched-design-CFS.rst | 2 +-
Documentation/scheduler/sched-rt-group.rst | 2 +-
Documentation/vm/numa.rst | 4 ++--
Documentation/vm/page_migration.rst | 2 +-
Documentation/vm/unevictable-lru.rst | 2 +-
Documentation/x86/x86_64/fake-numa-for-cpusets.rst | 4 ++--
MAINTAINERS | 4 ++--
block/Kconfig | 2 +-
include/linux/cgroup-defs.h | 2 +-
include/uapi/linux/bpf.h | 2 +-
init/Kconfig | 4 ++--
kernel/cgroup/cpuset.c | 2 +-
security/device_cgroup.c | 2 +-
tools/include/uapi/linux/bpf.h | 2 +-
36 files changed, 32 insertions(+), 33 deletions(-)
rename Documentation/{ => admin-guide}/cgroup-v1/blkio-controller.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/devices.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/freezer-subsystem.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/index.rst (97%)
rename Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst (98%)
rename Documentation/{ => admin-guide}/cgroup-v1/memory.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/pids.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/rdma.rst (100%)
diff --git a/Documentation/cgroup-v1/blkio-controller.rst b/Documentation/admin-guide/cgroup-v1/blkio-controller.rst
similarity index 100%
rename from Documentation/cgroup-v1/blkio-controller.rst
rename to Documentation/admin-guide/cgroup-v1/blkio-controller.rst
diff --git a/Documentation/cgroup-v1/cgroups.rst b/Documentation/admin-guide/cgroup-v1/cgroups.rst
similarity index 99%
rename from Documentation/cgroup-v1/cgroups.rst
rename to Documentation/admin-guide/cgroup-v1/cgroups.rst
index 46bbe7e022d4..b0688011ed06 100644
--- a/Documentation/cgroup-v1/cgroups.rst
+++ b/Documentation/admin-guide/cgroup-v1/cgroups.rst
@@ -3,7 +3,7 @@ Control Groups
==============
Written by Paul Menage <menage@google.com> based on
-Documentation/cgroup-v1/cpusets.rst
+Documentation/admin-guide/cgroup-v1/cpusets.rst
Original copyright statements from cpusets.txt:
@@ -76,7 +76,7 @@ On their own, the only use for cgroups is for simple job
tracking. The intention is that other subsystems hook into the generic
cgroup support to provide new attributes for cgroups, such as
accounting/limiting the resources which processes in a cgroup can
-access. For example, cpusets (see Documentation/cgroup-v1/cpusets.rst) allow
+access. For example, cpusets (see Documentation/admin-guide/cgroup-v1/cpusets.rst) allow
you to associate a set of CPUs and a set of memory nodes with the
tasks in each cgroup.
diff --git a/Documentation/cgroup-v1/cpuacct.rst b/Documentation/admin-guide/cgroup-v1/cpuacct.rst
similarity index 100%
rename from Documentation/cgroup-v1/cpuacct.rst
rename to Documentation/admin-guide/cgroup-v1/cpuacct.rst
diff --git a/Documentation/cgroup-v1/cpusets.rst b/Documentation/admin-guide/cgroup-v1/cpusets.rst
similarity index 99%
rename from Documentation/cgroup-v1/cpusets.rst
rename to Documentation/admin-guide/cgroup-v1/cpusets.rst
index b6a42cdea72b..86a6ae995d54 100644
--- a/Documentation/cgroup-v1/cpusets.rst
+++ b/Documentation/admin-guide/cgroup-v1/cpusets.rst
@@ -49,7 +49,7 @@ hooks, beyond what is already present, required to manage dynamic
job placement on large systems.
Cpusets use the generic cgroup subsystem described in
-Documentation/cgroup-v1/cgroups.rst.
+Documentation/admin-guide/cgroup-v1/cgroups.rst.
Requests by a task, using the sched_setaffinity(2) system call to
include CPUs in its CPU affinity mask, and using the mbind(2) and
diff --git a/Documentation/cgroup-v1/devices.rst b/Documentation/admin-guide/cgroup-v1/devices.rst
similarity index 100%
rename from Documentation/cgroup-v1/devices.rst
rename to Documentation/admin-guide/cgroup-v1/devices.rst
diff --git a/Documentation/cgroup-v1/freezer-subsystem.rst b/Documentation/admin-guide/cgroup-v1/freezer-subsystem.rst
similarity index 100%
rename from Documentation/cgroup-v1/freezer-subsystem.rst
rename to Documentation/admin-guide/cgroup-v1/freezer-subsystem.rst
diff --git a/Documentation/cgroup-v1/hugetlb.rst b/Documentation/admin-guide/cgroup-v1/hugetlb.rst
similarity index 100%
rename from Documentation/cgroup-v1/hugetlb.rst
rename to Documentation/admin-guide/cgroup-v1/hugetlb.rst
diff --git a/Documentation/cgroup-v1/index.rst b/Documentation/admin-guide/cgroup-v1/index.rst
similarity index 97%
rename from Documentation/cgroup-v1/index.rst
rename to Documentation/admin-guide/cgroup-v1/index.rst
index fe76d42edc11..10bf48bae0b0 100644
--- a/Documentation/cgroup-v1/index.rst
+++ b/Documentation/admin-guide/cgroup-v1/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
========================
Control Groups version 1
========================
diff --git a/Documentation/cgroup-v1/memcg_test.rst b/Documentation/admin-guide/cgroup-v1/memcg_test.rst
similarity index 98%
rename from Documentation/cgroup-v1/memcg_test.rst
rename to Documentation/admin-guide/cgroup-v1/memcg_test.rst
index 91bd18c6a514..3f7115e07b5d 100644
--- a/Documentation/cgroup-v1/memcg_test.rst
+++ b/Documentation/admin-guide/cgroup-v1/memcg_test.rst
@@ -10,7 +10,7 @@ Because VM is getting complex (one of reasons is memcg...), memcg's behavior
is complex. This is a document for memcg's internal behavior.
Please note that implementation details can be changed.
-(*) Topics on API should be in Documentation/cgroup-v1/memory.rst)
+(*) Topics on API should be in Documentation/admin-guide/cgroup-v1/memory.rst)
0. How to record usage ?
========================
@@ -327,7 +327,7 @@ Under below explanation, we assume CONFIG_MEM_RES_CTRL_SWAP=y.
You can see charges have been moved by reading ``*.usage_in_bytes`` or
memory.stat of both A and B.
- See 8.2 of Documentation/cgroup-v1/memory.rst to see what value should
+ See 8.2 of Documentation/admin-guide/cgroup-v1/memory.rst to see what value should
be written to move_charge_at_immigrate.
9.10 Memory thresholds
diff --git a/Documentation/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst
similarity index 100%
rename from Documentation/cgroup-v1/memory.rst
rename to Documentation/admin-guide/cgroup-v1/memory.rst
diff --git a/Documentation/cgroup-v1/net_cls.rst b/Documentation/admin-guide/cgroup-v1/net_cls.rst
similarity index 100%
rename from Documentation/cgroup-v1/net_cls.rst
rename to Documentation/admin-guide/cgroup-v1/net_cls.rst
diff --git a/Documentation/cgroup-v1/net_prio.rst b/Documentation/admin-guide/cgroup-v1/net_prio.rst
similarity index 100%
rename from Documentation/cgroup-v1/net_prio.rst
rename to Documentation/admin-guide/cgroup-v1/net_prio.rst
diff --git a/Documentation/cgroup-v1/pids.rst b/Documentation/admin-guide/cgroup-v1/pids.rst
similarity index 100%
rename from Documentation/cgroup-v1/pids.rst
rename to Documentation/admin-guide/cgroup-v1/pids.rst
diff --git a/Documentation/cgroup-v1/rdma.rst b/Documentation/admin-guide/cgroup-v1/rdma.rst
similarity index 100%
rename from Documentation/cgroup-v1/rdma.rst
rename to Documentation/admin-guide/cgroup-v1/rdma.rst
diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index 4b971a0bc99a..125c5cc15fe7 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -9,7 +9,7 @@ This is the authoritative documentation on the design, interface and
conventions of cgroup v2. It describes all userland-visible aspects
of cgroup including core and specific controller behaviors. All
future changes must be reflected in this document. Documentation for
-v1 is available under Documentation/cgroup-v1/.
+v1 is available under Documentation/admin-guide/cgroup-v1/.
.. CONTENTS
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index be3b86db8171..d5064f1802c1 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -59,6 +59,7 @@ configure specific aspects of kernel behavior to your liking.
initrd
cgroup-v2
+ cgroup-v1/index
serial-console
braille-console
parport
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 49ad034c4675..e833133c8897 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -4115,7 +4115,7 @@
relax_domain_level=
[KNL, SMP] Set scheduler's default relax_domain_level.
- See Documentation/cgroup-v1/cpusets.rst.
+ See Documentation/admin-guide/cgroup-v1/cpusets.rst.
reserve= [KNL,BUGS] Force kernel to ignore I/O ports or memory
Format: <base1>,<size1>[,<base2>,<size2>,...]
@@ -4625,7 +4625,7 @@
swapaccount=[0|1]
[KNL] Enable accounting of swap in memory resource
controller if no parameter or 1 is given or disable
- it if 0 is given (See Documentation/cgroup-v1/memory.rst)
+ it if 0 is given (See Documentation/admin-guide/cgroup-v1/memory.rst)
swiotlb= [ARM,IA-64,PPC,MIPS,X86]
Format: { <int> | force | noforce }
diff --git a/Documentation/admin-guide/mm/numa_memory_policy.rst b/Documentation/admin-guide/mm/numa_memory_policy.rst
index 546f174e5d6a..8463f5538fda 100644
--- a/Documentation/admin-guide/mm/numa_memory_policy.rst
+++ b/Documentation/admin-guide/mm/numa_memory_policy.rst
@@ -15,7 +15,7 @@ document attempts to describe the concepts and APIs of the 2.6 memory policy
support.
Memory policies should not be confused with cpusets
-(``Documentation/cgroup-v1/cpusets.rst``)
+(``Documentation/admin-guide/cgroup-v1/cpusets.rst``)
which is an administrative mechanism for restricting the nodes from which
memory may be allocated by a set of processes. Memory policies are a
programming interface that a NUMA-aware application can take advantage of. When
diff --git a/Documentation/block/bfq-iosched.rst b/Documentation/block/bfq-iosched.rst
index 2c13b2fc1888..0d237d402860 100644
--- a/Documentation/block/bfq-iosched.rst
+++ b/Documentation/block/bfq-iosched.rst
@@ -547,7 +547,7 @@ As for cgroups-v1 (blkio controller), the exact set of stat files
created, and kept up-to-date by bfq, depends on whether
CONFIG_BFQ_CGROUP_DEBUG is set. If it is set, then bfq creates all
the stat files documented in
-Documentation/cgroup-v1/blkio-controller.rst. If, instead,
+Documentation/admin-guide/cgroup-v1/blkio-controller.rst. If, instead,
CONFIG_BFQ_CGROUP_DEBUG is not set, then bfq creates only the files::
blkio.bfq.io_service_bytes
diff --git a/Documentation/filesystems/tmpfs.txt b/Documentation/filesystems/tmpfs.txt
index cad797a8a39e..5ecbc03e6b2f 100644
--- a/Documentation/filesystems/tmpfs.txt
+++ b/Documentation/filesystems/tmpfs.txt
@@ -98,7 +98,7 @@ A memory policy with a valid NodeList will be saved, as specified, for
use at file creation time. When a task allocates a file in the file
system, the mount option memory policy will be applied with a NodeList,
if any, modified by the calling task's cpuset constraints
-[See Documentation/cgroup-v1/cpusets.rst] and any optional flags, listed
+[See Documentation/admin-guide/cgroup-v1/cpusets.rst] and any optional flags, listed
below. If the resulting NodeLists is the empty set, the effective memory
policy for the file will revert to "default" policy.
diff --git a/Documentation/kernel-per-CPU-kthreads.txt b/Documentation/kernel-per-CPU-kthreads.txt
index 5623b9916411..4f18456dd3b1 100644
--- a/Documentation/kernel-per-CPU-kthreads.txt
+++ b/Documentation/kernel-per-CPU-kthreads.txt
@@ -12,7 +12,7 @@ References
- Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs.
-- Documentation/cgroup-v1: Using cgroups to bind tasks to sets of CPUs.
+- Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs.
- man taskset: Using the taskset command to bind tasks to sets
of CPUs.
diff --git a/Documentation/scheduler/sched-deadline.rst b/Documentation/scheduler/sched-deadline.rst
index 3391e86d810c..14a2f7bf63fe 100644
--- a/Documentation/scheduler/sched-deadline.rst
+++ b/Documentation/scheduler/sched-deadline.rst
@@ -669,7 +669,7 @@ Deadline Task Scheduling
-deadline tasks cannot have an affinity mask smaller that the entire
root_domain they are created on. However, affinities can be specified
- through the cpuset facility (Documentation/cgroup-v1/cpusets.rst).
+ through the cpuset facility (Documentation/admin-guide/cgroup-v1/cpusets.rst).
5.1 SCHED_DEADLINE and cpusets HOWTO
------------------------------------
diff --git a/Documentation/scheduler/sched-design-CFS.rst b/Documentation/scheduler/sched-design-CFS.rst
index 53b30d1967cf..a96c72651877 100644
--- a/Documentation/scheduler/sched-design-CFS.rst
+++ b/Documentation/scheduler/sched-design-CFS.rst
@@ -222,7 +222,7 @@ SCHED_BATCH) tasks.
These options need CONFIG_CGROUPS to be defined, and let the administrator
create arbitrary groups of tasks, using the "cgroup" pseudo filesystem. See
- Documentation/cgroup-v1/cgroups.rst for more information about this filesystem.
+ Documentation/admin-guide/cgroup-v1/cgroups.rst for more information about this filesystem.
When CONFIG_FAIR_GROUP_SCHED is defined, a "cpu.shares" file is created for each
group created using the pseudo filesystem. See example steps below to create
diff --git a/Documentation/scheduler/sched-rt-group.rst b/Documentation/scheduler/sched-rt-group.rst
index d27d3f3712fd..655a096ec8fb 100644
--- a/Documentation/scheduler/sched-rt-group.rst
+++ b/Documentation/scheduler/sched-rt-group.rst
@@ -133,7 +133,7 @@ This uses the cgroup virtual file system and "<cgroup>/cpu.rt_runtime_us"
to control the CPU time reserved for each control group.
For more information on working with control groups, you should read
-Documentation/cgroup-v1/cgroups.rst as well.
+Documentation/admin-guide/cgroup-v1/cgroups.rst as well.
Group settings are checked against the following limits in order to keep the
configuration schedulable:
diff --git a/Documentation/vm/numa.rst b/Documentation/vm/numa.rst
index 130f3cfa1c19..99fdeca917ca 100644
--- a/Documentation/vm/numa.rst
+++ b/Documentation/vm/numa.rst
@@ -67,7 +67,7 @@ nodes. Each emulated node will manage a fraction of the underlying cells'
physical memory. NUMA emluation is useful for testing NUMA kernel and
application features on non-NUMA platforms, and as a sort of memory resource
management mechanism when used together with cpusets.
-[see Documentation/cgroup-v1/cpusets.rst]
+[see Documentation/admin-guide/cgroup-v1/cpusets.rst]
For each node with memory, Linux constructs an independent memory management
subsystem, complete with its own free page lists, in-use page lists, usage
@@ -114,7 +114,7 @@ allocation behavior using Linux NUMA memory policy. [see
System administrators can restrict the CPUs and nodes' memories that a non-
privileged user can specify in the scheduling or NUMA commands and functions
-using control groups and CPUsets. [see Documentation/cgroup-v1/cpusets.rst]
+using control groups and CPUsets. [see Documentation/admin-guide/cgroup-v1/cpusets.rst]
On architectures that do not hide memoryless nodes, Linux will include only
zones [nodes] with memory in the zonelists. This means that for a memoryless
diff --git a/Documentation/vm/page_migration.rst b/Documentation/vm/page_migration.rst
index 35bba27d5fff..1d6cd7db4e43 100644
--- a/Documentation/vm/page_migration.rst
+++ b/Documentation/vm/page_migration.rst
@@ -41,7 +41,7 @@ locations.
Larger installations usually partition the system using cpusets into
sections of nodes. Paul Jackson has equipped cpusets with the ability to
move pages when a task is moved to another cpuset (See
-Documentation/cgroup-v1/cpusets.rst).
+Documentation/admin-guide/cgroup-v1/cpusets.rst).
Cpusets allows the automation of process locality. If a task is moved to
a new cpuset then also all its pages are moved with it so that the
performance of the process does not sink dramatically. Also the pages
diff --git a/Documentation/vm/unevictable-lru.rst b/Documentation/vm/unevictable-lru.rst
index 109052215bce..17d0861b0f1d 100644
--- a/Documentation/vm/unevictable-lru.rst
+++ b/Documentation/vm/unevictable-lru.rst
@@ -98,7 +98,7 @@ Memory Control Group Interaction
--------------------------------
The unevictable LRU facility interacts with the memory control group [aka
-memory controller; see Documentation/cgroup-v1/memory.rst] by extending the
+memory controller; see Documentation/admin-guide/cgroup-v1/memory.rst] by extending the
lru_list enum.
The memory controller data structure automatically gets a per-zone unevictable
diff --git a/Documentation/x86/x86_64/fake-numa-for-cpusets.rst b/Documentation/x86/x86_64/fake-numa-for-cpusets.rst
index 30108684ae87..ff9bcfd2cc14 100644
--- a/Documentation/x86/x86_64/fake-numa-for-cpusets.rst
+++ b/Documentation/x86/x86_64/fake-numa-for-cpusets.rst
@@ -15,7 +15,7 @@ assign them to cpusets and their attached tasks. This is a way of limiting the
amount of system memory that are available to a certain class of tasks.
For more information on the features of cpusets, see
-Documentation/cgroup-v1/cpusets.rst.
+Documentation/admin-guide/cgroup-v1/cpusets.rst.
There are a number of different configurations you can use for your needs. For
more information on the numa=fake command line option and its various ways of
configuring fake nodes, see Documentation/x86/x86_64/boot-options.rst.
@@ -40,7 +40,7 @@ A machine may be split as follows with "numa=fake=4*512," as reported by dmesg::
On node 3 totalpages: 131072
Now following the instructions for mounting the cpusets filesystem from
-Documentation/cgroup-v1/cpusets.rst, you can assign fake nodes (i.e. contiguous memory
+Documentation/admin-guide/cgroup-v1/cpusets.rst, you can assign fake nodes (i.e. contiguous memory
address spaces) to individual cpusets::
[root@xroads /]# mkdir exampleset
diff --git a/MAINTAINERS b/MAINTAINERS
index 2791b443ab8e..82222aa618c5 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4119,7 +4119,7 @@ L: cgroups@vger.kernel.org
T: git git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup.git
S: Maintained
F: Documentation/admin-guide/cgroup-v2.rst
-F: Documentation/cgroup-v1/
+F: Documentation/admin-guide/cgroup-v1/
F: include/linux/cgroup*
F: kernel/cgroup/
@@ -4130,7 +4130,7 @@ W: http://www.bullopensource.org/cpuset/
W: http://oss.sgi.com/projects/cpusets/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup.git
S: Maintained
-F: Documentation/cgroup-v1/cpusets.rst
+F: Documentation/admin-guide/cgroup-v1/cpusets.rst
F: include/linux/cpuset.h
F: kernel/cgroup/cpuset.c
diff --git a/block/Kconfig b/block/Kconfig
index b16b3e075d31..8b5f8e560eb4 100644
--- a/block/Kconfig
+++ b/block/Kconfig
@@ -89,7 +89,7 @@ config BLK_DEV_THROTTLING
one needs to mount and use blkio cgroup controller for creating
cgroups and specifying per device IO rate policies.
- See Documentation/cgroup-v1/blkio-controller.rst for more information.
+ See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information.
config BLK_DEV_THROTTLING_LOW
bool "Block throttling .low limit interface support (EXPERIMENTAL)"
diff --git a/include/linux/cgroup-defs.h b/include/linux/cgroup-defs.h
index c5311935239d..430e219e3aba 100644
--- a/include/linux/cgroup-defs.h
+++ b/include/linux/cgroup-defs.h
@@ -624,7 +624,7 @@ struct cftype {
/*
* Control Group subsystem type.
- * See Documentation/cgroup-v1/cgroups.rst for details
+ * See Documentation/admin-guide/cgroup-v1/cgroups.rst for details
*/
struct cgroup_subsys {
struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index 19d9ee7e0518..c2fa3dc1d167 100644
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -803,7 +803,7 @@ union bpf_attr {
* based on a user-provided identifier for all traffic coming from
* the tasks belonging to the related cgroup. See also the related
* kernel documentation, available from the Linux sources in file
- * *Documentation/cgroup-v1/net_cls.rst*.
+ * *Documentation/admin-guide/cgroup-v1/net_cls.rst*.
*
* The Linux kernel has two versions for cgroups: there are
* cgroups v1 and cgroups v2. Both are available to users, who can
diff --git a/init/Kconfig b/init/Kconfig
index 95ec166e2c2e..4b6235ed24ec 100644
--- a/init/Kconfig
+++ b/init/Kconfig
@@ -797,7 +797,7 @@ menuconfig CGROUPS
controls or device isolation.
See
- Documentation/scheduler/sched-design-CFS.rst (CFS)
- - Documentation/cgroup-v1/ (features for grouping, isolation
+ - Documentation/admin-guide/cgroup-v1/ (features for grouping, isolation
and resource control)
Say N if unsure.
@@ -859,7 +859,7 @@ config BLK_CGROUP
CONFIG_CFQ_GROUP_IOSCHED=y; for enabling throttling policy, set
CONFIG_BLK_DEV_THROTTLING=y.
- See Documentation/cgroup-v1/blkio-controller.rst for more information.
+ See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information.
config CGROUP_WRITEBACK
bool
diff --git a/kernel/cgroup/cpuset.c b/kernel/cgroup/cpuset.c
index b3b02b9c4405..863e434a6020 100644
--- a/kernel/cgroup/cpuset.c
+++ b/kernel/cgroup/cpuset.c
@@ -729,7 +729,7 @@ static inline int nr_cpusets(void)
* load balancing domains (sched domains) as specified by that partial
* partition.
*
- * See "What is sched_load_balance" in Documentation/cgroup-v1/cpusets.rst
+ * See "What is sched_load_balance" in Documentation/admin-guide/cgroup-v1/cpusets.rst
* for a background explanation of this.
*
* Does not return errors, on the theory that the callers of this
diff --git a/security/device_cgroup.c b/security/device_cgroup.c
index c07196502577..725674f3276d 100644
--- a/security/device_cgroup.c
+++ b/security/device_cgroup.c
@@ -509,7 +509,7 @@ static inline int may_allow_all(struct dev_cgroup *parent)
* This is one of the three key functions for hierarchy implementation.
* This function is responsible for re-evaluating all the cgroup's active
* exceptions due to a parent's exception change.
- * Refer to Documentation/cgroup-v1/devices.rst for more details.
+ * Refer to Documentation/admin-guide/cgroup-v1/devices.rst for more details.
*/
static void revalidate_active_exceptions(struct dev_cgroup *devcg)
{
diff --git a/tools/include/uapi/linux/bpf.h b/tools/include/uapi/linux/bpf.h
index 19d9ee7e0518..c2fa3dc1d167 100644
--- a/tools/include/uapi/linux/bpf.h
+++ b/tools/include/uapi/linux/bpf.h
@@ -803,7 +803,7 @@ union bpf_attr {
* based on a user-provided identifier for all traffic coming from
* the tasks belonging to the related cgroup. See also the related
* kernel documentation, available from the Linux sources in file
- * *Documentation/cgroup-v1/net_cls.rst*.
+ * *Documentation/admin-guide/cgroup-v1/net_cls.rst*.
*
* The Linux kernel has two versions for cgroups: there are
* cgroups v1 and cgroups v2. Both are available to users, who can
--
2.21.0
^ permalink raw reply related
* [PATCH 19/39] docs: blockdev: add it to the admin-guide
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, Philipp Reisner, Lars Ellenberg, Josef Bacik,
Tim Waugh, Jens Axboe, Minchan Kim, Nitin Gupta,
Sergey Senozhatsky, Jiri Kosina, Shuah Khan, drbd-dev,
linux-block, nbd, linux-kselftest
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The blockdev book basically contains user-faced documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
.../blockdev/drbd/DRBD-8.3-data-packets.svg | 0
.../blockdev/drbd/DRBD-data-packets.svg | 0
.../blockdev/drbd/conn-states-8.dot | 0
.../blockdev/drbd/data-structure-v9.rst | 0
.../blockdev/drbd/disk-states-8.dot | 0
.../drbd/drbd-connection-state-overview.dot | 0
.../blockdev/drbd/figures.rst | 0
.../{ => admin-guide}/blockdev/drbd/index.rst | 0
.../blockdev/drbd/node-states-8.dot | 1 -
.../{ => admin-guide}/blockdev/floppy.rst | 0
.../{ => admin-guide}/blockdev/index.rst | 2 --
.../{ => admin-guide}/blockdev/nbd.rst | 0
.../{ => admin-guide}/blockdev/paride.rst | 0
.../{ => admin-guide}/blockdev/ramdisk.rst | 0
.../{ => admin-guide}/blockdev/zram.rst | 0
Documentation/admin-guide/index.rst | 1 +
.../admin-guide/kernel-parameters.txt | 18 +++++++++---------
MAINTAINERS | 10 +++++-----
drivers/block/Kconfig | 8 ++++----
drivers/block/floppy.c | 2 +-
drivers/block/zram/Kconfig | 6 +++---
tools/testing/selftests/zram/README | 2 +-
22 files changed, 24 insertions(+), 26 deletions(-)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-8.3-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/conn-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/data-structure-v9.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/disk-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/drbd-connection-state-overview.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/figures.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/index.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/node-states-8.dot (99%)
rename Documentation/{ => admin-guide}/blockdev/floppy.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/index.rst (94%)
rename Documentation/{ => admin-guide}/blockdev/nbd.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/paride.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/ramdisk.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/zram.rst (100%)
diff --git a/Documentation/blockdev/drbd/DRBD-8.3-data-packets.svg b/Documentation/admin-guide/blockdev/drbd/DRBD-8.3-data-packets.svg
similarity index 100%
rename from Documentation/blockdev/drbd/DRBD-8.3-data-packets.svg
rename to Documentation/admin-guide/blockdev/drbd/DRBD-8.3-data-packets.svg
diff --git a/Documentation/blockdev/drbd/DRBD-data-packets.svg b/Documentation/admin-guide/blockdev/drbd/DRBD-data-packets.svg
similarity index 100%
rename from Documentation/blockdev/drbd/DRBD-data-packets.svg
rename to Documentation/admin-guide/blockdev/drbd/DRBD-data-packets.svg
diff --git a/Documentation/blockdev/drbd/conn-states-8.dot b/Documentation/admin-guide/blockdev/drbd/conn-states-8.dot
similarity index 100%
rename from Documentation/blockdev/drbd/conn-states-8.dot
rename to Documentation/admin-guide/blockdev/drbd/conn-states-8.dot
diff --git a/Documentation/blockdev/drbd/data-structure-v9.rst b/Documentation/admin-guide/blockdev/drbd/data-structure-v9.rst
similarity index 100%
rename from Documentation/blockdev/drbd/data-structure-v9.rst
rename to Documentation/admin-guide/blockdev/drbd/data-structure-v9.rst
diff --git a/Documentation/blockdev/drbd/disk-states-8.dot b/Documentation/admin-guide/blockdev/drbd/disk-states-8.dot
similarity index 100%
rename from Documentation/blockdev/drbd/disk-states-8.dot
rename to Documentation/admin-guide/blockdev/drbd/disk-states-8.dot
diff --git a/Documentation/blockdev/drbd/drbd-connection-state-overview.dot b/Documentation/admin-guide/blockdev/drbd/drbd-connection-state-overview.dot
similarity index 100%
rename from Documentation/blockdev/drbd/drbd-connection-state-overview.dot
rename to Documentation/admin-guide/blockdev/drbd/drbd-connection-state-overview.dot
diff --git a/Documentation/blockdev/drbd/figures.rst b/Documentation/admin-guide/blockdev/drbd/figures.rst
similarity index 100%
rename from Documentation/blockdev/drbd/figures.rst
rename to Documentation/admin-guide/blockdev/drbd/figures.rst
diff --git a/Documentation/blockdev/drbd/index.rst b/Documentation/admin-guide/blockdev/drbd/index.rst
similarity index 100%
rename from Documentation/blockdev/drbd/index.rst
rename to Documentation/admin-guide/blockdev/drbd/index.rst
diff --git a/Documentation/blockdev/drbd/node-states-8.dot b/Documentation/admin-guide/blockdev/drbd/node-states-8.dot
similarity index 99%
rename from Documentation/blockdev/drbd/node-states-8.dot
rename to Documentation/admin-guide/blockdev/drbd/node-states-8.dot
index 4a2b00c23547..bfa54e1f8016 100644
--- a/Documentation/blockdev/drbd/node-states-8.dot
+++ b/Documentation/admin-guide/blockdev/drbd/node-states-8.dot
@@ -11,4 +11,3 @@ digraph peer_states {
Unknown -> Primary [ label = "connected" ]
Unknown -> Secondary [ label = "connected" ]
}
-
diff --git a/Documentation/blockdev/floppy.rst b/Documentation/admin-guide/blockdev/floppy.rst
similarity index 100%
rename from Documentation/blockdev/floppy.rst
rename to Documentation/admin-guide/blockdev/floppy.rst
diff --git a/Documentation/blockdev/index.rst b/Documentation/admin-guide/blockdev/index.rst
similarity index 94%
rename from Documentation/blockdev/index.rst
rename to Documentation/admin-guide/blockdev/index.rst
index a9af6ed8b4aa..20a738d9d047 100644
--- a/Documentation/blockdev/index.rst
+++ b/Documentation/admin-guide/blockdev/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
The Linux RapidIO Subsystem
===========================
diff --git a/Documentation/blockdev/nbd.rst b/Documentation/admin-guide/blockdev/nbd.rst
similarity index 100%
rename from Documentation/blockdev/nbd.rst
rename to Documentation/admin-guide/blockdev/nbd.rst
diff --git a/Documentation/blockdev/paride.rst b/Documentation/admin-guide/blockdev/paride.rst
similarity index 100%
rename from Documentation/blockdev/paride.rst
rename to Documentation/admin-guide/blockdev/paride.rst
diff --git a/Documentation/blockdev/ramdisk.rst b/Documentation/admin-guide/blockdev/ramdisk.rst
similarity index 100%
rename from Documentation/blockdev/ramdisk.rst
rename to Documentation/admin-guide/blockdev/ramdisk.rst
diff --git a/Documentation/blockdev/zram.rst b/Documentation/admin-guide/blockdev/zram.rst
similarity index 100%
rename from Documentation/blockdev/zram.rst
rename to Documentation/admin-guide/blockdev/zram.rst
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 65e821a03aca..c073af461cdf 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -73,6 +73,7 @@ configure specific aspects of kernel behavior to your liking.
java
ras
bcache
+ blockdev/index
ext4
pm/index
thunderbolt
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 9b535c0e22f3..49ad034c4675 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -1249,7 +1249,7 @@
See also Documentation/fault-injection/.
floppy= [HW]
- See Documentation/blockdev/floppy.rst.
+ See Documentation/admin-guide/blockdev/floppy.rst.
force_pal_cache_flush
[IA-64] Avoid check_sal_cache_flush which may hang on
@@ -2247,7 +2247,7 @@
memblock=debug [KNL] Enable memblock debug messages.
load_ramdisk= [RAM] List of ramdisks to load from floppy
- See Documentation/blockdev/ramdisk.rst.
+ See Documentation/admin-guide/blockdev/ramdisk.rst.
lockd.nlm_grace_period=P [NFS] Assign grace period.
Format: <integer>
@@ -3294,7 +3294,7 @@
pcd. [PARIDE]
See header of drivers/block/paride/pcd.c.
- See also Documentation/blockdev/paride.rst.
+ See also Documentation/admin-guide/blockdev/paride.rst.
pci=option[,option...] [PCI] various PCI subsystem options.
@@ -3538,7 +3538,7 @@
needed on a platform with proper driver support.
pd. [PARIDE]
- See Documentation/blockdev/paride.rst.
+ See Documentation/admin-guide/blockdev/paride.rst.
pdcchassis= [PARISC,HW] Disable/Enable PDC Chassis Status codes at
boot time.
@@ -3553,10 +3553,10 @@
and performance comparison.
pf. [PARIDE]
- See Documentation/blockdev/paride.rst.
+ See Documentation/admin-guide/blockdev/paride.rst.
pg. [PARIDE]
- See Documentation/blockdev/paride.rst.
+ See Documentation/admin-guide/blockdev/paride.rst.
pirq= [SMP,APIC] Manual mp-table setup
See Documentation/x86/i386/IO-APIC.rst.
@@ -3668,7 +3668,7 @@
prompt_ramdisk= [RAM] List of RAM disks to prompt for floppy disk
before loading.
- See Documentation/blockdev/ramdisk.rst.
+ See Documentation/admin-guide/blockdev/ramdisk.rst.
psi= [KNL] Enable or disable pressure stall information
tracking.
@@ -3690,7 +3690,7 @@
pstore.backend= Specify the name of the pstore backend to use
pt. [PARIDE]
- See Documentation/blockdev/paride.rst.
+ See Documentation/admin-guide/blockdev/paride.rst.
pti= [X86_64] Control Page Table Isolation of user and
kernel address spaces. Disabling this feature
@@ -3719,7 +3719,7 @@
See Documentation/admin-guide/md.rst.
ramdisk_size= [RAM] Sizes of RAM disks in kilobytes
- See Documentation/blockdev/ramdisk.rst.
+ See Documentation/admin-guide/blockdev/ramdisk.rst.
random.trust_cpu={on,off}
[KNL] Enable or disable trusting the use of the
diff --git a/MAINTAINERS b/MAINTAINERS
index 4c622a19ab7d..3f0f654d1166 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4974,7 +4974,7 @@ T: git git://git.linbit.com/drbd-8.4.git
S: Supported
F: drivers/block/drbd/
F: lib/lru_cache.c
-F: Documentation/blockdev/drbd/
+F: Documentation/admin-guide/blockdev/
DRIVER CORE, KOBJECTS, DEBUGFS AND SYSFS
M: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
@@ -11024,7 +11024,7 @@ M: Josef Bacik <josef@toxicpanda.com>
S: Maintained
L: linux-block@vger.kernel.org
L: nbd@other.debian.org
-F: Documentation/blockdev/nbd.rst
+F: Documentation/admin-guide/blockdev/nbd.rst
F: drivers/block/nbd.c
F: include/trace/events/nbd.h
F: include/uapi/linux/nbd.h
@@ -12028,7 +12028,7 @@ PARIDE DRIVERS FOR PARALLEL PORT IDE DEVICES
M: Tim Waugh <tim@cyberelk.net>
L: linux-parport@lists.infradead.org (subscribers-only)
S: Maintained
-F: Documentation/blockdev/paride.rst
+F: Documentation/admin-guide/blockdev/paride.rst
F: drivers/block/paride/
PARISC ARCHITECTURE
@@ -13310,7 +13310,7 @@ F: drivers/net/wireless/ralink/rt2x00/
RAMDISK RAM BLOCK DEVICE DRIVER
M: Jens Axboe <axboe@kernel.dk>
S: Maintained
-F: Documentation/blockdev/ramdisk.rst
+F: Documentation/admin-guide/blockdev/ramdisk.rst
F: drivers/block/brd.c
RANCHU VIRTUAL BOARD FOR MIPS
@@ -17672,7 +17672,7 @@ R: Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>
L: linux-kernel@vger.kernel.org
S: Maintained
F: drivers/block/zram/
-F: Documentation/blockdev/zram.rst
+F: Documentation/admin-guide/blockdev/zram.rst
ZS DECSTATION Z85C30 SERIAL DRIVER
M: "Maciej W. Rozycki" <macro@linux-mips.org>
diff --git a/drivers/block/Kconfig b/drivers/block/Kconfig
index c43690b973d8..1bb8ec575352 100644
--- a/drivers/block/Kconfig
+++ b/drivers/block/Kconfig
@@ -31,7 +31,7 @@ config BLK_DEV_FD
If you want to use the floppy disk drive(s) of your PC under Linux,
say Y. Information about this driver, especially important for IBM
Thinkpad users, is contained in
- <file:Documentation/blockdev/floppy.rst>.
+ <file:Documentation/admin-guide/blockdev/floppy.rst>.
That file also contains the location of the Floppy driver FAQ as
well as location of the fdutils package used to configure additional
parameters of the driver at run time.
@@ -96,7 +96,7 @@ config PARIDE
your computer's parallel port. Most of them are actually IDE devices
using a parallel port IDE adapter. This option enables the PARIDE
subsystem which contains drivers for many of these external drives.
- Read <file:Documentation/blockdev/paride.rst> for more information.
+ Read <file:Documentation/admin-guide/blockdev/paride.rst> for more information.
If you have said Y to the "Parallel-port support" configuration
option, you may share a single port between your printer and other
@@ -261,7 +261,7 @@ config BLK_DEV_NBD
userland (making server and client physically the same computer,
communicating using the loopback network device).
- Read <file:Documentation/blockdev/nbd.rst> for more information,
+ Read <file:Documentation/admin-guide/blockdev/nbd.rst> for more information,
especially about where to find the server code, which runs in user
space and does not need special kernel support.
@@ -303,7 +303,7 @@ config BLK_DEV_RAM
during the initial install of Linux.
Note that the kernel command line option "ramdisk=XX" is now obsolete.
- For details, read <file:Documentation/blockdev/ramdisk.rst>.
+ For details, read <file:Documentation/admin-guide/blockdev/ramdisk.rst>.
To compile this driver as a module, choose M here: the
module will be called brd. An alias "rd" has been defined
diff --git a/drivers/block/floppy.c b/drivers/block/floppy.c
index 5c99e52f9dc1..f652c1ac3ae9 100644
--- a/drivers/block/floppy.c
+++ b/drivers/block/floppy.c
@@ -4424,7 +4424,7 @@ static int __init floppy_setup(char *str)
pr_cont("\n");
} else
DPRINT("botched floppy option\n");
- DPRINT("Read Documentation/blockdev/floppy.rst\n");
+ DPRINT("Read Documentation/admin-guide/blockdev/floppy.rst\n");
return 0;
}
diff --git a/drivers/block/zram/Kconfig b/drivers/block/zram/Kconfig
index e06b99d54816..fe7a4b7d30cf 100644
--- a/drivers/block/zram/Kconfig
+++ b/drivers/block/zram/Kconfig
@@ -12,7 +12,7 @@ config ZRAM
It has several use cases, for example: /tmp storage, use as swap
disks and maybe many more.
- See Documentation/blockdev/zram.rst for more information.
+ See Documentation/admin-guide/blockdev/zram.rst for more information.
config ZRAM_WRITEBACK
bool "Write back incompressible or idle page to backing device"
@@ -26,7 +26,7 @@ config ZRAM_WRITEBACK
With /sys/block/zramX/{idle,writeback}, application could ask
idle page's writeback to the backing device to save in memory.
- See Documentation/blockdev/zram.rst for more information.
+ See Documentation/admin-guide/blockdev/zram.rst for more information.
config ZRAM_MEMORY_TRACKING
bool "Track zRam block status"
@@ -36,4 +36,4 @@ config ZRAM_MEMORY_TRACKING
of zRAM. Admin could see the information via
/sys/kernel/debug/zram/zramX/block_state.
- See Documentation/blockdev/zram.rst for more information.
+ See Documentation/admin-guide/blockdev/zram.rst for more information.
diff --git a/tools/testing/selftests/zram/README b/tools/testing/selftests/zram/README
index 5fa378391d3b..110b34834a6f 100644
--- a/tools/testing/selftests/zram/README
+++ b/tools/testing/selftests/zram/README
@@ -37,4 +37,4 @@ Commands required for testing:
- mkfs/ mkfs.ext4
For more information please refer:
-kernel-source-tree/Documentation/blockdev/zram.rst
+kernel-source-tree/Documentation/admin-guide/blockdev/zram.rst
--
2.21.0
^ permalink raw reply related
* [PATCH 13/39] docs: add arch doc directories to the index
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, Catalin Marinas, Will Deacon,
Benjamin Herrenschmidt, Paul Mackerras, Michael Ellerman,
Palmer Dabbelt, Albert Ou, Heiko Carstens, Vasily Gorbik,
Christian Borntraeger, linux-arm-kernel, linuxppc-dev,
linux-riscv, linux-s390
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
Now that several arch documents were converted to ReST,
add their indexes to Documentation/index.rst and remove the
:orphan: from them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/arm/index.rst | 2 --
Documentation/arm64/index.rst | 2 --
Documentation/ia64/index.rst | 2 --
Documentation/index.rst | 10 ++++++++++
Documentation/m68k/index.rst | 2 +-
Documentation/powerpc/index.rst | 2 +-
Documentation/riscv/index.rst | 2 --
Documentation/s390/index.rst | 2 --
Documentation/sparc/index.rst | 2 --
Documentation/xtensa/index.rst | 2 +-
10 files changed, 13 insertions(+), 15 deletions(-)
diff --git a/Documentation/arm/index.rst b/Documentation/arm/index.rst
index bd316d1a1802..9c2f781f4685 100644
--- a/Documentation/arm/index.rst
+++ b/Documentation/arm/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
================
ARM Architecture
================
diff --git a/Documentation/arm64/index.rst b/Documentation/arm64/index.rst
index 018b7836ecb7..96b696ba4e6c 100644
--- a/Documentation/arm64/index.rst
+++ b/Documentation/arm64/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
==================
ARM64 Architecture
==================
diff --git a/Documentation/ia64/index.rst b/Documentation/ia64/index.rst
index a3e3052ad6e2..ef99475f672b 100644
--- a/Documentation/ia64/index.rst
+++ b/Documentation/ia64/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
==================
IA-64 Architecture
==================
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 95db26bf2899..f898def833f4 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -118,7 +118,17 @@ implementation.
:maxdepth: 2
sh/index
+ arm/index
+ arm64/index
+ ia64/index
+ m68k/index
+ powerpc/index
+ riscv/index
+ s390/index
+ sh/index
+ sparc/index
x86/index
+ xtensa/index
Filesystem Documentation
------------------------
diff --git a/Documentation/m68k/index.rst b/Documentation/m68k/index.rst
index f3273ec075c3..3a5ba7fe1703 100644
--- a/Documentation/m68k/index.rst
+++ b/Documentation/m68k/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=================
m68k Architecture
diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst
index 1ff17268db46..549b1cdd77ae 100644
--- a/Documentation/powerpc/index.rst
+++ b/Documentation/powerpc/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
=======
powerpc
diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst
index c4b906d9b5a7..e3ca0922a8c2 100644
--- a/Documentation/riscv/index.rst
+++ b/Documentation/riscv/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===================
RISC-V architecture
===================
diff --git a/Documentation/s390/index.rst b/Documentation/s390/index.rst
index 1a914da2a07b..4602312909d3 100644
--- a/Documentation/s390/index.rst
+++ b/Documentation/s390/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
=================
s390 Architecture
=================
diff --git a/Documentation/sparc/index.rst b/Documentation/sparc/index.rst
index 91f7d6643dd5..71cff621f243 100644
--- a/Documentation/sparc/index.rst
+++ b/Documentation/sparc/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
==================
Sparc Architecture
==================
diff --git a/Documentation/xtensa/index.rst b/Documentation/xtensa/index.rst
index 5a24e365e35f..52fa04eb39a3 100644
--- a/Documentation/xtensa/index.rst
+++ b/Documentation/xtensa/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
===================
Xtensa Architecture
--
2.21.0
^ permalink raw reply related
* [PATCH 37/39] docs: adds some directories to the main documentation index
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, Jens Axboe, Akinobu Mita,
Bartlomiej Zolnierkiewicz, Moritz Fischer, David S. Miller,
Masahiro Yamada, Michal Marek, Josh Poimboeuf, Jiri Kosina,
Miroslav Benes, Petr Mladek, Joe Lawrence, Paul Moore,
Dominik Brodowski, Rafael J. Wysocki, Len Brown, Pavel Machek,
Martin K. Petersen, Thomas Gleixner, Wim Van Sebroeck,
Guenter Roeck, dri-devel, linux-fbdev, linux-fpga, linux-ide,
linux-kbuild, live-patching, netdev, linux-security-module,
linux-pm, linux-scsi, target-devel, linux-watchdog
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
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
* [PATCH 18/39] docs: admin-guide: add kdump documentation into it
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, Dave Young, Baoquan He, Vivek Goyal,
Benjamin Herrenschmidt, Paul Mackerras, Michael Ellerman,
Harry Wei, Alex Shi, Jerry Hoemann, Wim Van Sebroeck,
Guenter Roeck, Russell King, Catalin Marinas, Will Deacon,
Yoshinori Sato, Rich Felker, Thomas Gleixner, Ingo Molnar,
Borislav Petkov, H. Peter Anvin, x86, kexec, linuxppc-dev,
linux-watchdog, linux-arm-kernel, linux-sh
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The Kdump documentation describes procedures with admins use
in order to solve issues on their systems.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/admin-guide/bug-hunting.rst | 4 ++--
Documentation/admin-guide/index.rst | 1 +
Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0
Documentation/{ => admin-guide}/kdump/index.rst | 1 -
Documentation/{ => admin-guide}/kdump/kdump.rst | 0
Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0
Documentation/admin-guide/kernel-parameters.txt | 6 +++---
Documentation/powerpc/firmware-assisted-dump.rst | 2 +-
Documentation/translations/zh_CN/oops-tracing.txt | 4 ++--
Documentation/watchdog/hpwdt.rst | 2 +-
MAINTAINERS | 2 +-
arch/arm/Kconfig | 2 +-
arch/arm64/Kconfig | 2 +-
arch/sh/Kconfig | 2 +-
arch/x86/Kconfig | 4 ++--
15 files changed, 16 insertions(+), 16 deletions(-)
rename Documentation/{ => admin-guide}/kdump/gdbmacros.txt (100%)
rename Documentation/{ => admin-guide}/kdump/index.rst (97%)
rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%)
rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%)
diff --git a/Documentation/admin-guide/bug-hunting.rst b/Documentation/admin-guide/bug-hunting.rst
index b761aa2a51d2..44b8a4edd348 100644
--- a/Documentation/admin-guide/bug-hunting.rst
+++ b/Documentation/admin-guide/bug-hunting.rst
@@ -90,9 +90,9 @@ the disk is not available then you have three options:
run a null modem to a second machine and capture the output there
using your favourite communication program. Minicom works well.
-(3) Use Kdump (see Documentation/kdump/kdump.rst),
+(3) Use Kdump (see Documentation/admin-guide/kdump/kdump.rst),
extract the kernel ring buffer from old memory with using dmesg
- gdbmacro in Documentation/kdump/gdbmacros.txt.
+ gdbmacro in Documentation/admin-guide/kdump/gdbmacros.txt.
Finding the bug's location
--------------------------
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 9899b78dbe50..65e821a03aca 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -39,6 +39,7 @@ problems and bugs in particular.
ramoops
dynamic-debug-howto
init
+ kdump/index
perf/index
This is the beginning of a section with information of interest to
diff --git a/Documentation/kdump/gdbmacros.txt b/Documentation/admin-guide/kdump/gdbmacros.txt
similarity index 100%
rename from Documentation/kdump/gdbmacros.txt
rename to Documentation/admin-guide/kdump/gdbmacros.txt
diff --git a/Documentation/kdump/index.rst b/Documentation/admin-guide/kdump/index.rst
similarity index 97%
rename from Documentation/kdump/index.rst
rename to Documentation/admin-guide/kdump/index.rst
index 2b17fcf6867a..8e2ebd0383cd 100644
--- a/Documentation/kdump/index.rst
+++ b/Documentation/admin-guide/kdump/index.rst
@@ -1,4 +1,3 @@
-:orphan:
================================================================
Documentation for Kdump - The kexec-based Crash Dumping Solution
diff --git a/Documentation/kdump/kdump.rst b/Documentation/admin-guide/kdump/kdump.rst
similarity index 100%
rename from Documentation/kdump/kdump.rst
rename to Documentation/admin-guide/kdump/kdump.rst
diff --git a/Documentation/kdump/vmcoreinfo.rst b/Documentation/admin-guide/kdump/vmcoreinfo.rst
similarity index 100%
rename from Documentation/kdump/vmcoreinfo.rst
rename to Documentation/admin-guide/kdump/vmcoreinfo.rst
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index e38b96d061f4..9b535c0e22f3 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -708,14 +708,14 @@
[KNL, x86_64] select a region under 4G first, and
fall back to reserve region above 4G when '@offset'
hasn't been specified.
- See Documentation/kdump/kdump.rst for further details.
+ See Documentation/admin-guide/kdump/kdump.rst for further details.
crashkernel=range1:size1[,range2:size2,...][@offset]
[KNL] Same as above, but depends on the memory
in the running system. The syntax of range is
start-[end] where start and end are both
a memory unit (amount[KMG]). See also
- Documentation/kdump/kdump.rst for an example.
+ Documentation/admin-guide/kdump/kdump.rst for an example.
crashkernel=size[KMG],high
[KNL, x86_64] range could be above 4G. Allow kernel
@@ -1207,7 +1207,7 @@
Specifies physical address of start of kernel core
image elf header and optionally the size. Generally
kexec loader will pass this option to capture kernel.
- See Documentation/kdump/kdump.rst for details.
+ See Documentation/admin-guide/kdump/kdump.rst for details.
enable_mtrr_cleanup [X86]
The kernel tries to adjust MTRR layout from continuous
diff --git a/Documentation/powerpc/firmware-assisted-dump.rst b/Documentation/powerpc/firmware-assisted-dump.rst
index d7fa7c35dd12..9ca12830a48e 100644
--- a/Documentation/powerpc/firmware-assisted-dump.rst
+++ b/Documentation/powerpc/firmware-assisted-dump.rst
@@ -61,7 +61,7 @@ as follows:
the default calculated size. Use this option if default
boot memory size is not sufficient for second kernel to
boot successfully. For syntax of crashkernel= parameter,
- refer to Documentation/kdump/kdump.rst. If any offset is
+ refer to Documentation/admin-guide/kdump/kdump.rst. If any offset is
provided in crashkernel= parameter, it will be ignored
as fadump uses a predefined offset to reserve memory
for boot memory dump preservation in case of a crash.
diff --git a/Documentation/translations/zh_CN/oops-tracing.txt b/Documentation/translations/zh_CN/oops-tracing.txt
index 368ddd05b304..c5f3bda7abcb 100644
--- a/Documentation/translations/zh_CN/oops-tracing.txt
+++ b/Documentation/translations/zh_CN/oops-tracing.txt
@@ -53,8 +53,8 @@ cat /proc/kmsg > file， 然而你必须介入中止传输， kmsg是一个“
（2）用串口终端启动（请参看Documentation/admin-guide/serial-console.rst），运行一个null
modem到另一台机器并用你喜欢的通讯工具获取输出。Minicom工作地很好。
-（3）使用Kdump（请参看Documentation/kdump/kdump.rst），
-使用在Documentation/kdump/gdbmacros.txt中定义的dmesg gdb宏，从旧的内存中提取内核
+（3）使用Kdump（请参看Documentation/admin-guide/kdump/kdump.rst），
+使用在Documentation/admin-guide/kdump/gdbmacros.txt中定义的dmesg gdb宏，从旧的内存中提取内核
环形缓冲区。
完整信息
diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst
index 94a96371113e..49c647dba8aa 100644
--- a/Documentation/watchdog/hpwdt.rst
+++ b/Documentation/watchdog/hpwdt.rst
@@ -59,7 +59,7 @@ Last reviewed: 08/20/2018
and loop forever. This is generally not what a watchdog user wants.
For those wishing to learn more please see:
- Documentation/kdump/kdump.rst
+ Documentation/admin-guide/kdump/kdump.rst
Documentation/admin-guide/kernel-parameters.txt (panic=)
Your Linux Distribution specific documentation.
diff --git a/MAINTAINERS b/MAINTAINERS
index d35ff73f718a..4c622a19ab7d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8622,7 +8622,7 @@ R: Vivek Goyal <vgoyal@redhat.com>
L: kexec@lists.infradead.org
W: http://lse.sourceforge.net/kdump/
S: Maintained
-F: Documentation/kdump/
+F: Documentation/admin-guide/kdump/
KEENE FM RADIO TRANSMITTER DRIVER
M: Hans Verkuil <hverkuil@xs4all.nl>
diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig
index 8bf8985ec667..d5bd4350fcbd 100644
--- a/arch/arm/Kconfig
+++ b/arch/arm/Kconfig
@@ -2025,7 +2025,7 @@ config CRASH_DUMP
kdump/kexec. The crash dump kernel must be compiled to a
memory address not used by the main kernel
- For more details see Documentation/kdump/kdump.rst
+ For more details see Documentation/admin-guide/kdump/kdump.rst
config AUTO_ZRELADDR
bool "Auto calculation of the decompressed kernel image address"
diff --git a/arch/arm64/Kconfig b/arch/arm64/Kconfig
index accb045997c6..e1ea69994e0f 100644
--- a/arch/arm64/Kconfig
+++ b/arch/arm64/Kconfig
@@ -997,7 +997,7 @@ config CRASH_DUMP
reserved region and then later executed after a crash by
kdump/kexec.
- For more details see Documentation/kdump/kdump.rst
+ For more details see Documentation/admin-guide/kdump/kdump.rst
config XEN_DOM0
def_bool y
diff --git a/arch/sh/Kconfig b/arch/sh/Kconfig
index 31a7d12db705..c2858ac6a46a 100644
--- a/arch/sh/Kconfig
+++ b/arch/sh/Kconfig
@@ -626,7 +626,7 @@ config CRASH_DUMP
to a memory address not used by the main kernel using
PHYSICAL_START.
- For more details see Documentation/kdump/kdump.rst
+ For more details see Documentation/admin-guide/kdump/kdump.rst
config KEXEC_JUMP
bool "kexec jump (EXPERIMENTAL)"
diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
index c9d59ca5e3ac..489fd833b980 100644
--- a/arch/x86/Kconfig
+++ b/arch/x86/Kconfig
@@ -2057,7 +2057,7 @@ config CRASH_DUMP
to a memory address not used by the main kernel or BIOS using
PHYSICAL_START, or it must be built as a relocatable image
(CONFIG_RELOCATABLE=y).
- For more details see Documentation/kdump/kdump.rst
+ For more details see Documentation/admin-guide/kdump/kdump.rst
config KEXEC_JUMP
bool "kexec jump"
@@ -2094,7 +2094,7 @@ config PHYSICAL_START
the reserved region. In other words, it can be set based on
the "X" value as specified in the "crashkernel=YM@XM"
command line boot parameter passed to the panic-ed
- kernel. Please take a look at Documentation/kdump/kdump.rst
+ kernel. Please take a look at Documentation/admin-guide/kdump/kdump.rst
for more details about crash dumps.
Usage of bzImage for capturing the crash dump is recommended as
--
2.21.0
^ permalink raw reply related
* [PATCH 24/39] docs: driver-model: move it to the driver-api book
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, Linus Walleij, Bartosz Golaszewski, Jean Delvare,
Guenter Roeck, Harry Wei, Alex Shi, Greg Kroah-Hartman,
Rafael J. Wysocki, Jeff Kirsher, David S. Miller, David Kershner,
Julia Lawall, Gilles Muller, Nicolas Palix, Michal Marek,
linux-gpio, linux-hwmon, intel-wired-lan, netdev, sparmaintainer,
devel, cocci
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The audience for the Kernel driver-model is clearly Kernel hackers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/{ => driver-api}/driver-model/binding.rst | 0
Documentation/{ => driver-api}/driver-model/bus.rst | 0
Documentation/{ => driver-api}/driver-model/class.rst | 0
.../{ => driver-api}/driver-model/design-patterns.rst | 0
Documentation/{ => driver-api}/driver-model/device.rst | 0
Documentation/{ => driver-api}/driver-model/devres.rst | 0
Documentation/{ => driver-api}/driver-model/driver.rst | 0
Documentation/{ => driver-api}/driver-model/index.rst | 2 --
Documentation/{ => driver-api}/driver-model/overview.rst | 0
Documentation/{ => driver-api}/driver-model/platform.rst | 0
Documentation/{ => driver-api}/driver-model/porting.rst | 2 +-
Documentation/driver-api/gpio/driver.rst | 2 +-
Documentation/driver-api/index.rst | 1 +
Documentation/eisa.txt | 4 ++--
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
Documentation/translations/zh_CN/filesystems/sysfs.txt | 2 +-
drivers/base/platform.c | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
drivers/staging/unisys/Documentation/overview.txt | 4 ++--
include/linux/device.h | 2 +-
include/linux/platform_device.h | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
24 files changed, 16 insertions(+), 17 deletions(-)
rename Documentation/{ => driver-api}/driver-model/binding.rst (100%)
rename Documentation/{ => driver-api}/driver-model/bus.rst (100%)
rename Documentation/{ => driver-api}/driver-model/class.rst (100%)
rename Documentation/{ => driver-api}/driver-model/design-patterns.rst (100%)
rename Documentation/{ => driver-api}/driver-model/device.rst (100%)
rename Documentation/{ => driver-api}/driver-model/devres.rst (100%)
rename Documentation/{ => driver-api}/driver-model/driver.rst (100%)
rename Documentation/{ => driver-api}/driver-model/index.rst (96%)
rename Documentation/{ => driver-api}/driver-model/overview.rst (100%)
rename Documentation/{ => driver-api}/driver-model/platform.rst (100%)
rename Documentation/{ => driver-api}/driver-model/porting.rst (99%)
diff --git a/Documentation/driver-model/binding.rst b/Documentation/driver-api/driver-model/binding.rst
similarity index 100%
rename from Documentation/driver-model/binding.rst
rename to Documentation/driver-api/driver-model/binding.rst
diff --git a/Documentation/driver-model/bus.rst b/Documentation/driver-api/driver-model/bus.rst
similarity index 100%
rename from Documentation/driver-model/bus.rst
rename to Documentation/driver-api/driver-model/bus.rst
diff --git a/Documentation/driver-model/class.rst b/Documentation/driver-api/driver-model/class.rst
similarity index 100%
rename from Documentation/driver-model/class.rst
rename to Documentation/driver-api/driver-model/class.rst
diff --git a/Documentation/driver-model/design-patterns.rst b/Documentation/driver-api/driver-model/design-patterns.rst
similarity index 100%
rename from Documentation/driver-model/design-patterns.rst
rename to Documentation/driver-api/driver-model/design-patterns.rst
diff --git a/Documentation/driver-model/device.rst b/Documentation/driver-api/driver-model/device.rst
similarity index 100%
rename from Documentation/driver-model/device.rst
rename to Documentation/driver-api/driver-model/device.rst
diff --git a/Documentation/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst
similarity index 100%
rename from Documentation/driver-model/devres.rst
rename to Documentation/driver-api/driver-model/devres.rst
diff --git a/Documentation/driver-model/driver.rst b/Documentation/driver-api/driver-model/driver.rst
similarity index 100%
rename from Documentation/driver-model/driver.rst
rename to Documentation/driver-api/driver-model/driver.rst
diff --git a/Documentation/driver-model/index.rst b/Documentation/driver-api/driver-model/index.rst
similarity index 96%
rename from Documentation/driver-model/index.rst
rename to Documentation/driver-api/driver-model/index.rst
index 9f85d579ce56..755016422269 100644
--- a/Documentation/driver-model/index.rst
+++ b/Documentation/driver-api/driver-model/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
============
Driver Model
============
diff --git a/Documentation/driver-model/overview.rst b/Documentation/driver-api/driver-model/overview.rst
similarity index 100%
rename from Documentation/driver-model/overview.rst
rename to Documentation/driver-api/driver-model/overview.rst
diff --git a/Documentation/driver-model/platform.rst b/Documentation/driver-api/driver-model/platform.rst
similarity index 100%
rename from Documentation/driver-model/platform.rst
rename to Documentation/driver-api/driver-model/platform.rst
diff --git a/Documentation/driver-model/porting.rst b/Documentation/driver-api/driver-model/porting.rst
similarity index 99%
rename from Documentation/driver-model/porting.rst
rename to Documentation/driver-api/driver-model/porting.rst
index ae4bf843c1d6..931ea879af3f 100644
--- a/Documentation/driver-model/porting.rst
+++ b/Documentation/driver-api/driver-model/porting.rst
@@ -9,7 +9,7 @@ Patrick Mochel
Overview
-Please refer to `Documentation/driver-model/*.rst` for definitions of
+Please refer to `Documentation/driver-api/driver-model/*.rst` for definitions of
various driver types and concepts.
Most of the work of porting devices drivers to the new model happens
diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst
index 349f2dc33029..921c71a3d683 100644
--- a/Documentation/driver-api/gpio/driver.rst
+++ b/Documentation/driver-api/gpio/driver.rst
@@ -399,7 +399,7 @@ symbol:
will pass the struct gpio_chip* for the chip to all IRQ callbacks, so the
callbacks need to embed the gpio_chip in its state container and obtain a
pointer to the container using container_of().
- (See Documentation/driver-model/design-patterns.rst)
+ (See Documentation/driver-api/driver-model/design-patterns.rst)
- gpiochip_irqchip_add_nested(): adds a nested cascaded irqchip to a gpiochip,
as discussed above regarding different types of cascaded irqchips. The
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index fea0034afa56..93d187bf4853 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -14,6 +14,7 @@ available subsections can be seen below.
.. toctree::
:maxdepth: 2
+ driver-model/index
basics
infrastructure
early-userspace/index
diff --git a/Documentation/eisa.txt b/Documentation/eisa.txt
index f388545a85a7..c07565ba57da 100644
--- a/Documentation/eisa.txt
+++ b/Documentation/eisa.txt
@@ -103,7 +103,7 @@ id_table an array of NULL terminated EISA id strings,
(driver_data).
driver a generic driver, such as described in
- Documentation/driver-model/driver.rst. Only .name,
+ Documentation/driver-api/driver-model/driver.rst. Only .name,
.probe and .remove members are mandatory.
=============== ====================================================
@@ -152,7 +152,7 @@ state set of flags indicating the state of the device. Current
flags are EISA_CONFIG_ENABLED and EISA_CONFIG_FORCED.
res set of four 256 bytes I/O regions allocated to this device
dma_mask DMA mask set from the parent device.
-dev generic device (see Documentation/driver-model/device.rst)
+dev generic device (see Documentation/driver-api/driver-model/device.rst)
======== ============================================================
You can get the 'struct eisa_device' from 'struct device' using the
diff --git a/Documentation/filesystems/sysfs.txt b/Documentation/filesystems/sysfs.txt
index 5b5311f9358d..ddf15b1b0d5a 100644
--- a/Documentation/filesystems/sysfs.txt
+++ b/Documentation/filesystems/sysfs.txt
@@ -319,7 +319,7 @@ quick way to lookup the sysfs interface for a device from the result of
a stat(2) operation.
More information can driver-model specific features can be found in
-Documentation/driver-model/.
+Documentation/driver-api/driver-model/.
TODO: Finish this section.
diff --git a/Documentation/hwmon/submitting-patches.rst b/Documentation/hwmon/submitting-patches.rst
index d5b05d3e54ba..452fc28d8e0b 100644
--- a/Documentation/hwmon/submitting-patches.rst
+++ b/Documentation/hwmon/submitting-patches.rst
@@ -89,7 +89,7 @@ increase the chances of your change being accepted.
console. Excessive logging can seriously affect system performance.
* Use devres functions whenever possible to allocate resources. For rationale
- and supported functions, please see Documentation/driver-model/devres.rst.
+ and supported functions, please see Documentation/driver-api/driver-model/devres.rst.
If a function is not supported by devres, consider using devm_add_action().
* If the driver has a detect function, make sure it is silent. Debug messages
diff --git a/Documentation/translations/zh_CN/filesystems/sysfs.txt b/Documentation/translations/zh_CN/filesystems/sysfs.txt
index 452271dda141..ee1f37da5b23 100644
--- a/Documentation/translations/zh_CN/filesystems/sysfs.txt
+++ b/Documentation/translations/zh_CN/filesystems/sysfs.txt
@@ -288,7 +288,7 @@ dev/ 包含两个子目录： char/ 和 block/。在这两个子目录中，有
中相应的设备。/sys/dev 提供一个通过一个 stat(2) 操作结果，查找
设备 sysfs 接口快捷的方法。
-更多有关 driver-model 的特性信息可以在 Documentation/driver-model/
+更多有关 driver-model 的特性信息可以在 Documentation/driver-api/driver-model/
中找到。
diff --git a/drivers/base/platform.c b/drivers/base/platform.c
index 713903290385..506a0175a5a7 100644
--- a/drivers/base/platform.c
+++ b/drivers/base/platform.c
@@ -5,7 +5,7 @@
* Copyright (c) 2002-3 Patrick Mochel
* Copyright (c) 2002-3 Open Source Development Labs
*
- * Please see Documentation/driver-model/platform.rst for more
+ * Please see Documentation/driver-api/driver-model/platform.rst for more
* information.
*/
diff --git a/drivers/gpio/gpio-cs5535.c b/drivers/gpio/gpio-cs5535.c
index 3611a0571667..53b24e3ae7de 100644
--- a/drivers/gpio/gpio-cs5535.c
+++ b/drivers/gpio/gpio-cs5535.c
@@ -41,7 +41,7 @@ MODULE_PARM_DESC(mask, "GPIO channel mask.");
/*
* FIXME: convert this singleton driver to use the state container
- * design pattern, see Documentation/driver-model/design-patterns.rst
+ * design pattern, see Documentation/driver-api/driver-model/design-patterns.rst
*/
static struct cs5535_gpio_chip {
struct gpio_chip chip;
diff --git a/drivers/net/ethernet/intel/ice/ice_main.c b/drivers/net/ethernet/intel/ice/ice_main.c
index 41c90f2ddb31..63db08d9bafa 100644
--- a/drivers/net/ethernet/intel/ice/ice_main.c
+++ b/drivers/net/ethernet/intel/ice/ice_main.c
@@ -2286,7 +2286,7 @@ ice_probe(struct pci_dev *pdev, const struct pci_device_id __always_unused *ent)
struct ice_hw *hw;
int err;
- /* this driver uses devres, see Documentation/driver-model/devres.rst */
+ /* this driver uses devres, see Documentation/driver-api/driver-model/devres.rst */
err = pcim_enable_device(pdev);
if (err)
return err;
diff --git a/drivers/staging/unisys/Documentation/overview.txt b/drivers/staging/unisys/Documentation/overview.txt
index 9ab30af265a5..f8a4144b239c 100644
--- a/drivers/staging/unisys/Documentation/overview.txt
+++ b/drivers/staging/unisys/Documentation/overview.txt
@@ -15,7 +15,7 @@ normally be unsharable, specifically:
* visorinput - keyboard and mouse
These drivers conform to the standard Linux bus/device model described
-within Documentation/driver-model/, and utilize a driver named visorbus to
+within Documentation/driver-api/driver-model/, and utilize a driver named visorbus to
present the virtual busses involved. Drivers in the 'visor*' driver set are
commonly referred to as "guest drivers" or "client drivers". All drivers
except visorbus expose a device of a specific usable class to the Linux guest
@@ -141,7 +141,7 @@ called automatically by the visorbus driver at appropriate times:
-----------------------------------
Because visorbus is a standard Linux bus driver in the model described in
-Documentation/driver-model/, the hierarchy of s-Par virtual devices is
+Documentation/driver-api/driver-model/, the hierarchy of s-Par virtual devices is
published in the sysfs tree beneath /bus/visorbus/, e.g.,
/sys/bus/visorbus/devices/ might look like:
diff --git a/include/linux/device.h b/include/linux/device.h
index 4f65c424e5fd..93b12aec9bff 100644
--- a/include/linux/device.h
+++ b/include/linux/device.h
@@ -6,7 +6,7 @@
* Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
* Copyright (c) 2008-2009 Novell Inc.
*
- * See Documentation/driver-model/ for more information.
+ * See Documentation/driver-api/driver-model/ for more information.
*/
#ifndef _DEVICE_H_
diff --git a/include/linux/platform_device.h b/include/linux/platform_device.h
index beb25f277889..9bc36b589827 100644
--- a/include/linux/platform_device.h
+++ b/include/linux/platform_device.h
@@ -4,7 +4,7 @@
*
* Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
*
- * See Documentation/driver-model/ for more information.
+ * See Documentation/driver-api/driver-model/ for more information.
*/
#ifndef _PLATFORM_DEVICE_H_
diff --git a/scripts/coccinelle/free/devm_free.cocci b/scripts/coccinelle/free/devm_free.cocci
index fefd0331a2de..441799b5359b 100644
--- a/scripts/coccinelle/free/devm_free.cocci
+++ b/scripts/coccinelle/free/devm_free.cocci
@@ -3,7 +3,7 @@
/// functions. Values allocated using the devm_functions are freed when
/// the device is detached, and thus the use of the standard freeing
/// function would cause a double free.
-/// See Documentation/driver-model/devres.rst for more information.
+/// See Documentation/driver-api/driver-model/devres.rst for more information.
///
/// A difficulty of detecting this problem is that the standard freeing
/// function might be called from a different function than the one
--
2.21.0
^ permalink raw reply related
* [PATCH 28/39] docs: admin-guide: add a series of orphaned documents
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, H. Peter Anvin,
x86, Russell King, James E.J. Bottomley, Helge Deller,
Yoshinori Sato, Rich Felker, David S. Miller, Jens Axboe,
Arnd Bergmann, Greg Kroah-Hartman, linux-efi, linux-crypto,
linux-ntfs-dev, linux-rtc, linux-video, dri-devel, linux-fbdev,
linux-arm-kernel, linux-parisc, linux-sh, sparclinux, linux-block
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
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
* [PATCH 17/39] docs: admin-guide: add laptops documentation
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, Matan Ziv-Av, Mattia Dongili, Arnd Bergmann,
Greg Kroah-Hartman, Darren Hart, Andy Shevchenko,
platform-driver-x86
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The docs under Documentation/laptops contain users specific
information.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/ABI/testing/sysfs-block-device | 2 +-
Documentation/ABI/testing/sysfs-platform-asus-laptop | 2 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.txt | 2 +-
Documentation/{ => admin-guide}/laptops/asus-laptop.rst | 0
.../{ => admin-guide}/laptops/disk-shock-protection.rst | 0
Documentation/{ => admin-guide}/laptops/index.rst | 1 -
Documentation/{ => admin-guide}/laptops/laptop-mode.rst | 0
Documentation/{ => admin-guide}/laptops/lg-laptop.rst | 1 -
Documentation/{ => admin-guide}/laptops/sony-laptop.rst | 0
Documentation/{ => admin-guide}/laptops/sonypi.rst | 0
Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst | 0
Documentation/{ => admin-guide}/laptops/toshiba_haps.rst | 0
Documentation/admin-guide/sysctl/vm.rst | 4 ++--
MAINTAINERS | 4 ++--
drivers/char/Kconfig | 2 +-
drivers/platform/x86/Kconfig | 4 ++--
17 files changed, 11 insertions(+), 12 deletions(-)
rename Documentation/{ => admin-guide}/laptops/asus-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/disk-shock-protection.rst (100%)
rename Documentation/{ => admin-guide}/laptops/index.rst (95%)
rename Documentation/{ => admin-guide}/laptops/laptop-mode.rst (100%)
rename Documentation/{ => admin-guide}/laptops/lg-laptop.rst (99%)
rename Documentation/{ => admin-guide}/laptops/sony-laptop.rst (100%)
rename Documentation/{ => admin-guide}/laptops/sonypi.rst (100%)
rename Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst (100%)
rename Documentation/{ => admin-guide}/laptops/toshiba_haps.rst (100%)
diff --git a/Documentation/ABI/testing/sysfs-block-device b/Documentation/ABI/testing/sysfs-block-device
index 0d57bbb4fddc..17f2bc7dd261 100644
--- a/Documentation/ABI/testing/sysfs-block-device
+++ b/Documentation/ABI/testing/sysfs-block-device
@@ -45,7 +45,7 @@ Description:
- Values below -2 are rejected with -EINVAL
For more information, see
- Documentation/laptops/disk-shock-protection.rst
+ Documentation/admin-guide/laptops/disk-shock-protection.rst
What: /sys/block/*/device/ncq_prio_enable
diff --git a/Documentation/ABI/testing/sysfs-platform-asus-laptop b/Documentation/ABI/testing/sysfs-platform-asus-laptop
index d67fa4bafa70..8b0e8205a6a2 100644
--- a/Documentation/ABI/testing/sysfs-platform-asus-laptop
+++ b/Documentation/ABI/testing/sysfs-platform-asus-laptop
@@ -31,7 +31,7 @@ Description:
To control the LED display, use the following :
echo 0x0T000DDD > /sys/devices/platform/asus_laptop/
where T control the 3 letters display, and DDD the 3 digits display.
- The DDD table can be found in Documentation/laptops/asus-laptop.rst
+ The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst
What: /sys/devices/platform/asus_laptop/bluetooth
Date: January 2007
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index acd0efa46e9d..9899b78dbe50 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -81,6 +81,7 @@ configure specific aspects of kernel behavior to your liking.
perf-security
acpi/index
device-mapper/index
+ laptops/index
.. only:: subproject and html
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index a3d3da5baacb..e38b96d061f4 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -4373,7 +4373,7 @@
Format: <integer>
sonypi.*= [HW] Sony Programmable I/O Control Device driver
- See Documentation/laptops/sonypi.rst
+ See Documentation/admin-guide/laptops/sonypi.rst
spectre_v2= [X86] Control mitigation of Spectre variant 2
(indirect branch speculation) vulnerability.
diff --git a/Documentation/laptops/asus-laptop.rst b/Documentation/admin-guide/laptops/asus-laptop.rst
similarity index 100%
rename from Documentation/laptops/asus-laptop.rst
rename to Documentation/admin-guide/laptops/asus-laptop.rst
diff --git a/Documentation/laptops/disk-shock-protection.rst b/Documentation/admin-guide/laptops/disk-shock-protection.rst
similarity index 100%
rename from Documentation/laptops/disk-shock-protection.rst
rename to Documentation/admin-guide/laptops/disk-shock-protection.rst
diff --git a/Documentation/laptops/index.rst b/Documentation/admin-guide/laptops/index.rst
similarity index 95%
rename from Documentation/laptops/index.rst
rename to Documentation/admin-guide/laptops/index.rst
index 001a30910d09..6b554e39863b 100644
--- a/Documentation/laptops/index.rst
+++ b/Documentation/admin-guide/laptops/index.rst
@@ -1,4 +1,3 @@
-:orphan:
==============
Laptop Drivers
diff --git a/Documentation/laptops/laptop-mode.rst b/Documentation/admin-guide/laptops/laptop-mode.rst
similarity index 100%
rename from Documentation/laptops/laptop-mode.rst
rename to Documentation/admin-guide/laptops/laptop-mode.rst
diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/admin-guide/laptops/lg-laptop.rst
similarity index 99%
rename from Documentation/laptops/lg-laptop.rst
rename to Documentation/admin-guide/laptops/lg-laptop.rst
index f2c2ffe31101..ce9b14671cb9 100644
--- a/Documentation/laptops/lg-laptop.rst
+++ b/Documentation/admin-guide/laptops/lg-laptop.rst
@@ -1,6 +1,5 @@
.. SPDX-License-Identifier: GPL-2.0+
-:orphan:
LG Gram laptop extra features
=============================
diff --git a/Documentation/laptops/sony-laptop.rst b/Documentation/admin-guide/laptops/sony-laptop.rst
similarity index 100%
rename from Documentation/laptops/sony-laptop.rst
rename to Documentation/admin-guide/laptops/sony-laptop.rst
diff --git a/Documentation/laptops/sonypi.rst b/Documentation/admin-guide/laptops/sonypi.rst
similarity index 100%
rename from Documentation/laptops/sonypi.rst
rename to Documentation/admin-guide/laptops/sonypi.rst
diff --git a/Documentation/laptops/thinkpad-acpi.rst b/Documentation/admin-guide/laptops/thinkpad-acpi.rst
similarity index 100%
rename from Documentation/laptops/thinkpad-acpi.rst
rename to Documentation/admin-guide/laptops/thinkpad-acpi.rst
diff --git a/Documentation/laptops/toshiba_haps.rst b/Documentation/admin-guide/laptops/toshiba_haps.rst
similarity index 100%
rename from Documentation/laptops/toshiba_haps.rst
rename to Documentation/admin-guide/laptops/toshiba_haps.rst
diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
index 5aceb5cd5ce7..64aeee1009ca 100644
--- a/Documentation/admin-guide/sysctl/vm.rst
+++ b/Documentation/admin-guide/sysctl/vm.rst
@@ -108,7 +108,7 @@ block_dump
==========
block_dump enables block I/O debugging when set to a nonzero value. More
-information on block I/O debugging is in Documentation/laptops/laptop-mode.rst.
+information on block I/O debugging is in Documentation/admin-guide/laptops/laptop-mode.rst.
compact_memory
@@ -298,7 +298,7 @@ laptop_mode
===========
laptop_mode is a knob that controls "laptop mode". All the things that are
-controlled by this knob are discussed in Documentation/laptops/laptop-mode.rst.
+controlled by this knob are discussed in Documentation/admin-guide/laptops/laptop-mode.rst.
legacy_va_layout
diff --git a/MAINTAINERS b/MAINTAINERS
index 40d057631004..d35ff73f718a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8978,7 +8978,7 @@ M: Matan Ziv-Av <matan@svgalib.org>
L: platform-driver-x86@vger.kernel.org
S: Maintained
F: Documentation/ABI/testing/sysfs-platform-lg-laptop
-F: Documentation/laptops/lg-laptop.rst
+F: Documentation/admin-guide/laptops/lg-laptop.rst
F: drivers/platform/x86/lg-laptop.c
LG2160 MEDIA DRIVER
@@ -14830,7 +14830,7 @@ M: Mattia Dongili <malattia@linux.it>
L: platform-driver-x86@vger.kernel.org
W: http://www.linux.it/~malattia/wiki/index.php/Sony_drivers
S: Maintained
-F: Documentation/laptops/sony-laptop.rst
+F: Documentation/admin-guide/laptops/sony-laptop.rst
F: drivers/char/sonypi.c
F: drivers/platform/x86/sony-laptop.c
F: include/linux/sony-laptop.h
diff --git a/drivers/char/Kconfig b/drivers/char/Kconfig
index bb734066075f..442403abd73a 100644
--- a/drivers/char/Kconfig
+++ b/drivers/char/Kconfig
@@ -382,7 +382,7 @@ config SONYPI
Device which can be found in many (all ?) Sony Vaio laptops.
If you have one of those laptops, read
- <file:Documentation/laptops/sonypi.rst>, and say Y or M here.
+ <file:Documentation/admin-guide/laptops/sonypi.rst>, and say Y or M here.
To compile this driver as a module, choose M here: the
module will be called sonypi.
diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
index 1f616844fb87..85101c678693 100644
--- a/drivers/platform/x86/Kconfig
+++ b/drivers/platform/x86/Kconfig
@@ -448,7 +448,7 @@ config SONY_LAPTOP
screen brightness control, Fn keys and allows powering on/off some
devices.
- Read <file:Documentation/laptops/sony-laptop.rst> for more information.
+ Read <file:Documentation/admin-guide/laptops/sony-laptop.rst> for more information.
config SONYPI_COMPAT
bool "Sonypi compatibility"
@@ -500,7 +500,7 @@ config THINKPAD_ACPI
support for Fn-Fx key combinations, Bluetooth control, video
output switching, ThinkLight control, UltraBay eject and more.
For more information about this driver see
- <file:Documentation/laptops/thinkpad-acpi.rst> and
+ <file:Documentation/admin-guide/laptops/thinkpad-acpi.rst> and
<http://ibm-acpi.sf.net/> .
This driver was formerly known as ibm-acpi.
--
2.21.0
^ permalink raw reply related
* [PATCH 30/39] docs: driver-api: add xilinx driver API documentation
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, Michal Simek, linux-arm-kernel
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The current file there (emmi) provides a description of
the driver uAPI and kAPI.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/xilinx/eemi.rst | 0
Documentation/{ => driver-api}/xilinx/index.rst | 1 -
3 files changed, 1 insertion(+), 1 deletion(-)
rename Documentation/{ => driver-api}/xilinx/eemi.rst (100%)
rename Documentation/{ => driver-api}/xilinx/index.rst (94%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index bba01cb95162..0bc5f2e3b98b 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -93,6 +93,7 @@ available subsections can be seen below.
sync_file
vfio-mediated-device
vfio
+ xilinx/index
xillybus
zorro
diff --git a/Documentation/xilinx/eemi.rst b/Documentation/driver-api/xilinx/eemi.rst
similarity index 100%
rename from Documentation/xilinx/eemi.rst
rename to Documentation/driver-api/xilinx/eemi.rst
diff --git a/Documentation/xilinx/index.rst b/Documentation/driver-api/xilinx/index.rst
similarity index 94%
rename from Documentation/xilinx/index.rst
rename to Documentation/driver-api/xilinx/index.rst
index 01cc1a0714df..13f7589ed442 100644
--- a/Documentation/xilinx/index.rst
+++ b/Documentation/driver-api/xilinx/index.rst
@@ -1,4 +1,3 @@
-:orphan:
===========
Xilinx FPGA
--
2.21.0
^ permalink raw reply related
* [PATCH 39/39] docs: gpio: add sysfs interface to the admin-guide
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, Linus Walleij, Bartosz Golaszewski,
Rafael J. Wysocki, Len Brown, Harry Wei, Alex Shi, linux-gpio,
linux-acpi
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
While this is stated as obsoleted, the sysfs interface described
there is still valid, and belongs to the admin-guide.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/ABI/obsolete/sysfs-gpio | 2 +-
Documentation/{ => admin-guide}/gpio/index.rst | 2 +-
Documentation/{ => admin-guide}/gpio/sysfs.rst | 0
Documentation/admin-guide/index.rst | 1 +
Documentation/firmware-guide/acpi/enumeration.rst | 2 +-
Documentation/translations/zh_CN/gpio.txt | 4 ++--
MAINTAINERS | 2 +-
7 files changed, 7 insertions(+), 6 deletions(-)
rename Documentation/{ => admin-guide}/gpio/index.rst (78%)
rename Documentation/{ => admin-guide}/gpio/sysfs.rst (100%)
diff --git a/Documentation/ABI/obsolete/sysfs-gpio b/Documentation/ABI/obsolete/sysfs-gpio
index 40d41ea1a3f5..e0d4e5e2dd90 100644
--- a/Documentation/ABI/obsolete/sysfs-gpio
+++ b/Documentation/ABI/obsolete/sysfs-gpio
@@ -11,7 +11,7 @@ Description:
Kernel code may export it for complete or partial access.
GPIOs are identified as they are inside the kernel, using integers in
- the range 0..INT_MAX. See Documentation/gpio for more information.
+ the range 0..INT_MAX. See Documentation/admin-guide/gpio for more information.
/sys/class/gpio
/export ... asks the kernel to export a GPIO to userspace
diff --git a/Documentation/gpio/index.rst b/Documentation/admin-guide/gpio/index.rst
similarity index 78%
rename from Documentation/gpio/index.rst
rename to Documentation/admin-guide/gpio/index.rst
index 09a4a553f434..a244ba4e87d5 100644
--- a/Documentation/gpio/index.rst
+++ b/Documentation/admin-guide/gpio/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
====
gpio
diff --git a/Documentation/gpio/sysfs.rst b/Documentation/admin-guide/gpio/sysfs.rst
similarity index 100%
rename from Documentation/gpio/sysfs.rst
rename to Documentation/admin-guide/gpio/sysfs.rst
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 2c20607e90cd..367097abec78 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -90,6 +90,7 @@ configure specific aspects of kernel behavior to your liking.
cputopology
device-mapper/index
efi-stub
+ gpio/index
highuid
hw_random
iostats
diff --git a/Documentation/firmware-guide/acpi/enumeration.rst b/Documentation/firmware-guide/acpi/enumeration.rst
index 1252617b520f..0a72b6321f5f 100644
--- a/Documentation/firmware-guide/acpi/enumeration.rst
+++ b/Documentation/firmware-guide/acpi/enumeration.rst
@@ -316,7 +316,7 @@ specifies the path to the controller. In order to use these GPIOs in Linux
we need to translate them to the corresponding Linux GPIO descriptors.
There is a standard GPIO API for that and is documented in
-Documentation/gpio/.
+Documentation/admin-guide/gpio/.
In the above example we can get the corresponding two GPIO descriptors with
a code like this::
diff --git a/Documentation/translations/zh_CN/gpio.txt b/Documentation/translations/zh_CN/gpio.txt
index 4cb1ba8b8fed..a23ee14fc927 100644
--- a/Documentation/translations/zh_CN/gpio.txt
+++ b/Documentation/translations/zh_CN/gpio.txt
@@ -1,4 +1,4 @@
-Chinese translated version of Documentation/gpio
+Chinese translated version of Documentation/admin-guide/gpio
If you have any comment or update to the content, please contact the
original document maintainer directly. However, if you have a problem
@@ -10,7 +10,7 @@ Maintainer: Grant Likely <grant.likely@secretlab.ca>
Linus Walleij <linus.walleij@linaro.org>
Chinese maintainer: Fu Wei <tekkamanninja@gmail.com>
---------------------------------------------------------------------
-Documentation/gpio 的中文翻译
+Documentation/admin-guide/gpio 的中文翻译
如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文
交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻
diff --git a/MAINTAINERS b/MAINTAINERS
index cda68bbd9d1c..a49698b3becd 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -6812,7 +6812,7 @@ T: git git://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-gpio.git
S: Maintained
F: Documentation/devicetree/bindings/gpio/
F: Documentation/driver-api/gpio/
-F: Documentation/gpio/
+F: Documentation/admin-guide/gpio/
F: Documentation/ABI/testing/gpio-cdev
F: Documentation/ABI/obsolete/sysfs-gpio
F: drivers/gpio/
--
2.21.0
^ permalink raw reply related
* [PATCH 36/39] docs: add SPDX tags to new index files
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, Philipp Reisner, Lars Ellenberg, Kukjin Kim,
Krzysztof Kozlowski, drbd-dev, linux-arm-kernel,
linux-samsung-soc
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
All those new files I added are under GPL v2.0 license.
Add the corresponding SPDX headers to them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/admin-guide/blockdev/drbd/figures.rst | 2 ++
Documentation/admin-guide/blockdev/index.rst | 2 ++
Documentation/admin-guide/laptops/index.rst | 1 +
Documentation/admin-guide/namespaces/index.rst | 2 ++
Documentation/admin-guide/perf/index.rst | 2 ++
Documentation/arm/index.rst | 2 ++
Documentation/arm/nwfpe/index.rst | 2 ++
Documentation/arm/omap/index.rst | 2 ++
Documentation/arm/sa1100/index.rst | 2 ++
Documentation/arm/samsung-s3c24xx/index.rst | 2 ++
Documentation/arm/samsung/index.rst | 2 ++
Documentation/driver-api/early-userspace/index.rst | 2 ++
Documentation/driver-api/md/index.rst | 2 ++
Documentation/driver-api/memory-devices/index.rst | 2 ++
Documentation/driver-api/mmc/index.rst | 2 ++
Documentation/driver-api/mtd/index.rst | 2 ++
Documentation/driver-api/nfc/index.rst | 2 ++
Documentation/driver-api/nvdimm/index.rst | 2 ++
Documentation/driver-api/phy/index.rst | 2 ++
Documentation/driver-api/rapidio/index.rst | 2 ++
Documentation/driver-api/thermal/index.rst | 2 ++
Documentation/ia64/index.rst | 2 ++
22 files changed, 43 insertions(+)
diff --git a/Documentation/admin-guide/blockdev/drbd/figures.rst b/Documentation/admin-guide/blockdev/drbd/figures.rst
index 3e3fd4b8a478..bd9a4901fe46 100644
--- a/Documentation/admin-guide/blockdev/drbd/figures.rst
+++ b/Documentation/admin-guide/blockdev/drbd/figures.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
.. The here included files are intended to help understand the implementation
Data flows that Relate some functions, and write packets
diff --git a/Documentation/admin-guide/blockdev/index.rst b/Documentation/admin-guide/blockdev/index.rst
index 20a738d9d047..b903cf152091 100644
--- a/Documentation/admin-guide/blockdev/index.rst
+++ b/Documentation/admin-guide/blockdev/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
===========================
The Linux RapidIO Subsystem
===========================
diff --git a/Documentation/admin-guide/laptops/index.rst b/Documentation/admin-guide/laptops/index.rst
index 6b554e39863b..cd9a1c2695fd 100644
--- a/Documentation/admin-guide/laptops/index.rst
+++ b/Documentation/admin-guide/laptops/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: GPL-2.0
==============
Laptop Drivers
diff --git a/Documentation/admin-guide/namespaces/index.rst b/Documentation/admin-guide/namespaces/index.rst
index 713ec4949fa7..384f2e0f33d2 100644
--- a/Documentation/admin-guide/namespaces/index.rst
+++ b/Documentation/admin-guide/namespaces/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
==========
Namespaces
==========
diff --git a/Documentation/admin-guide/perf/index.rst b/Documentation/admin-guide/perf/index.rst
index 9d445451ea18..ee4bfd2a740f 100644
--- a/Documentation/admin-guide/perf/index.rst
+++ b/Documentation/admin-guide/perf/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
===========================
Performance monitor support
===========================
diff --git a/Documentation/arm/index.rst b/Documentation/arm/index.rst
index 9c2f781f4685..5fc072dd0c5e 100644
--- a/Documentation/arm/index.rst
+++ b/Documentation/arm/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
================
ARM Architecture
================
diff --git a/Documentation/arm/nwfpe/index.rst b/Documentation/arm/nwfpe/index.rst
index 21fa8ce192ae..3c4d2f9aa10e 100644
--- a/Documentation/arm/nwfpe/index.rst
+++ b/Documentation/arm/nwfpe/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
===================================
NetWinder's floating point emulator
===================================
diff --git a/Documentation/arm/omap/index.rst b/Documentation/arm/omap/index.rst
index f1e9c11d9f9b..8b365b212e49 100644
--- a/Documentation/arm/omap/index.rst
+++ b/Documentation/arm/omap/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
=======
TI OMAP
=======
diff --git a/Documentation/arm/sa1100/index.rst b/Documentation/arm/sa1100/index.rst
index fb2385b3accf..68c2a280a745 100644
--- a/Documentation/arm/sa1100/index.rst
+++ b/Documentation/arm/sa1100/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
====================
Intel StrongARM 1100
====================
diff --git a/Documentation/arm/samsung-s3c24xx/index.rst b/Documentation/arm/samsung-s3c24xx/index.rst
index 6c7b241cbf37..5b8a7f9398d8 100644
--- a/Documentation/arm/samsung-s3c24xx/index.rst
+++ b/Documentation/arm/samsung-s3c24xx/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
==========================
Samsung S3C24XX SoC Family
==========================
diff --git a/Documentation/arm/samsung/index.rst b/Documentation/arm/samsung/index.rst
index f54d95734362..8142cce3d23e 100644
--- a/Documentation/arm/samsung/index.rst
+++ b/Documentation/arm/samsung/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
===========
Samsung SoC
===========
diff --git a/Documentation/driver-api/early-userspace/index.rst b/Documentation/driver-api/early-userspace/index.rst
index 6f20c3c560d8..149c1822f06d 100644
--- a/Documentation/driver-api/early-userspace/index.rst
+++ b/Documentation/driver-api/early-userspace/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
===============
Early Userspace
===============
diff --git a/Documentation/driver-api/md/index.rst b/Documentation/driver-api/md/index.rst
index 205080891a1a..18f54a7d7d6e 100644
--- a/Documentation/driver-api/md/index.rst
+++ b/Documentation/driver-api/md/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
====
RAID
====
diff --git a/Documentation/driver-api/memory-devices/index.rst b/Documentation/driver-api/memory-devices/index.rst
index 87549828f6ab..28101458cda5 100644
--- a/Documentation/driver-api/memory-devices/index.rst
+++ b/Documentation/driver-api/memory-devices/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
=========================
Memory Controller drivers
=========================
diff --git a/Documentation/driver-api/mmc/index.rst b/Documentation/driver-api/mmc/index.rst
index 9aaf64951a8c..7339736ac774 100644
--- a/Documentation/driver-api/mmc/index.rst
+++ b/Documentation/driver-api/mmc/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
========================
MMC/SD/SDIO card support
========================
diff --git a/Documentation/driver-api/mtd/index.rst b/Documentation/driver-api/mtd/index.rst
index 2e0e7cc4055e..436ba5a851d7 100644
--- a/Documentation/driver-api/mtd/index.rst
+++ b/Documentation/driver-api/mtd/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
==============================
Memory Technology Device (MTD)
==============================
diff --git a/Documentation/driver-api/nfc/index.rst b/Documentation/driver-api/nfc/index.rst
index 3afb2c0c2e3c..b6e9eedbff29 100644
--- a/Documentation/driver-api/nfc/index.rst
+++ b/Documentation/driver-api/nfc/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
========================
Near Field Communication
========================
diff --git a/Documentation/driver-api/nvdimm/index.rst b/Documentation/driver-api/nvdimm/index.rst
index 19dc8ee371dc..a4f8f98aeb94 100644
--- a/Documentation/driver-api/nvdimm/index.rst
+++ b/Documentation/driver-api/nvdimm/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
===================================
Non-Volatile Memory Device (NVDIMM)
===================================
diff --git a/Documentation/driver-api/phy/index.rst b/Documentation/driver-api/phy/index.rst
index fce9ffae2812..69ba1216de72 100644
--- a/Documentation/driver-api/phy/index.rst
+++ b/Documentation/driver-api/phy/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
=====================
Generic PHY Framework
=====================
diff --git a/Documentation/driver-api/rapidio/index.rst b/Documentation/driver-api/rapidio/index.rst
index 4c5e51a05134..a41b4242d16f 100644
--- a/Documentation/driver-api/rapidio/index.rst
+++ b/Documentation/driver-api/rapidio/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
===========================
The Linux RapidIO Subsystem
===========================
diff --git a/Documentation/driver-api/thermal/index.rst b/Documentation/driver-api/thermal/index.rst
index 68ceb6886561..5ba61d19c6ae 100644
--- a/Documentation/driver-api/thermal/index.rst
+++ b/Documentation/driver-api/thermal/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
=======
Thermal
=======
diff --git a/Documentation/ia64/index.rst b/Documentation/ia64/index.rst
index ef99475f672b..0436e1034115 100644
--- a/Documentation/ia64/index.rst
+++ b/Documentation/ia64/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
==================
IA-64 Architecture
==================
--
2.21.0
^ permalink raw reply related
page: next (older) | prev (newer) | latest
- recent:[subjects (threaded)|topics (new)|topics (active)]
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox