summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-09-21 09:51:11 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-10-24 08:12:35 -0200
commit9d85025b0418163fae079c9ba8f8445212de8568 (patch)
tree4629e2dedf4a9ed45a6855c129101f9b52138372
parent186128f75392f8478ad1b32a675627d738881ca4 (diff)
downloadop-kernel-dev-9d85025b0418163fae079c9ba8f8445212de8568.zip
op-kernel-dev-9d85025b0418163fae079c9ba8f8445212de8568.tar.gz
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.py10
-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.rst34
-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.py2
-rw-r--r--Documentation/index.rst1
28 files changed, 53 insertions, 11 deletions
diff --git a/README b/Documentation/admin-guide/README.rst
index 3335b3b..05aad85 100644
--- a/README
+++ b/Documentation/admin-guide/README.rst
@@ -408,4 +408,3 @@ If something goes wrong
gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly)
disregards the starting offset for which the kernel is compiled.
-
diff --git a/Documentation/bad_memory.txt b/Documentation/admin-guide/bad-memory.rst
index 5cac93e..017fc86 100644
--- a/Documentation/bad_memory.txt
+++ b/Documentation/admin-guide/bad-memory.rst
@@ -48,4 +48,3 @@ With the numbers of the example above::
or::
memmap=0x10000$0x18690000
-
diff --git a/Documentation/basic_profiling.txt b/Documentation/admin-guide/basic-profiling.rst
index 15a49db..72babc7 100644
--- a/Documentation/basic_profiling.txt
+++ b/Documentation/admin-guide/basic-profiling.rst
@@ -66,4 +66,3 @@ Some ``opcontrol`` commands::
To only report on the kernel, run ``opreport -l /boot/vmlinux > output_file``
A reset is needed to clear old statistics, which survive a reboot.
-
diff --git a/Documentation/binfmt_misc.txt b/Documentation/admin-guide/binfmt-misc.rst
index 9c5ff8f..9c5ff8f 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 fa3702d..fa3702d 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 a8ef794..a8ef794 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 0000000..86f7389
--- /dev/null
+++ b/Documentation/admin-guide/conf.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = 'Linux Kernel User Documentation'
+
+tags.add("subproject")
+
+latex_documents = [
+ ('index', 'linux-user.tex', 'Linux Kernel User Documentation',
+ 'The kernel development community', 'manual'),
+]
diff --git a/Documentation/devices.txt b/Documentation/admin-guide/devices.rst
index 17b3653..b295550 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/#``
in our notation). This removes the problem of exhausting the
namespace and enables the kernel to automatically create the device
nodes for the slaves on demand using the "devpts" filesystem.
-
diff --git a/Documentation/dynamic-debug-howto.txt b/Documentation/admin-guide/dynamic-debug-howto.rst
index 88adcfd..88adcfd 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 0000000..4e5abbb
--- /dev/null
+++ b/Documentation/admin-guide/index.rst
@@ -0,0 +1,34 @@
+Linux Kernel User's Documentation
+=================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ README
+ reporting-bugs
+ bug-hunting
+ oops-tracing
+ ramoops
+ initrd
+ init
+ dynamic-debug-howto
+ security-bugs
+ kernel-parameters
+ serial-console
+ braille-console
+ parport
+ md
+ module-signing
+ sysrq
+ unicode
+ vga-softcursor
+ sysfs-rules
+ devices
+ binfmt-misc
+ mono
+ java
+ bad-memory
+ basic-profiling
diff --git a/Documentation/init.txt b/Documentation/admin-guide/init.rst
index e89d97f..e89d97f 100644
--- a/Documentation/init.txt
+++ b/Documentation/admin-guide/init.rst
diff --git a/Documentation/initrd.txt b/Documentation/admin-guide/initrd.rst
index a03daba..a03daba 100644
--- a/Documentation/initrd.txt
+++ b/Documentation/admin-guide/initrd.rst
diff --git a/Documentation/java.txt b/Documentation/admin-guide/java.rst
index ae33d95..a0de7c1 100644
--- a/Documentation/java.txt
+++ b/Documentation/admin-guide/java.rst
@@ -415,4 +415,3 @@ originally by Brian A. Lantz, brian@lantz.com
heavily edited for binfmt_misc by Richard Günther
new scripts by Colin J. Watson <cjw44@cam.ac.uk>
added executable Jar file support by Kurt Huwig <kurt@iku-netz.de>
-
diff --git a/Documentation/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.rst
index b080427..b080427 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 e449fb5..e449fb5 100644
--- a/Documentation/md.txt
+++ b/Documentation/admin-guide/md.rst
diff --git a/Documentation/mono.txt b/Documentation/admin-guide/mono.rst
index 9a9744c..9a9744c 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 3e25ea7..3e25ea7 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 ad3f9b8..ad3f9b8 100644
--- a/Documentation/parport.txt
+++ b/Documentation/admin-guide/parport.rst
diff --git a/Documentation/ramoops.txt b/Documentation/admin-guide/ramoops.rst
index 7eaf1e7..7eaf1e7 100644
--- a/Documentation/ramoops.txt
+++ b/Documentation/admin-guide/ramoops.rst
diff --git a/REPORTING-BUGS b/Documentation/admin-guide/reporting-bugs.rst
index 05c53ac..05c53ac 100644
--- a/REPORTING-BUGS
+++ b/Documentation/admin-guide/reporting-bugs.rst
diff --git a/Documentation/SecurityBugs b/Documentation/admin-guide/security-bugs.rst
index 342d769..df795e2 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
disclosed as quickly as possible. Please report security bugs to the
Linux kernel security team.
-1) Contact
-----------
+Contact
+-------
The Linux kernel security team can be contacted by email at
<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.
Any exploit code is very helpful and will not be released without
consent from the reporter unless it has already been made public.
-2) Disclosure
--------------
+Disclosure
+----------
The goal of the Linux kernel security team is to work with the
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)
to a few weeks. As a basic default policy, we expect report date to
disclosure date to be on the order of 7 days.
-3) Non-disclosure agreements
-----------------------------
+Non-disclosure agreements
+-------------------------
The Linux kernel security team is not a formal body and therefore unable
to enter any non-disclosure agreements.
diff --git a/Documentation/serial-console.txt b/Documentation/admin-guide/serial-console.rst
index a8d1e36..a8d1e36 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 04bdd52..04bdd52 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 d1712ea..d1712ea 100644
--- a/Documentation/sysrq.txt
+++ b/Documentation/admin-guide/sysrq.rst
diff --git a/Documentation/unicode.txt b/Documentation/admin-guide/unicode.rst
index 012e8e8..012e8e8 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 9eac674..9eac674 100644
--- a/Documentation/VGA-softcursor.txt
+++ b/Documentation/admin-guide/vga-softcursor.rst
diff --git a/Documentation/conf.py b/Documentation/conf.py
index b08e0c9..d9bad21 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -336,6 +336,8 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
+ ('user/index', 'linux-user.tex', 'Linux Kernel User Documentation',
+ 'The kernel development community', 'manual'),
('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
'The kernel development community', 'manual'),
('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
diff --git a/Documentation/index.rst b/Documentation/index.rst
index e1f18b3..f6a3d47 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -11,6 +11,7 @@ Contents:
.. toctree::
:maxdepth: 2
+ admin-guide/index
kernel-documentation
process/index
dev-tools/tools
OpenPOWER on IntegriCloud