linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Alexey Dobriyan <adobriyan@gmail.com>,
	"David S. Miller" <davem@davemloft.net>,
	linux-fsdevel@vger.kernel.org, netdev@vger.kernel.org,
	linux-mm@kvack.org
Subject: [PATCH 16/39] docs: admin-guide: move sysctl directory to it
Date: Fri, 28 Jun 2019 09:30:09 -0300	[thread overview]
Message-ID: <22023257e9679c18eb6a25052e4c233a12e687da.1561724493.git.mchehab+samsung@kernel.org> (raw)
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


  parent reply	other threads:[~2019-06-28 12:33 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-28 12:29 [PATCH 00/39] Don't let ReST documents orphaned Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 01/39] docs: thermal: add it to the driver API Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 02/39] docs: rapidio: " Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 03/39] docs: perf: move to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 04/39] docs: nvdimm: add it to the driver-api book Mauro Carvalho Chehab
2019-06-28 16:33   ` Dan Williams
2019-06-28 12:29 ` [PATCH 05/39] docs: namespace: move it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 06/39] docs: mtd: move it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 07/39] docs: nfc: add " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 08/39] docs: mmc: move it to the driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 09/39] docs: md: move it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 10/39] docs: leds: add " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 11/39] docs: ioctl: add it to the uAPI guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 12/39] docs: interconnect.rst: add it to the driver-api guide Mauro Carvalho Chehab
2019-06-28 13:55   ` Georgi Djakov
2019-06-28 12:30 ` [PATCH 13/39] docs: add arch doc directories to the index Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 14/39] docs: device-mapper: move it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 15/39] docs: early-userspace: move to driver-api guide Mauro Carvalho Chehab
2019-06-28 12:30 ` Mauro Carvalho Chehab [this message]
2019-06-28 12:30 ` [PATCH 17/39] docs: admin-guide: add laptops documentation Mauro Carvalho Chehab
2019-06-28 14:51   ` Andy Shevchenko
2019-06-28 12:30 ` [PATCH 18/39] docs: admin-guide: add kdump documentation into it Mauro Carvalho Chehab
2019-07-05  3:43   ` Alex Shi
2019-07-05  5:59     ` Dave Young
2019-07-06 11:46       ` Mauro Carvalho Chehab
2019-07-05  5:55   ` Dave Young
2019-06-28 12:30 ` [PATCH 19/39] docs: blockdev: add it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 20/39] docs: security: move some books to it and update Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 21/39] docs: x86: move two x86-specific files to x86 arch dir Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 22/39] docs: ocxl.rst: add it to the uAPI book Mauro Carvalho Chehab
2019-07-01  1:21   ` Andrew Donnellan
2019-06-28 12:30 ` [PATCH 23/39] docs: lp855x-driver.rst: add it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 24/39] docs: driver-model: move " Mauro Carvalho Chehab
2019-06-28 18:53   ` Jeff Kirsher
2019-06-28 12:30 ` [PATCH 25/39] docs: add some documentation dirs " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 26/39] docs: aoe: add it " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 27/39] docs: cgroup-v1: add it to the admin-guide book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Mauro Carvalho Chehab
2019-06-28 12:43   ` Alexandre Belloni
2019-06-28 12:54   ` Bartlomiej Zolnierkiewicz
2019-06-28 12:30 ` [PATCH 30/39] docs: driver-api: add xilinx driver API documentation Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 31/39] docs: driver-api: add remaining converted dirs to it Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 32/39] docs: serial: move it to the driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 33/39] docs: phy: place documentation under driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 34/39] docs: add a memory-devices subdir to driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 35/39] docs: infiniband: add it to the driver-api bookset Mauro Carvalho Chehab
2019-07-03 18:08   ` Jason Gunthorpe
2019-07-06 11:19     ` Mauro Carvalho Chehab
2019-07-08 17:25       ` Jason Gunthorpe
2019-06-28 12:30 ` [PATCH 36/39] docs: add SPDX tags to new index files Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 37/39] docs: adds some directories to the main documentation index Mauro Carvalho Chehab
2019-06-28 12:55   ` Bartlomiej Zolnierkiewicz
2019-06-28 12:30 ` [PATCH 38/39] docs: locking: add it to the main index Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 39/39] docs: gpio: add sysfs interface to the admin-guide Mauro Carvalho Chehab
2019-07-03  8:44   ` Linus Walleij
2019-07-06 11:43     ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=22023257e9679c18eb6a25052e4c233a12e687da.1561724493.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=adobriyan@gmail.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=mchehab@infradead.org \
    --cc=netdev@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).