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 <[email protected]>
kerneltoast · Oct 24, 2016 · 9d85025 · 9d85025
1 parent 186128f
commit 9d85025
Show file tree

Hide file tree

Showing 28 changed files with 53 additions and 11 deletions.
diff --git a/README → Documentation/admin-guide/README.rst b/README → 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 → Documentation/admin-guide/bad-memory.rst b/Documentation/bad_memory.txt → 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 → ...mentation/admin-guide/basic-profiling.rst b/Documentation/basic_profiling.txt → ...mentation/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 → Documentation/admin-guide/binfmt-misc.rst b/Documentation/binfmt_misc.txt → Documentation/admin-guide/binfmt-misc.rst
diff --git a/Documentation/braille-console.txt → ...mentation/admin-guide/braille-console.rst b/Documentation/braille-console.txt → ...mentation/admin-guide/braille-console.rst
diff --git a/Documentation/BUG-HUNTING → Documentation/admin-guide/bug-hunting.rst b/Documentation/BUG-HUNTING → Documentation/admin-guide/bug-hunting.rst
diff --git a/Documentation/admin-guide/conf.py 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 → Documentation/admin-guide/devices.rst b/Documentation/devices.txt → 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 → ...ation/admin-guide/dynamic-debug-howto.rst b/Documentation/dynamic-debug-howto.txt → ...ation/admin-guide/dynamic-debug-howto.rst
diff --git a/Documentation/admin-guide/index.rst 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 → Documentation/admin-guide/init.rst b/Documentation/init.txt → Documentation/admin-guide/init.rst
diff --git a/Documentation/initrd.txt → Documentation/admin-guide/initrd.rst b/Documentation/initrd.txt → Documentation/admin-guide/initrd.rst
diff --git a/Documentation/java.txt → Documentation/admin-guide/java.rst b/Documentation/java.txt → Documentation/admin-guide/java.rst
@@ -415,4 +415,3 @@ originally by Brian A. Lantz, [email protected]
 heavily edited for binfmt_misc by Richard Günther
 new scripts by Colin J. Watson <[email protected]>
 added executable Jar file support by Kurt Huwig <[email protected]>
-
diff --git a/Documentation/kernel-parameters.txt → ...ntation/admin-guide/kernel-parameters.rst b/Documentation/kernel-parameters.txt → ...ntation/admin-guide/kernel-parameters.rst
diff --git a/Documentation/md.txt → Documentation/admin-guide/md.rst b/Documentation/md.txt → Documentation/admin-guide/md.rst
diff --git a/Documentation/mono.txt → Documentation/admin-guide/mono.rst b/Documentation/mono.txt → Documentation/admin-guide/mono.rst
diff --git a/Documentation/oops-tracing.txt → Documentation/admin-guide/oops-tracing.rst b/Documentation/oops-tracing.txt → Documentation/admin-guide/oops-tracing.rst
diff --git a/Documentation/parport.txt → Documentation/admin-guide/parport.rst b/Documentation/parport.txt → Documentation/admin-guide/parport.rst
diff --git a/Documentation/ramoops.txt → Documentation/admin-guide/ramoops.rst b/Documentation/ramoops.txt → Documentation/admin-guide/ramoops.rst
diff --git a/REPORTING-BUGS → Documentation/admin-guide/reporting-bugs.rst b/REPORTING-BUGS → Documentation/admin-guide/reporting-bugs.rst
diff --git a/Documentation/SecurityBugs → Documentation/admin-guide/security-bugs.rst b/Documentation/SecurityBugs → 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
 <[email protected]>.  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 → Documentation/admin-guide/serial-console.rst b/Documentation/serial-console.txt → Documentation/admin-guide/serial-console.rst
diff --git a/Documentation/sysfs-rules.txt → Documentation/admin-guide/sysfs-rules.rst b/Documentation/sysfs-rules.txt → Documentation/admin-guide/sysfs-rules.rst
diff --git a/Documentation/sysrq.txt → Documentation/admin-guide/sysrq.rst b/Documentation/sysrq.txt → Documentation/admin-guide/sysrq.rst
diff --git a/Documentation/unicode.txt → Documentation/admin-guide/unicode.rst b/Documentation/unicode.txt → Documentation/admin-guide/unicode.rst
diff --git a/Documentation/VGA-softcursor.txt → Documentation/admin-guide/vga-softcursor.rst b/Documentation/VGA-softcursor.txt → Documentation/admin-guide/vga-softcursor.rst
diff --git 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
@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   admin-guide/index
    kernel-documentation
    process/index
    dev-tools/tools
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -48,4 +48,3 @@ With the numbers of the example above::
		or::

		memmap=0x10000$0x18690000
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -415,4 +415,3 @@ originally by Brian A. Lantz, [email protected]
		heavily edited for binfmt_misc by Richard Günther
		new scripts by Colin J. Watson <[email protected]>
		added executable Jar file support by Kurt Huwig <[email protected]>