diff options
author | Linus Torvalds <torvalds@linux-foundation.org> | 2018-12-29 14:21:49 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2018-12-29 14:21:49 -0500 |
commit | 3868772b99e3146d02cf47e739d79022eba1d77c (patch) | |
tree | d32c0283496e6955937b618981766b5f0878724f /Documentation/dev-tools | |
parent | 6f9d71c9c759b1e7d31189a4de228983192c7dc7 (diff) | |
parent | 942104a21ce4951420ddf6c6b3179a0627301f7e (diff) |
Merge tag 'docs-5.0' of git://git.lwn.net/linux
Pull documentation update from Jonathan Corbet:
"A fairly normal cycle for documentation stuff. We have a new document
on perf security, more Italian translations, more improvements to the
memory-management docs, improvements to the pathname lookup
documentation, and the usual array of smaller fixes.
As is often the case, there are a few reaches outside of
Documentation/ to adjust kerneldoc comments"
* tag 'docs-5.0' of git://git.lwn.net/linux: (38 commits)
docs: improve pathname-lookup document structure
configfs: fix wrong name of struct in documentation
docs/mm-api: link slab_common.c to "The Slab Cache" section
slab: make kmem_cache_create{_usercopy} description proper kernel-doc
doc:process: add links where missing
docs/core-api: make mm-api.rst more structured
x86, boot: documentation whitespace fixup
Documentation: devres: note checking needs when converting
doc:it: add some process/* translations
doc:it: fixes in process/1.Intro
Documentation: convert path-lookup from markdown to resturctured text
Documentation/admin-guide: update admin-guide index.rst
Documentation/admin-guide: introduce perf-security.rst file
scripts/kernel-doc: Fix struct and struct field attribute processing
Documentation: dev-tools: Fix typos in index.rst
Correct gen_init_cpio tool's documentation
Document /proc/pid PID reuse behavior
Documentation: update path-lookup.md for parallel lookups
Documentation: Use "while" instead of "whilst"
dmaengine: Add mailing list address to the documentation
...
Diffstat (limited to 'Documentation/dev-tools')
-rw-r--r-- | Documentation/dev-tools/coccinelle.rst | 2 | ||||
-rw-r--r-- | Documentation/dev-tools/index.rst | 4 | ||||
-rw-r--r-- | Documentation/dev-tools/kselftest.rst | 12 |
3 files changed, 10 insertions, 8 deletions
diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst index aa14f05cabb1..00a3409b0c28 100644 --- a/Documentation/dev-tools/coccinelle.rst +++ b/Documentation/dev-tools/coccinelle.rst | |||
@@ -4,6 +4,8 @@ | |||
4 | 4 | ||
5 | .. highlight:: none | 5 | .. highlight:: none |
6 | 6 | ||
7 | .. _devtools_coccinelle: | ||
8 | |||
7 | Coccinelle | 9 | Coccinelle |
8 | ========== | 10 | ========== |
9 | 11 | ||
diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst index e313925fb0fa..b0522a4dd107 100644 --- a/Documentation/dev-tools/index.rst +++ b/Documentation/dev-tools/index.rst | |||
@@ -3,8 +3,8 @@ Development tools for the kernel | |||
3 | ================================ | 3 | ================================ |
4 | 4 | ||
5 | This document is a collection of documents about development tools that can | 5 | This document is a collection of documents about development tools that can |
6 | be used to work on the kernel. For now, the documents have been pulled | 6 | be used to work on the kernel. For now, the documents have been pulled |
7 | together without any significant effot to integrate them into a coherent | 7 | together without any significant effort to integrate them into a coherent |
8 | whole; patches welcome! | 8 | whole; patches welcome! |
9 | 9 | ||
10 | .. class:: toc-title | 10 | .. class:: toc-title |
diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst index dad1bb8711e2..7756f7a7c23b 100644 --- a/Documentation/dev-tools/kselftest.rst +++ b/Documentation/dev-tools/kselftest.rst | |||
@@ -9,7 +9,7 @@ and booting a kernel. | |||
9 | 9 | ||
10 | On some systems, hot-plug tests could hang forever waiting for cpu and | 10 | On some systems, hot-plug tests could hang forever waiting for cpu and |
11 | memory to be ready to be offlined. A special hot-plug target is created | 11 | memory to be ready to be offlined. A special hot-plug target is created |
12 | to run full range of hot-plug tests. In default mode, hot-plug tests run | 12 | to run the full range of hot-plug tests. In default mode, hot-plug tests run |
13 | in safe mode with a limited scope. In limited mode, cpu-hotplug test is | 13 | in safe mode with a limited scope. In limited mode, cpu-hotplug test is |
14 | run on a single cpu as opposed to all hotplug capable cpus, and memory | 14 | run on a single cpu as opposed to all hotplug capable cpus, and memory |
15 | hotplug test is run on 2% of hotplug capable memory instead of 10%. | 15 | hotplug test is run on 2% of hotplug capable memory instead of 10%. |
@@ -89,9 +89,9 @@ Note that some tests will require root privileges. | |||
89 | Install selftests | 89 | Install selftests |
90 | ================= | 90 | ================= |
91 | 91 | ||
92 | You can use kselftest_install.sh tool installs selftests in default | 92 | You can use the kselftest_install.sh tool to install selftests in the |
93 | location which is tools/testing/selftests/kselftest or a user specified | 93 | default location, which is tools/testing/selftests/kselftest, or in a |
94 | location. | 94 | user specified location. |
95 | 95 | ||
96 | To install selftests in default location:: | 96 | To install selftests in default location:: |
97 | 97 | ||
@@ -109,7 +109,7 @@ Running installed selftests | |||
109 | Kselftest install as well as the Kselftest tarball provide a script | 109 | Kselftest install as well as the Kselftest tarball provide a script |
110 | named "run_kselftest.sh" to run the tests. | 110 | named "run_kselftest.sh" to run the tests. |
111 | 111 | ||
112 | You can simply do the following to run the installed Kselftests. Please | 112 | You can simply do the following to run the installed Kselftests. Please |
113 | note some tests will require root privileges:: | 113 | note some tests will require root privileges:: |
114 | 114 | ||
115 | $ cd kselftest | 115 | $ cd kselftest |
@@ -139,7 +139,7 @@ Contributing new tests (details) | |||
139 | default. | 139 | default. |
140 | 140 | ||
141 | TEST_CUSTOM_PROGS should be used by tests that require custom build | 141 | TEST_CUSTOM_PROGS should be used by tests that require custom build |
142 | rule and prevent common build rule use. | 142 | rules and prevent common build rule use. |
143 | 143 | ||
144 | TEST_PROGS are for test shell scripts. Please ensure shell script has | 144 | TEST_PROGS are for test shell scripts. Please ensure shell script has |
145 | its exec bit set. Otherwise, lib.mk run_tests will generate a warning. | 145 | its exec bit set. Otherwise, lib.mk run_tests will generate a warning. |