diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-21 08:51:11 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-10-24 06:12:35 -0400 |
commit | 9d85025b0418163fae079c9ba8f8445212de8568 (patch) | |
tree | 4629e2dedf4a9ed45a6855c129101f9b52138372 | |
parent | 186128f75392f8478ad1b32a675627d738881ca4 (diff) |
docs-rst: create an user's manual book
Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters
on an user's manual book.
As we'll be numbering the user's manual, remove the manual
numbering from SecurityBugs.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-rw-r--r-- | Documentation/admin-guide/README.rst (renamed from README) | 1 | ||||
-rw-r--r-- | Documentation/admin-guide/bad-memory.rst (renamed from Documentation/bad_memory.txt) | 1 | ||||
-rw-r--r-- | Documentation/admin-guide/basic-profiling.rst (renamed from Documentation/basic_profiling.txt) | 1 | ||||
-rw-r--r-- | Documentation/admin-guide/binfmt-misc.rst (renamed from Documentation/binfmt_misc.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/braille-console.rst (renamed from Documentation/braille-console.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/bug-hunting.rst (renamed from Documentation/BUG-HUNTING) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/conf.py | 10 | ||||
-rw-r--r-- | Documentation/admin-guide/devices.rst (renamed from Documentation/devices.txt) | 1 | ||||
-rw-r--r-- | Documentation/admin-guide/dynamic-debug-howto.rst (renamed from Documentation/dynamic-debug-howto.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/index.rst | 34 | ||||
-rw-r--r-- | Documentation/admin-guide/init.rst (renamed from Documentation/init.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/initrd.rst (renamed from Documentation/initrd.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/java.rst (renamed from Documentation/java.txt) | 1 | ||||
-rw-r--r-- | Documentation/admin-guide/kernel-parameters.rst (renamed from Documentation/kernel-parameters.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/md.rst (renamed from Documentation/md.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/mono.rst (renamed from Documentation/mono.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/oops-tracing.rst (renamed from Documentation/oops-tracing.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/parport.rst (renamed from Documentation/parport.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/ramoops.rst (renamed from Documentation/ramoops.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/reporting-bugs.rst (renamed from REPORTING-BUGS) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/security-bugs.rst (renamed from Documentation/SecurityBugs) | 12 | ||||
-rw-r--r-- | Documentation/admin-guide/serial-console.rst (renamed from Documentation/serial-console.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/sysfs-rules.rst (renamed from Documentation/sysfs-rules.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/sysrq.rst (renamed from Documentation/sysrq.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/unicode.rst (renamed from Documentation/unicode.txt) | 0 | ||||
-rw-r--r-- | Documentation/admin-guide/vga-softcursor.rst (renamed from Documentation/VGA-softcursor.txt) | 0 | ||||
-rw-r--r-- | Documentation/conf.py | 2 | ||||
-rw-r--r-- | Documentation/index.rst | 1 |
28 files changed, 53 insertions, 11 deletions
diff --git a/README b/Documentation/admin-guide/README.rst index 3335b3b2973a..05aad8543340 100644 --- a/README +++ b/Documentation/admin-guide/README.rst | |||
@@ -408,4 +408,3 @@ If something goes wrong | |||
408 | 408 | ||
409 | gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly) | 409 | gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly) |
410 | disregards the starting offset for which the kernel is compiled. | 410 | disregards the starting offset for which the kernel is compiled. |
411 | |||
diff --git a/Documentation/bad_memory.txt b/Documentation/admin-guide/bad-memory.rst index 5cac93e27a97..017fc86430c3 100644 --- a/Documentation/bad_memory.txt +++ b/Documentation/admin-guide/bad-memory.rst | |||
@@ -48,4 +48,3 @@ With the numbers of the example above:: | |||
48 | or:: | 48 | or:: |
49 | 49 | ||
50 | memmap=0x10000$0x18690000 | 50 | memmap=0x10000$0x18690000 |
51 | |||
diff --git a/Documentation/basic_profiling.txt b/Documentation/admin-guide/basic-profiling.rst index 15a49dbd0189..72babc71b771 100644 --- a/Documentation/basic_profiling.txt +++ b/Documentation/admin-guide/basic-profiling.rst | |||
@@ -66,4 +66,3 @@ Some ``opcontrol`` commands:: | |||
66 | To only report on the kernel, run ``opreport -l /boot/vmlinux > output_file`` | 66 | To only report on the kernel, run ``opreport -l /boot/vmlinux > output_file`` |
67 | 67 | ||
68 | A reset is needed to clear old statistics, which survive a reboot. | 68 | A reset is needed to clear old statistics, which survive a reboot. |
69 | |||
diff --git a/Documentation/binfmt_misc.txt b/Documentation/admin-guide/binfmt-misc.rst index 9c5ff8f260bf..9c5ff8f260bf 100644 --- a/Documentation/binfmt_misc.txt +++ b/Documentation/admin-guide/binfmt-misc.rst | |||
diff --git a/Documentation/braille-console.txt b/Documentation/admin-guide/braille-console.rst index fa3702dc04ab..fa3702dc04ab 100644 --- a/Documentation/braille-console.txt +++ b/Documentation/admin-guide/braille-console.rst | |||
diff --git a/Documentation/BUG-HUNTING b/Documentation/admin-guide/bug-hunting.rst index a8ef794aadae..a8ef794aadae 100644 --- a/Documentation/BUG-HUNTING +++ b/Documentation/admin-guide/bug-hunting.rst | |||
diff --git a/Documentation/admin-guide/conf.py b/Documentation/admin-guide/conf.py new file mode 100644 index 000000000000..86f738953799 --- /dev/null +++ b/Documentation/admin-guide/conf.py | |||
@@ -0,0 +1,10 @@ | |||
1 | # -*- coding: utf-8; mode: python -*- | ||
2 | |||
3 | project = 'Linux Kernel User Documentation' | ||
4 | |||
5 | tags.add("subproject") | ||
6 | |||
7 | latex_documents = [ | ||
8 | ('index', 'linux-user.tex', 'Linux Kernel User Documentation', | ||
9 | 'The kernel development community', 'manual'), | ||
10 | ] | ||
diff --git a/Documentation/devices.txt b/Documentation/admin-guide/devices.rst index 17b365331f23..b29555041531 100644 --- a/Documentation/devices.txt +++ b/Documentation/admin-guide/devices.rst | |||
@@ -3348,4 +3348,3 @@ for the slaves; the slaves are named with decimal integers (``/dev/pts/#`` | |||
3348 | in our notation). This removes the problem of exhausting the | 3348 | in our notation). This removes the problem of exhausting the |
3349 | namespace and enables the kernel to automatically create the device | 3349 | namespace and enables the kernel to automatically create the device |
3350 | nodes for the slaves on demand using the "devpts" filesystem. | 3350 | nodes for the slaves on demand using the "devpts" filesystem. |
3351 | |||
diff --git a/Documentation/dynamic-debug-howto.txt b/Documentation/admin-guide/dynamic-debug-howto.rst index 88adcfdf5b2b..88adcfdf5b2b 100644 --- a/Documentation/dynamic-debug-howto.txt +++ b/Documentation/admin-guide/dynamic-debug-howto.rst | |||
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst new file mode 100644 index 000000000000..4e5abbb4bbd5 --- /dev/null +++ b/Documentation/admin-guide/index.rst | |||
@@ -0,0 +1,34 @@ | |||
1 | Linux Kernel User's Documentation | ||
2 | ================================= | ||
3 | |||
4 | Contents: | ||
5 | |||
6 | .. toctree:: | ||
7 | :maxdepth: 2 | ||
8 | :numbered: | ||
9 | |||
10 | README | ||
11 | reporting-bugs | ||
12 | bug-hunting | ||
13 | oops-tracing | ||
14 | ramoops | ||
15 | initrd | ||
16 | init | ||
17 | dynamic-debug-howto | ||
18 | security-bugs | ||
19 | kernel-parameters | ||
20 | serial-console | ||
21 | braille-console | ||
22 | parport | ||
23 | md | ||
24 | module-signing | ||
25 | sysrq | ||
26 | unicode | ||
27 | vga-softcursor | ||
28 | sysfs-rules | ||
29 | devices | ||
30 | binfmt-misc | ||
31 | mono | ||
32 | java | ||
33 | bad-memory | ||
34 | basic-profiling | ||
diff --git a/Documentation/init.txt b/Documentation/admin-guide/init.rst index e89d97f31eaf..e89d97f31eaf 100644 --- a/Documentation/init.txt +++ b/Documentation/admin-guide/init.rst | |||
diff --git a/Documentation/initrd.txt b/Documentation/admin-guide/initrd.rst index a03dabaaf3a3..a03dabaaf3a3 100644 --- a/Documentation/initrd.txt +++ b/Documentation/admin-guide/initrd.rst | |||
diff --git a/Documentation/java.txt b/Documentation/admin-guide/java.rst index ae33d959638c..a0de7c1a1ed9 100644 --- a/Documentation/java.txt +++ b/Documentation/admin-guide/java.rst | |||
@@ -415,4 +415,3 @@ originally by Brian A. Lantz, brian@lantz.com | |||
415 | heavily edited for binfmt_misc by Richard Günther | 415 | heavily edited for binfmt_misc by Richard Günther |
416 | new scripts by Colin J. Watson <cjw44@cam.ac.uk> | 416 | new scripts by Colin J. Watson <cjw44@cam.ac.uk> |
417 | added executable Jar file support by Kurt Huwig <kurt@iku-netz.de> | 417 | added executable Jar file support by Kurt Huwig <kurt@iku-netz.de> |
418 | |||
diff --git a/Documentation/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.rst index b0804273b6e3..b0804273b6e3 100644 --- a/Documentation/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.rst | |||
diff --git a/Documentation/md.txt b/Documentation/admin-guide/md.rst index e449fb5f277c..e449fb5f277c 100644 --- a/Documentation/md.txt +++ b/Documentation/admin-guide/md.rst | |||
diff --git a/Documentation/mono.txt b/Documentation/admin-guide/mono.rst index 9a9744ca0cf3..9a9744ca0cf3 100644 --- a/Documentation/mono.txt +++ b/Documentation/admin-guide/mono.rst | |||
diff --git a/Documentation/oops-tracing.txt b/Documentation/admin-guide/oops-tracing.rst index 3e25ea7349ee..3e25ea7349ee 100644 --- a/Documentation/oops-tracing.txt +++ b/Documentation/admin-guide/oops-tracing.rst | |||
diff --git a/Documentation/parport.txt b/Documentation/admin-guide/parport.rst index ad3f9b8a11e1..ad3f9b8a11e1 100644 --- a/Documentation/parport.txt +++ b/Documentation/admin-guide/parport.rst | |||
diff --git a/Documentation/ramoops.txt b/Documentation/admin-guide/ramoops.rst index 7eaf1e71c083..7eaf1e71c083 100644 --- a/Documentation/ramoops.txt +++ b/Documentation/admin-guide/ramoops.rst | |||
diff --git a/REPORTING-BUGS b/Documentation/admin-guide/reporting-bugs.rst index 05c53ac7fa76..05c53ac7fa76 100644 --- a/REPORTING-BUGS +++ b/Documentation/admin-guide/reporting-bugs.rst | |||
diff --git a/Documentation/SecurityBugs b/Documentation/admin-guide/security-bugs.rst index 342d769834f6..df795e22d08b 100644 --- a/Documentation/SecurityBugs +++ b/Documentation/admin-guide/security-bugs.rst | |||
@@ -8,8 +8,8 @@ like to know when a security bug is found so that it can be fixed and | |||
8 | disclosed as quickly as possible. Please report security bugs to the | 8 | disclosed as quickly as possible. Please report security bugs to the |
9 | Linux kernel security team. | 9 | Linux kernel security team. |
10 | 10 | ||
11 | 1) Contact | 11 | Contact |
12 | ---------- | 12 | ------- |
13 | 13 | ||
14 | The Linux kernel security team can be contacted by email at | 14 | The Linux kernel security team can be contacted by email at |
15 | <security@kernel.org>. This is a private list of security officers | 15 | <security@kernel.org>. This is a private list of security officers |
@@ -23,8 +23,8 @@ REPORTING-BUGS if you are unclear about what information is helpful. | |||
23 | Any exploit code is very helpful and will not be released without | 23 | Any exploit code is very helpful and will not be released without |
24 | consent from the reporter unless it has already been made public. | 24 | consent from the reporter unless it has already been made public. |
25 | 25 | ||
26 | 2) Disclosure | 26 | Disclosure |
27 | ------------- | 27 | ---------- |
28 | 28 | ||
29 | The goal of the Linux kernel security team is to work with the | 29 | The goal of the Linux kernel security team is to work with the |
30 | bug submitter to bug resolution as well as disclosure. We prefer | 30 | bug submitter to bug resolution as well as disclosure. We prefer |
@@ -39,8 +39,8 @@ disclosure is from immediate (esp. if it's already publicly known) | |||
39 | to a few weeks. As a basic default policy, we expect report date to | 39 | to a few weeks. As a basic default policy, we expect report date to |
40 | disclosure date to be on the order of 7 days. | 40 | disclosure date to be on the order of 7 days. |
41 | 41 | ||
42 | 3) Non-disclosure agreements | 42 | Non-disclosure agreements |
43 | ---------------------------- | 43 | ------------------------- |
44 | 44 | ||
45 | The Linux kernel security team is not a formal body and therefore unable | 45 | The Linux kernel security team is not a formal body and therefore unable |
46 | to enter any non-disclosure agreements. | 46 | to enter any non-disclosure agreements. |
diff --git a/Documentation/serial-console.txt b/Documentation/admin-guide/serial-console.rst index a8d1e36b627a..a8d1e36b627a 100644 --- a/Documentation/serial-console.txt +++ b/Documentation/admin-guide/serial-console.rst | |||
diff --git a/Documentation/sysfs-rules.txt b/Documentation/admin-guide/sysfs-rules.rst index 04bdd52cba1d..04bdd52cba1d 100644 --- a/Documentation/sysfs-rules.txt +++ b/Documentation/admin-guide/sysfs-rules.rst | |||
diff --git a/Documentation/sysrq.txt b/Documentation/admin-guide/sysrq.rst index d1712ea2d314..d1712ea2d314 100644 --- a/Documentation/sysrq.txt +++ b/Documentation/admin-guide/sysrq.rst | |||
diff --git a/Documentation/unicode.txt b/Documentation/admin-guide/unicode.rst index 012e8e895842..012e8e895842 100644 --- a/Documentation/unicode.txt +++ b/Documentation/admin-guide/unicode.rst | |||
diff --git a/Documentation/VGA-softcursor.txt b/Documentation/admin-guide/vga-softcursor.rst index 9eac6744b3a1..9eac6744b3a1 100644 --- a/Documentation/VGA-softcursor.txt +++ b/Documentation/admin-guide/vga-softcursor.rst | |||
diff --git a/Documentation/conf.py b/Documentation/conf.py index b08e0c9b73b7..d9bad21dd427 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py | |||
@@ -336,6 +336,8 @@ latex_elements = { | |||
336 | # (source start file, target name, title, | 336 | # (source start file, target name, title, |
337 | # author, documentclass [howto, manual, or own class]). | 337 | # author, documentclass [howto, manual, or own class]). |
338 | latex_documents = [ | 338 | latex_documents = [ |
339 | ('user/index', 'linux-user.tex', 'Linux Kernel User Documentation', | ||
340 | 'The kernel development community', 'manual'), | ||
339 | ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation', | 341 | ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation', |
340 | 'The kernel development community', 'manual'), | 342 | 'The kernel development community', 'manual'), |
341 | ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation', | 343 | ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation', |
diff --git a/Documentation/index.rst b/Documentation/index.rst index e1f18b3db6e4..f6a3d4766495 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst | |||
@@ -11,6 +11,7 @@ Contents: | |||
11 | .. toctree:: | 11 | .. toctree:: |
12 | :maxdepth: 2 | 12 | :maxdepth: 2 |
13 | 13 | ||
14 | admin-guide/index | ||
14 | kernel-documentation | 15 | kernel-documentation |
15 | process/index | 16 | process/index |
16 | dev-tools/tools | 17 | dev-tools/tools |