Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
8e2a46a4 781885fd

+63 -15
Documentation/crc32.txt Documentation/staging/crc32.rst
+13
Documentation/index.rst
··· 182 182 183 183 filesystems/ext4/index 184 184 185 + Other documentation 186 + ------------------- 187 + 188 + There are several unsorted documents that don't seem to fit on other parts 189 + of the documentation body, or may require some adjustments and/or conversion 190 + to ReStructured Text format, or are simply too old. 191 + 192 + .. toctree:: 193 + :maxdepth: 2 194 + 195 + staging/index 196 + 197 + 185 198 Translations 186 199 ------------ 187 200
Documentation/kprobes.txt Documentation/staging/kprobes.rst
Documentation/lzo.txt Documentation/staging/lzo.rst
+1 -1
Documentation/remoteproc.txt Documentation/staging/remoteproc.rst
··· 22 22 platform-specific remoteproc drivers only need to provide a few low-level 23 23 handlers, and then all rpmsg drivers will then just work 24 24 (for more information about the virtio-based rpmsg bus and its drivers, 25 - please read Documentation/rpmsg.txt). 25 + please read Documentation/staging/rpmsg.rst). 26 26 Registration of other types of virtio devices is now also possible. Firmwares 27 27 just need to publish what kind of virtio devices do they support, and then 28 28 remoteproc will add those devices. This makes it possible to reuse the
Documentation/rpmsg.txt Documentation/staging/rpmsg.rst
+5 -3
Documentation/speculation.txt Documentation/staging/speculation.rst
··· 1 - This document explains potential effects of speculation, and how undesirable 2 - effects can be mitigated portably using common APIs. 3 - 4 1 =========== 5 2 Speculation 6 3 =========== 4 + 5 + This document explains potential effects of speculation, and how undesirable 6 + effects can be mitigated portably using common APIs. 7 + 8 + ------------------------------------------------------------------------------ 7 9 8 10 To improve performance and minimize average latencies, many contemporary CPUs 9 11 employ speculative execution techniques such as branch prediction, performing
+32
Documentation/staging/index.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + Unsorted Documentation 4 + ====================== 5 + 6 + .. toctree:: 7 + :maxdepth: 2 8 + 9 + crc32 10 + kprobes 11 + lzo 12 + remoteproc 13 + rpmsg 14 + speculation 15 + static-keys 16 + tee 17 + xz 18 + 19 + Atomic Types 20 + ============ 21 + 22 + .. literalinclude:: ../atomic_t.txt 23 + 24 + Atomic bitops 25 + ============= 26 + 27 + .. literalinclude:: ../atomic_bitops.txt 28 + 29 + Memory Barriers 30 + =============== 31 + 32 + .. literalinclude:: ../memory-barriers.txt
Documentation/static-keys.txt Documentation/staging/static-keys.rst
+1
Documentation/tee.txt Documentation/staging/tee.rst
··· 230 230 The command buffer format for the different TEE commands can be found in [7]. 231 231 232 232 The TEE commands supported by AMD-TEE Trusted OS are: 233 + 233 234 * TEE_CMD_ID_LOAD_TA - loads a Trusted Application (TA) binary into 234 235 TEE environment. 235 236 * TEE_CMD_ID_UNLOAD_TA - unloads TA binary from TEE environment.
+1 -1
Documentation/trace/kprobetrace.rst
··· 40 40 MEMADDR : Address where the probe is inserted. 41 41 MAXACTIVE : Maximum number of instances of the specified function that 42 42 can be probed simultaneously, or 0 for the default value 43 - as defined in Documentation/kprobes.txt section 1.3.1. 43 + as defined in Documentation/staging/kprobes.rst section 1.3.1. 44 44 45 45 FETCHARGS : Arguments. Each probe can have up to 128 args. 46 46 %REG : Fetch register REG
Documentation/xz.txt Documentation/staging/xz.rst
+4 -4
MAINTAINERS
··· 9597 9597 M: "David S. Miller" <davem@davemloft.net> 9598 9598 M: Masami Hiramatsu <mhiramat@kernel.org> 9599 9599 S: Maintained 9600 - F: Documentation/kprobes.txt 9600 + F: Documentation/staging/kprobes.rst 9601 9601 F: include/asm-generic/kprobes.h 9602 9602 F: include/linux/kprobes.h 9603 9603 F: kernel/kprobes.c ··· 14500 14500 T: git git://git.kernel.org/pub/scm/linux/kernel/git/andersson/remoteproc.git rproc-next 14501 14501 F: Documentation/ABI/testing/sysfs-class-remoteproc 14502 14502 F: Documentation/devicetree/bindings/remoteproc/ 14503 - F: Documentation/remoteproc.txt 14503 + F: Documentation/staging/remoteproc.rst 14504 14504 F: drivers/remoteproc/ 14505 14505 F: include/linux/remoteproc.h 14506 14506 F: include/linux/remoteproc/ ··· 14512 14512 S: Maintained 14513 14513 T: git git://git.kernel.org/pub/scm/linux/kernel/git/andersson/remoteproc.git rpmsg-next 14514 14514 F: Documentation/ABI/testing/sysfs-bus-rpmsg 14515 - F: Documentation/rpmsg.txt 14515 + F: Documentation/staging/rpmsg.rst 14516 14516 F: drivers/rpmsg/ 14517 14517 F: include/linux/rpmsg.h 14518 14518 F: include/linux/rpmsg/ ··· 16761 16761 M: Jens Wiklander <jens.wiklander@linaro.org> 16762 16762 L: tee-dev@lists.linaro.org 16763 16763 S: Maintained 16764 - F: Documentation/tee.txt 16764 + F: Documentation/staging/tee.rst 16765 16765 F: drivers/tee/ 16766 16766 F: include/linux/tee_drv.h 16767 16767 F: include/uapi/linux/tee.h
+1 -1
include/linux/jump_label.h
··· 68 68 * Lacking toolchain and or architecture support, static keys fall back to a 69 69 * simple conditional branch. 70 70 * 71 - * Additional babbling in: Documentation/static-keys.txt 71 + * Additional babbling in: Documentation/staging/static-keys.rst 72 72 */ 73 73 74 74 #ifndef __ASSEMBLY__
+1 -1
lib/crc32.c
··· 24 24 * Version 2. See the file COPYING for more details. 25 25 */ 26 26 27 - /* see: Documentation/crc32.txt for a description of algorithms */ 27 + /* see: Documentation/staging/crc32.rst for a description of algorithms */ 28 28 29 29 #include <linux/crc32.h> 30 30 #include <linux/crc32poly.h>
+1 -1
lib/lzo/lzo1x_decompress_safe.c
··· 32 32 * depending on the base count. Since the base count is taken from a u8 33 33 * and a few bits, it is safe to assume that it will always be lower than 34 34 * or equal to 2*255, thus we can always prevent any overflow by accepting 35 - * two less 255 steps. See Documentation/lzo.txt for more information. 35 + * two less 255 steps. See Documentation/staging/lzo.rst for more information. 36 36 */ 37 37 #define MAX_255_COUNT ((((size_t)~0) / 255) - 2) 38 38
+1 -1
lib/xz/Kconfig
··· 5 5 help 6 6 LZMA2 compression algorithm and BCJ filters are supported using 7 7 the .xz file format as the container. For integrity checking, 8 - CRC32 is supported. See Documentation/xz.txt for more information. 8 + CRC32 is supported. See Documentation/staging/xz.rst for more information. 9 9 10 10 if XZ_DEC 11 11
+1 -1
samples/kprobes/kprobe_example.c
··· 5 5 * stack trace and selected registers when _do_fork() is called. 6 6 * 7 7 * For more information on theory of operation of kprobes, see 8 - * Documentation/kprobes.txt 8 + * Documentation/staging/kprobes.rst 9 9 * 10 10 * You will see the trace data in /var/log/messages and on the console 11 11 * whenever _do_fork() is invoked to create a new process.
+1 -1
samples/kprobes/kretprobe_example.c
··· 11 11 * If no func_name is specified, _do_fork is instrumented 12 12 * 13 13 * For more information on theory of operation of kretprobes, see 14 - * Documentation/kprobes.txt 14 + * Documentation/staging/kprobes.rst 15 15 * 16 16 * Build and insert the kernel module as done in the kprobe example. 17 17 * You will see the trace data in /var/log/messages and on the console