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>
diff --git a/README b/Documentation/admin-guide/README.rst
similarity index 98%
rename from README
rename to Documentation/admin-guide/README.rst
index 3335b3b..05aad85 100644
--- a/README
+++ b/Documentation/admin-guide/README.rst
@@ -408,4 +408,3 @@
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
similarity index 99%
rename from Documentation/bad_memory.txt
rename to 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 @@
or::
memmap=0x10000$0x18690000
-
diff --git a/Documentation/basic_profiling.txt b/Documentation/admin-guide/basic-profiling.rst
similarity index 99%
rename from Documentation/basic_profiling.txt
rename to 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 @@
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
similarity index 100%
rename from Documentation/binfmt_misc.txt
rename to Documentation/admin-guide/binfmt-misc.rst
diff --git a/Documentation/braille-console.txt b/Documentation/admin-guide/braille-console.rst
similarity index 100%
rename from Documentation/braille-console.txt
rename to Documentation/admin-guide/braille-console.rst
diff --git a/Documentation/BUG-HUNTING b/Documentation/admin-guide/bug-hunting.rst
similarity index 100%
rename from Documentation/BUG-HUNTING
rename to 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
similarity index 99%
rename from Documentation/devices.txt
rename to Documentation/admin-guide/devices.rst
index 17b3653..b295550 100644
--- a/Documentation/devices.txt
+++ b/Documentation/admin-guide/devices.rst
@@ -3348,4 +3348,3 @@
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
similarity index 100%
rename from Documentation/dynamic-debug-howto.txt
rename to 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
similarity index 100%
rename from Documentation/init.txt
rename to Documentation/admin-guide/init.rst
diff --git a/Documentation/initrd.txt b/Documentation/admin-guide/initrd.rst
similarity index 100%
rename from Documentation/initrd.txt
rename to Documentation/admin-guide/initrd.rst
diff --git a/Documentation/java.txt b/Documentation/admin-guide/java.rst
similarity index 99%
rename from Documentation/java.txt
rename to Documentation/admin-guide/java.rst
index ae33d95..a0de7c1 100644
--- a/Documentation/java.txt
+++ b/Documentation/admin-guide/java.rst
@@ -415,4 +415,3 @@
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
similarity index 100%
rename from Documentation/kernel-parameters.txt
rename to Documentation/admin-guide/kernel-parameters.rst
diff --git a/Documentation/md.txt b/Documentation/admin-guide/md.rst
similarity index 100%
rename from Documentation/md.txt
rename to Documentation/admin-guide/md.rst
diff --git a/Documentation/mono.txt b/Documentation/admin-guide/mono.rst
similarity index 100%
rename from Documentation/mono.txt
rename to Documentation/admin-guide/mono.rst
diff --git a/Documentation/oops-tracing.txt b/Documentation/admin-guide/oops-tracing.rst
similarity index 100%
rename from Documentation/oops-tracing.txt
rename to Documentation/admin-guide/oops-tracing.rst
diff --git a/Documentation/parport.txt b/Documentation/admin-guide/parport.rst
similarity index 100%
rename from Documentation/parport.txt
rename to Documentation/admin-guide/parport.rst
diff --git a/Documentation/ramoops.txt b/Documentation/admin-guide/ramoops.rst
similarity index 100%
rename from Documentation/ramoops.txt
rename to Documentation/admin-guide/ramoops.rst
diff --git a/REPORTING-BUGS b/Documentation/admin-guide/reporting-bugs.rst
similarity index 100%
rename from REPORTING-BUGS
rename to Documentation/admin-guide/reporting-bugs.rst
diff --git a/Documentation/SecurityBugs b/Documentation/admin-guide/security-bugs.rst
similarity index 94%
rename from Documentation/SecurityBugs
rename to Documentation/admin-guide/security-bugs.rst
index 342d769..df795e2 100644
--- a/Documentation/SecurityBugs
+++ b/Documentation/admin-guide/security-bugs.rst
@@ -8,8 +8,8 @@
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 @@
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 @@
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
similarity index 100%
rename from Documentation/serial-console.txt
rename to Documentation/admin-guide/serial-console.rst
diff --git a/Documentation/sysfs-rules.txt b/Documentation/admin-guide/sysfs-rules.rst
similarity index 100%
rename from Documentation/sysfs-rules.txt
rename to Documentation/admin-guide/sysfs-rules.rst
diff --git a/Documentation/sysrq.txt b/Documentation/admin-guide/sysrq.rst
similarity index 100%
rename from Documentation/sysrq.txt
rename to Documentation/admin-guide/sysrq.rst
diff --git a/Documentation/unicode.txt b/Documentation/admin-guide/unicode.rst
similarity index 100%
rename from Documentation/unicode.txt
rename to Documentation/admin-guide/unicode.rst
diff --git a/Documentation/VGA-softcursor.txt b/Documentation/admin-guide/vga-softcursor.rst
similarity index 100%
rename from Documentation/VGA-softcursor.txt
rename to 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 @@
# (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 @@
.. toctree::
:maxdepth: 2
+ admin-guide/index
kernel-documentation
process/index
dev-tools/tools