[PATCH 10/14] docs: move locking-specific documenta to locking/ directory

Mauro Carvalho Chehab
2020-05-01T15:38:13Z

Several files under Documentation/*.txt describe some type of
locking API. Move them to locking/ subdir and add to the
locking/index.rst index file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../{futex-requeue-pi.txt => locking/futex-requeue-pi.rst} | 0
Documentation/{hwspinlock.txt => locking/hwspinlock.rst} | 0
Documentation/locking/index.rst | 7 +++++++
.../percpu-rw-semaphore.rst} | 0
Documentation/{pi-futex.txt => locking/pi-futex.rst} | 0
.../{preempt-locking.txt => locking/preempt-locking.rst} | 0
.../{robust-futex-ABI.txt => locking/robust-futex-ABI.rst} | 0
.../{robust-futexes.txt => locking/robust-futexes.rst} | 0
Documentation/locking/rt-mutex.rst | 2 +-
MAINTAINERS | 6 +++---
10 files changed, 11 insertions(+), 4 deletions(-)
rename Documentation/{futex-requeue-pi.txt => locking/futex-requeue-pi.rst} (100%)
rename Documentation/{hwspinlock.txt => locking/hwspinlock.rst} (100%)
rename Documentation/{percpu-rw-semaphore.txt => locking/percpu-rw-semaphore.rst} (100%)
rename Documentation/{pi-futex.txt => locking/pi-futex.rst} (100%)
rename Documentation/{preempt-locking.txt => locking/preempt-locking.rst} (100%)
rename Documentation/{robust-futex-ABI.txt => locking/robust-futex-ABI.rst} (100%)
rename Documentation/{robust-futexes.txt => locking/robust-futexes.rst} (100%)

diff --git a/Documentation/futex-requeue-pi.txt b/Documentation/locking/futex-requeue-pi.rst
similarity index 100%
rename from Documentation/futex-requeue-pi.txt
rename to Documentation/locking/futex-requeue-pi.rst
diff --git a/Documentation/hwspinlock.txt b/Documentation/locking/hwspinlock.rst
similarity index 100%
rename from Documentation/hwspinlock.txt
rename to Documentation/locking/hwspinlock.rst
diff --git a/Documentation/locking/index.rst b/Documentation/locking/index.rst
index 5d6800a723dc..d785878cad65 100644
--- a/Documentation/locking/index.rst
+++ b/Documentation/locking/index.rst
@@ -16,6 +16,13 @@ locking
rt-mutex
spinlocks
ww-mutex-design
+ preempt-locking
+ pi-futex
+ futex-requeue-pi
+ hwspinlock
+ percpu-rw-semaphore
+ robust-futexes
+ robust-futex-ABI

.. only:: subproject and html

diff --git a/Documentation/percpu-rw-semaphore.txt b/Documentation/locking/percpu-rw-semaphore.rst
similarity index 100%
rename from Documentation/percpu-rw-semaphore.txt
rename to Documentation/locking/percpu-rw-semaphore.rst
diff --git a/Documentation/pi-futex.txt b/Documentation/locking/pi-futex.rst
similarity index 100%
rename from Documentation/pi-futex.txt
rename to Documentation/locking/pi-futex.rst
diff --git a/Documentation/preempt-locking.txt b/Documentation/locking/preempt-locking.rst
similarity index 100%
rename from Documentation/preempt-locking.txt
rename to Documentation/locking/preempt-locking.rst
diff --git a/Documentation/robust-futex-ABI.txt b/Documentation/locking/robust-futex-ABI.rst
similarity index 100%
rename from Documentation/robust-futex-ABI.txt
rename to Documentation/locking/robust-futex-ABI.rst
diff --git a/Documentation/robust-futexes.txt b/Documentation/locking/robust-futexes.rst
similarity index 100%
rename from Documentation/robust-futexes.txt
rename to Documentation/locking/robust-futexes.rst
diff --git a/Documentation/locking/rt-mutex.rst b/Documentation/locking/rt-mutex.rst
index c365dc302081..3b5097a380e6 100644
--- a/Documentation/locking/rt-mutex.rst
+++ b/Documentation/locking/rt-mutex.rst
@@ -4,7 +4,7 @@ RT-mutex subsystem with PI support

RT-mutexes with priority inheritance are used to support PI-futexes,
which enable pthread_mutex_t priority inheritance attributes
-(PTHREAD_PRIO_INHERIT). [See Documentation/pi-futex.txt for more details
+(PTHREAD_PRIO_INHERIT). [See Documentation/locking/pi-futex.rst for more details
about PI-futexes.]

This technology was developed in the -rt tree and streamlined for
diff --git a/MAINTAINERS b/MAINTAINERS
index 6eb3d85a646f..1aa6e89e7424 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7042,13 +7042,13 @@ R: Darren Hart <dvhart@infradead.org>
L: linux-kernel@vger.kernel.org
S: Maintained
T: git git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git locking/core
-F: Documentation/*futex*
+F: Documentation/locking/*futex*
F: include/asm-generic/futex.h
F: include/linux/futex.h
F: include/uapi/linux/futex.h
F: kernel/futex.c
F: tools/perf/bench/futex*
-F: tools/testing/selftests/futex/
+F: Documentation/locking/*futex*

GASKET DRIVER FRAMEWORK
M: Rob Springer <rspringer@google.com>
@@ -7519,7 +7519,7 @@ L: linux-remoteproc@vger.kernel.org
S: Maintained
T: git git://git.kernel.org/pub/scm/linux/kernel/git/andersson/remoteproc.git hwspinlock-next
F: Documentation/devicetree/bindings/hwlock/
-F: Documentation/hwspinlock.txt
+F: Documentation/locking/hwspinlock.rst
F: drivers/hwspinlock/
F: include/linux/hwspinlock.h

--
2.25.4