docs: move remaining stuff under Documentation/*.txt to Documentation/staging

There are several files that I was unable to find a proper place
for them, and 3 ones that are still in plain old text format.

Let's place those stuff behind the carpet, as we'd like to keep the
root directory clean.

We can later discuss and move those into better places.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/11bd0d75e65a874f7c276a0aeab0fe13f3376f5f.1592203650.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 71eca31715741f561818b99c63f9f7d9f0381872..3b491af0122de7a66331525bcf13e6164da85885 100644 (file)
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -182,6 +182,19 @@ subprojects.
 
    filesystems/ext4/index
 
+Other documentation
+-------------------
+
+There are several unsorted documents that don't seem to fit on other parts
+of the documentation body, or may require some adjustments and/or conversion
+to ReStructured Text format, or are simply too old.
+
+.. toctree::
+   :maxdepth: 2
+
+   staging/index
+
+
 Translations
 ------------
 

diff --git a/Documentation/crc32.txt b/Documentation/staging/crc32.rst
similarity index 100%
rename from Documentation/crc32.txt
rename to Documentation/staging/crc32.rst

diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
new file mode 100644 (file)
index 0000000..8e98517
--- /dev/null
+++ b/Documentation/staging/index.rst
@@ -0,0 +1,32 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Unsorted Documentation
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   crc32
+   kprobes
+   lzo
+   remoteproc
+   rpmsg
+   speculation
+   static-keys
+   tee
+   xz
+
+Atomic Types
+============
+
+.. literalinclude:: ../atomic_t.txt
+
+Atomic bitops
+=============
+
+.. literalinclude:: ../atomic_bitops.txt
+
+Memory Barriers
+===============
+
+.. literalinclude:: ../memory-barriers.txt

diff --git a/Documentation/kprobes.txt b/Documentation/staging/kprobes.rst
similarity index 100%
rename from Documentation/kprobes.txt
rename to Documentation/staging/kprobes.rst

diff --git a/Documentation/lzo.txt b/Documentation/staging/lzo.rst
similarity index 100%
rename from Documentation/lzo.txt
rename to Documentation/staging/lzo.rst

diff --git a/Documentation/remoteproc.txt b/Documentation/staging/remoteproc.rst
similarity index 99%
rename from Documentation/remoteproc.txt
rename to Documentation/staging/remoteproc.rst
index 2be1147256e0a8b0a9021fde8a7d1b96d1d31296..9cccd3dd6a4b40a3d00b6abbe884fce65e6de530 100644 (file)
--- a/Documentation/remoteproc.txt
+++ b/Documentation/staging/remoteproc.rst
@@ -22,7 +22,7 @@ for remote processors that supports this kind of communication. This way,
 platform-specific remoteproc drivers only need to provide a few low-level
 handlers, and then all rpmsg drivers will then just work
 (for more information about the virtio-based rpmsg bus and its drivers,
-please read Documentation/rpmsg.txt).
+please read Documentation/staging/rpmsg.rst).
 Registration of other types of virtio devices is now also possible. Firmwares
 just need to publish what kind of virtio devices do they support, and then
 remoteproc will add those devices. This makes it possible to reuse the

diff --git a/Documentation/rpmsg.txt b/Documentation/staging/rpmsg.rst
similarity index 100%
rename from Documentation/rpmsg.txt
rename to Documentation/staging/rpmsg.rst

diff --git a/Documentation/speculation.txt b/Documentation/staging/speculation.rst
similarity index 97%
rename from Documentation/speculation.txt
rename to Documentation/staging/speculation.rst
index 50d7ea857cff2102d3e58cc53c26dc309ad169d9..8045d99bcf12747ef5e765b04f577a1976a9effe 100644 (file)
--- a/Documentation/speculation.txt
+++ b/Documentation/staging/speculation.rst
@@ -1,10 +1,12 @@
-This document explains potential effects of speculation, and how undesirable
-effects can be mitigated portably using common APIs.
-
 ===========
 Speculation
 ===========
 
+This document explains potential effects of speculation, and how undesirable
+effects can be mitigated portably using common APIs.
+
+------------------------------------------------------------------------------
+
 To improve performance and minimize average latencies, many contemporary CPUs
 employ speculative execution techniques such as branch prediction, performing
 work which may be discarded at a later stage.

diff --git a/Documentation/static-keys.txt b/Documentation/staging/static-keys.rst
similarity index 100%
rename from Documentation/static-keys.txt
rename to Documentation/staging/static-keys.rst

diff --git a/Documentation/tee.txt b/Documentation/staging/tee.rst
similarity index 99%
rename from Documentation/tee.txt
rename to Documentation/staging/tee.rst
index 350dd40cba457e9590fa7b15d8e8d06113c402c2..62e8ba64d04f9099596eb8e2bec66631cab0ffa9 100644 (file)
--- a/Documentation/tee.txt
+++ b/Documentation/staging/tee.rst
@@ -230,6 +230,7 @@ The AMD-TEE driver packages the command buffer payload for processing in TEE.
 The command buffer format for the different TEE commands can be found in [7].
 
 The TEE commands supported by AMD-TEE Trusted OS are:
+
 * TEE_CMD_ID_LOAD_TA          - loads a Trusted Application (TA) binary into
                                 TEE environment.
 * TEE_CMD_ID_UNLOAD_TA        - unloads TA binary from TEE environment.

diff --git a/Documentation/xz.txt b/Documentation/staging/xz.rst
similarity index 100%
rename from Documentation/xz.txt
rename to Documentation/staging/xz.rst

diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
index cc4c5fc313df304b48f425490c9a231e44af2688..c1709165c55353f2affa37848eb5947b9c092757 100644 (file)
--- a/Documentation/trace/kprobetrace.rst
+++ b/Documentation/trace/kprobetrace.rst
@@ -40,7 +40,7 @@ Synopsis of kprobe_events
  MEMADDR       : Address where the probe is inserted.
  MAXACTIVE     : Maximum number of instances of the specified function that
                  can be probed simultaneously, or 0 for the default value
-                 as defined in Documentation/kprobes.txt section 1.3.1.
+                 as defined in Documentation/staging/kprobes.rst section 1.3.1.
 
  FETCHARGS     : Arguments. Each probe can have up to 128 args.
   %REG         : Fetch register REG

diff --git a/MAINTAINERS b/MAINTAINERS
index f66fc236a325dc55705b7c9c07fcb3eb7b4726ad..ad90b399288784dfa3a973e0de7d25e94827fb29 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9597,7 +9597,7 @@ M:        Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
 M:     "David S. Miller" <davem@davemloft.net>
 M:     Masami Hiramatsu <mhiramat@kernel.org>
 S:     Maintained
-F:     Documentation/kprobes.txt
+F:     Documentation/staging/kprobes.rst
 F:     include/asm-generic/kprobes.h
 F:     include/linux/kprobes.h
 F:     kernel/kprobes.c
@@ -14500,7 +14500,7 @@ S:      Maintained
 T:     git git://git.kernel.org/pub/scm/linux/kernel/git/andersson/remoteproc.git rproc-next
 F:     Documentation/ABI/testing/sysfs-class-remoteproc
 F:     Documentation/devicetree/bindings/remoteproc/
-F:     Documentation/remoteproc.txt
+F:     Documentation/staging/remoteproc.rst
 F:     drivers/remoteproc/
 F:     include/linux/remoteproc.h
 F:     include/linux/remoteproc/
@@ -14512,7 +14512,7 @@ L:      linux-remoteproc@vger.kernel.org
 S:     Maintained
 T:     git git://git.kernel.org/pub/scm/linux/kernel/git/andersson/remoteproc.git rpmsg-next
 F:     Documentation/ABI/testing/sysfs-bus-rpmsg
-F:     Documentation/rpmsg.txt
+F:     Documentation/staging/rpmsg.rst
 F:     drivers/rpmsg/
 F:     include/linux/rpmsg.h
 F:     include/linux/rpmsg/
@@ -16761,7 +16761,7 @@ TEE SUBSYSTEM
 M:     Jens Wiklander <jens.wiklander@linaro.org>
 L:     tee-dev@lists.linaro.org
 S:     Maintained
-F:     Documentation/tee.txt
+F:     Documentation/staging/tee.rst
 F:     drivers/tee/
 F:     include/linux/tee_drv.h
 F:     include/uapi/linux/tee.h

diff --git a/include/linux/jump_label.h b/include/linux/jump_label.h
index 3526c0aee9544293172ccef2bd99746b6641f06a..32809624d422e1985860cba6a0e2faaf23dda41d 100644 (file)
--- a/include/linux/jump_label.h
+++ b/include/linux/jump_label.h
@@ -68,7 +68,7 @@
  * Lacking toolchain and or architecture support, static keys fall back to a
  * simple conditional branch.
  *
- * Additional babbling in: Documentation/static-keys.txt
+ * Additional babbling in: Documentation/staging/static-keys.rst
  */
 
 #ifndef __ASSEMBLY__

diff --git a/lib/crc32.c b/lib/crc32.c
index 4a20455d1f61e36afabf8befadb15dfc0f42a3a2..35a03d03f97381d5bdf6c74d1d2c5f66190ec29d 100644 (file)
--- a/lib/crc32.c
+++ b/lib/crc32.c
@@ -24,7 +24,7 @@
  * Version 2.  See the file COPYING for more details.
  */
 
-/* see: Documentation/crc32.txt for a description of algorithms */
+/* see: Documentation/staging/crc32.rst for a description of algorithms */
 
 #include <linux/crc32.h>
 #include <linux/crc32poly.h>

diff --git a/lib/lzo/lzo1x_decompress_safe.c b/lib/lzo/lzo1x_decompress_safe.c
index 2717c7963acdfac60af1342df43b7040b99fce1f..7892a40cf765b980038d139ca8fb707e48f25409 100644 (file)
--- a/lib/lzo/lzo1x_decompress_safe.c
+++ b/lib/lzo/lzo1x_decompress_safe.c
@@ -32,7 +32,7 @@
  * depending on the base count. Since the base count is taken from a u8
  * and a few bits, it is safe to assume that it will always be lower than
  * or equal to 2*255, thus we can always prevent any overflow by accepting
- * two less 255 steps. See Documentation/lzo.txt for more information.
+ * two less 255 steps. See Documentation/staging/lzo.rst for more information.
  */
 #define MAX_255_COUNT      ((((size_t)~0) / 255) - 2)
 

diff --git a/lib/xz/Kconfig b/lib/xz/Kconfig
index 22528743d4cecf6a536dcaaa5a9727d61e3340a4..5cb50245a878cde27e9f972cb6c89110a0c109ef 100644 (file)
--- a/lib/xz/Kconfig
+++ b/lib/xz/Kconfig
@@ -5,7 +5,7 @@ config XZ_DEC
        help
          LZMA2 compression algorithm and BCJ filters are supported using
          the .xz file format as the container. For integrity checking,
-         CRC32 is supported. See Documentation/xz.txt for more information.
+         CRC32 is supported. See Documentation/staging/xz.rst for more information.
 
 if XZ_DEC
 

diff --git a/samples/kprobes/kprobe_example.c b/samples/kprobes/kprobe_example.c
index 501911d1b32789ccf2275941bbcb98c1ff790267..240f2435ce6f78e92714f9d4387ba02368f3da98 100644 (file)
--- a/samples/kprobes/kprobe_example.c
+++ b/samples/kprobes/kprobe_example.c
@@ -5,7 +5,7 @@
  * stack trace and selected registers when _do_fork() is called.
  *
  * For more information on theory of operation of kprobes, see
- * Documentation/kprobes.txt
+ * Documentation/staging/kprobes.rst
  *
  * You will see the trace data in /var/log/messages and on the console
  * whenever _do_fork() is invoked to create a new process.

diff --git a/samples/kprobes/kretprobe_example.c b/samples/kprobes/kretprobe_example.c
index 013e8e6ebae9a56010b99230bfe6b626960519dd..78a2da6fb3cd2480dadaface53fea640a4b88d99 100644 (file)
--- a/samples/kprobes/kretprobe_example.c
+++ b/samples/kprobes/kretprobe_example.c
@@ -11,7 +11,7 @@
  * If no func_name is specified, _do_fork is instrumented
  *
  * For more information on theory of operation of kretprobes, see
- * Documentation/kprobes.txt
+ * Documentation/staging/kprobes.rst
  *
  * Build and insert the kernel module as done in the kprobe example.
  * You will see the trace data in /var/log/messages and on the console