docs-rst: create an user's manual book
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 21 Sep 2016 12:51:11 +0000 (09:51 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 24 Oct 2016 10:12:35 +0000 (08:12 -0200)
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>
28 files changed:
Documentation/admin-guide/README.rst [moved from README with 99% similarity]
Documentation/admin-guide/bad-memory.rst [moved from Documentation/bad_memory.txt with 99% similarity]
Documentation/admin-guide/basic-profiling.rst [moved from Documentation/basic_profiling.txt with 99% similarity]
Documentation/admin-guide/binfmt-misc.rst [moved from Documentation/binfmt_misc.txt with 100% similarity]
Documentation/admin-guide/braille-console.rst [moved from Documentation/braille-console.txt with 100% similarity]
Documentation/admin-guide/bug-hunting.rst [moved from Documentation/BUG-HUNTING with 100% similarity]
Documentation/admin-guide/conf.py [new file with mode: 0644]
Documentation/admin-guide/devices.rst [moved from Documentation/devices.txt with 99% similarity]
Documentation/admin-guide/dynamic-debug-howto.rst [moved from Documentation/dynamic-debug-howto.txt with 100% similarity]
Documentation/admin-guide/index.rst [new file with mode: 0644]
Documentation/admin-guide/init.rst [moved from Documentation/init.txt with 100% similarity]
Documentation/admin-guide/initrd.rst [moved from Documentation/initrd.txt with 100% similarity]
Documentation/admin-guide/java.rst [moved from Documentation/java.txt with 99% similarity]
Documentation/admin-guide/kernel-parameters.rst [moved from Documentation/kernel-parameters.txt with 100% similarity]
Documentation/admin-guide/md.rst [moved from Documentation/md.txt with 100% similarity]
Documentation/admin-guide/mono.rst [moved from Documentation/mono.txt with 100% similarity]
Documentation/admin-guide/oops-tracing.rst [moved from Documentation/oops-tracing.txt with 100% similarity]
Documentation/admin-guide/parport.rst [moved from Documentation/parport.txt with 100% similarity]
Documentation/admin-guide/ramoops.rst [moved from Documentation/ramoops.txt with 100% similarity]
Documentation/admin-guide/reporting-bugs.rst [moved from REPORTING-BUGS with 100% similarity]
Documentation/admin-guide/security-bugs.rst [moved from Documentation/SecurityBugs with 95% similarity]
Documentation/admin-guide/serial-console.rst [moved from Documentation/serial-console.txt with 100% similarity]
Documentation/admin-guide/sysfs-rules.rst [moved from Documentation/sysfs-rules.txt with 100% similarity]
Documentation/admin-guide/sysrq.rst [moved from Documentation/sysrq.txt with 100% similarity]
Documentation/admin-guide/unicode.rst [moved from Documentation/unicode.txt with 100% similarity]
Documentation/admin-guide/vga-softcursor.rst [moved from Documentation/VGA-softcursor.txt with 100% similarity]
Documentation/conf.py
Documentation/index.rst

similarity index 99%
rename from README
rename to Documentation/admin-guide/README.rst
index 3335b3b2973a7ace915637983cb481b710bfe8a2..05aad854334036c2cefeed5bb0cdcbe8b6aabdc0 100644 (file)
--- a/README
@@ -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.
-
similarity index 99%
rename from Documentation/bad_memory.txt
rename to Documentation/admin-guide/bad-memory.rst
index 5cac93e27a978b7ba89649e53d107593c7e1b010..017fc86430c34168c7742d44d80096e50158d35b 100644 (file)
@@ -48,4 +48,3 @@ With the numbers of the example above::
 or::
 
        memmap=0x10000$0x18690000
-
similarity index 99%
rename from Documentation/basic_profiling.txt
rename to Documentation/admin-guide/basic-profiling.rst
index 15a49dbd0189c4a01108595f5770d6519e2aa500..72babc71b7713b2102254ed6b5ee6cc08a2f12e3 100644 (file)
@@ -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/admin-guide/conf.py b/Documentation/admin-guide/conf.py
new file mode 100644 (file)
index 0000000..86f7389
--- /dev/null
@@ -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'),
+]
similarity index 99%
rename from Documentation/devices.txt
rename to Documentation/admin-guide/devices.rst
index 17b365331f2358e51493c597d5d495d7c1a4de08..b29555041531b05d93f80722a6d12a85b3c609f2 100644 (file)
@@ -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/admin-guide/index.rst b/Documentation/admin-guide/index.rst
new file mode 100644 (file)
index 0000000..4e5abbb
--- /dev/null
@@ -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
similarity index 99%
rename from Documentation/java.txt
rename to Documentation/admin-guide/java.rst
index ae33d959638c79921e5712bdba36ef26f813434a..a0de7c1a1ed90bce02ef9c2bbc62bfffcb174d5f 100644 (file)
@@ -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>
-
similarity index 95%
rename from Documentation/SecurityBugs
rename to Documentation/admin-guide/security-bugs.rst
index 342d769834f608204b89ce6b4b70ab689a1a5984..df795e22d08be256c696d76b54e1e320738d780e 100644 (file)
@@ -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.
index b08e0c9b73b7ff85d4db2b4576461732ade6e3df..d9bad21dd427394e3c23ea435ef8d95a9623760c 100644 (file)
@@ -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',
index e1f18b3db6e474447304423254f34c8d14e456ba..f6a3d4766495f74d16d22b346532d359118efd08 100644 (file)
@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   admin-guide/index
    kernel-documentation
    process/index
    dev-tools/tools