Commit 8e2a46a4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/11bd0d75e65a874f7c276a0aeab0fe13f3376f5f.1592203650.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 781885fd
...@@ -182,6 +182,19 @@ subprojects. ...@@ -182,6 +182,19 @@ subprojects.
filesystems/ext4/index 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 Translations
------------ ------------
......
.. 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
...@@ -22,7 +22,7 @@ for remote processors that supports this kind of communication. This way, ...@@ -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 platform-specific remoteproc drivers only need to provide a few low-level
handlers, and then all rpmsg drivers will then just work handlers, and then all rpmsg drivers will then just work
(for more information about the virtio-based rpmsg bus and its drivers, (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 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 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 remoteproc will add those devices. This makes it possible to reuse the
......
This document explains potential effects of speculation, and how undesirable
effects can be mitigated portably using common APIs.
=========== ===========
Speculation 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 To improve performance and minimize average latencies, many contemporary CPUs
employ speculative execution techniques such as branch prediction, performing employ speculative execution techniques such as branch prediction, performing
work which may be discarded at a later stage. work which may be discarded at a later stage.
......
...@@ -230,6 +230,7 @@ The AMD-TEE driver packages the command buffer payload for processing in TEE. ...@@ -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 command buffer format for the different TEE commands can be found in [7].
The TEE commands supported by AMD-TEE Trusted OS are: The TEE commands supported by AMD-TEE Trusted OS are:
* TEE_CMD_ID_LOAD_TA - loads a Trusted Application (TA) binary into * TEE_CMD_ID_LOAD_TA - loads a Trusted Application (TA) binary into
TEE environment. TEE environment.
* TEE_CMD_ID_UNLOAD_TA - unloads TA binary from TEE environment. * TEE_CMD_ID_UNLOAD_TA - unloads TA binary from TEE environment.
......
...@@ -40,7 +40,7 @@ Synopsis of kprobe_events ...@@ -40,7 +40,7 @@ Synopsis of kprobe_events
MEMADDR : Address where the probe is inserted. MEMADDR : Address where the probe is inserted.
MAXACTIVE : Maximum number of instances of the specified function that MAXACTIVE : Maximum number of instances of the specified function that
can be probed simultaneously, or 0 for the default value 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. FETCHARGS : Arguments. Each probe can have up to 128 args.
%REG : Fetch register REG %REG : Fetch register REG
......
...@@ -9597,7 +9597,7 @@ M: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com> ...@@ -9597,7 +9597,7 @@ M: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
M: "David S. Miller" <davem@davemloft.net> M: "David S. Miller" <davem@davemloft.net>
M: Masami Hiramatsu <mhiramat@kernel.org> M: Masami Hiramatsu <mhiramat@kernel.org>
S: Maintained S: Maintained
F: Documentation/kprobes.txt F: Documentation/staging/kprobes.rst
F: include/asm-generic/kprobes.h F: include/asm-generic/kprobes.h
F: include/linux/kprobes.h F: include/linux/kprobes.h
F: kernel/kprobes.c F: kernel/kprobes.c
...@@ -14500,7 +14500,7 @@ S: Maintained ...@@ -14500,7 +14500,7 @@ S: Maintained
T: git git://git.kernel.org/pub/scm/linux/kernel/git/andersson/remoteproc.git rproc-next 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/ABI/testing/sysfs-class-remoteproc
F: Documentation/devicetree/bindings/remoteproc/ F: Documentation/devicetree/bindings/remoteproc/
F: Documentation/remoteproc.txt F: Documentation/staging/remoteproc.rst
F: drivers/remoteproc/ F: drivers/remoteproc/
F: include/linux/remoteproc.h F: include/linux/remoteproc.h
F: include/linux/remoteproc/ F: include/linux/remoteproc/
...@@ -14512,7 +14512,7 @@ L: linux-remoteproc@vger.kernel.org ...@@ -14512,7 +14512,7 @@ L: linux-remoteproc@vger.kernel.org
S: Maintained S: Maintained
T: git git://git.kernel.org/pub/scm/linux/kernel/git/andersson/remoteproc.git rpmsg-next 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/ABI/testing/sysfs-bus-rpmsg
F: Documentation/rpmsg.txt F: Documentation/staging/rpmsg.rst
F: drivers/rpmsg/ F: drivers/rpmsg/
F: include/linux/rpmsg.h F: include/linux/rpmsg.h
F: include/linux/rpmsg/ F: include/linux/rpmsg/
...@@ -16761,7 +16761,7 @@ TEE SUBSYSTEM ...@@ -16761,7 +16761,7 @@ TEE SUBSYSTEM
M: Jens Wiklander <jens.wiklander@linaro.org> M: Jens Wiklander <jens.wiklander@linaro.org>
L: tee-dev@lists.linaro.org L: tee-dev@lists.linaro.org
S: Maintained S: Maintained
F: Documentation/tee.txt F: Documentation/staging/tee.rst
F: drivers/tee/ F: drivers/tee/
F: include/linux/tee_drv.h F: include/linux/tee_drv.h
F: include/uapi/linux/tee.h F: include/uapi/linux/tee.h
......
...@@ -68,7 +68,7 @@ ...@@ -68,7 +68,7 @@
* Lacking toolchain and or architecture support, static keys fall back to a * Lacking toolchain and or architecture support, static keys fall back to a
* simple conditional branch. * simple conditional branch.
* *
* Additional babbling in: Documentation/static-keys.txt * Additional babbling in: Documentation/staging/static-keys.rst
*/ */
#ifndef __ASSEMBLY__ #ifndef __ASSEMBLY__
......
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
* Version 2. See the file COPYING for more details. * 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/crc32.h>
#include <linux/crc32poly.h> #include <linux/crc32poly.h>
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* depending on the base count. Since the base count is taken from a u8 * 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 * 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 * 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) #define MAX_255_COUNT ((((size_t)~0) / 255) - 2)
......
...@@ -5,7 +5,7 @@ config XZ_DEC ...@@ -5,7 +5,7 @@ config XZ_DEC
help help
LZMA2 compression algorithm and BCJ filters are supported using LZMA2 compression algorithm and BCJ filters are supported using
the .xz file format as the container. For integrity checking, 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 if XZ_DEC
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
* stack trace and selected registers when _do_fork() is called. * stack trace and selected registers when _do_fork() is called.
* *
* For more information on theory of operation of kprobes, see * 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 * You will see the trace data in /var/log/messages and on the console
* whenever _do_fork() is invoked to create a new process. * whenever _do_fork() is invoked to create a new process.
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
* If no func_name is specified, _do_fork is instrumented * If no func_name is specified, _do_fork is instrumented
* *
* For more information on theory of operation of kretprobes, see * 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. * 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 * You will see the trace data in /var/log/messages and on the console
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment