[PATCH 08/17] docs-rst: create an user's manual book

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Newsgroups	linux.kernel
Subject	[PATCH 08/17] docs-rst: create an user's manual book
Date	2016-09-22 14:00 +0200
Message-ID	<skaPv-5PF-3@gated-at.bofh.it> (permalink)
References	<skaFP-5LW-1@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

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>
---
 Documentation/SecurityBugs               | 12 ++++++------
 Documentation/index.rst                  |  1 +
 Documentation/user/README.rst            |  1 +
 Documentation/user/REPORTING-BUGS.rst    |  1 +
 Documentation/user/SecurityBugs.rst      |  1 +
 Documentation/user/index.rst             | 13 +++++++++++++
 Documentation/user/kernel-parameters.rst |  1 +
 7 files changed, 24 insertions(+), 6 deletions(-)
 create mode 120000 Documentation/user/README.rst
 create mode 120000 Documentation/user/REPORTING-BUGS.rst
 create mode 120000 Documentation/user/SecurityBugs.rst
 create mode 100644 Documentation/user/index.rst
 create mode 120000 Documentation/user/kernel-parameters.rst

diff --git a/Documentation/SecurityBugs b/Documentation/SecurityBugs
index 342d769834f6..df795e22d08b 100644
--- a/Documentation/SecurityBugs
+++ b/Documentation/SecurityBugs
@@ -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/index.rst b/Documentation/index.rst
index d9ccb94fca95..235b6bc3a304 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   user/index
    kernel-documentation
    development-process/index
    dev-tools/tools
diff --git a/Documentation/user/README.rst b/Documentation/user/README.rst
new file mode 120000
index 000000000000..3830a41184be
--- /dev/null
+++ b/Documentation/user/README.rst
@@ -0,0 +1 @@
+../../README
\ No newline at end of file
diff --git a/Documentation/user/REPORTING-BUGS.rst b/Documentation/user/REPORTING-BUGS.rst
new file mode 120000
index 000000000000..8074a63d7596
--- /dev/null
+++ b/Documentation/user/REPORTING-BUGS.rst
@@ -0,0 +1 @@
+../../REPORTING-BUGS
\ No newline at end of file
diff --git a/Documentation/user/SecurityBugs.rst b/Documentation/user/SecurityBugs.rst
new file mode 120000
index 000000000000..fa5504256c04
--- /dev/null
+++ b/Documentation/user/SecurityBugs.rst
@@ -0,0 +1 @@
+../SecurityBugs
\ No newline at end of file
diff --git a/Documentation/user/index.rst b/Documentation/user/index.rst
new file mode 100644
index 000000000000..280e62f21efa
--- /dev/null
+++ b/Documentation/user/index.rst
@@ -0,0 +1,13 @@
+Linux Kernel User's Documentation
+=================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+   README
+   REPORTING-BUGS
+   SecurityBugs
+   kernel-parameters
diff --git a/Documentation/user/kernel-parameters.rst b/Documentation/user/kernel-parameters.rst
new file mode 120000
index 000000000000..eea97c5ac948
--- /dev/null
+++ b/Documentation/user/kernel-parameters.rst
@@ -0,0 +1 @@
+../kernel-parameters.txt
\ No newline at end of file
-- 
2.7.4

Thread

[PATCH 00/17] More files converted to ReST format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 13:50 +0200
  [PATCH 01/17] Documentation/applying-patches.txt: fix a bad external link Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 13:50 +0200
  [PATCH 13/17] Documentation/serial-console.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 13:50 +0200
  [PATCH 09/17] Documentation/adding-syscalls.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 13:50 +0200
  [PATCH 02/17] Documentation/email-clients.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 08/17] docs-rst: create an user's manual book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 07/17] docs-rst: add documents to development-process Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 15/17] Documentation/BUG-HUNTING: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 11/17] Documentation/basic_profiling.rst: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 03/17] docs-rst: add inter-document cross references Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 06/17] Documentation/kernel-parameters.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 14/17] Documentation/braille-console: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 04/17] REPORTING-BUGS: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 12/17] Documentation/binfmt_misc.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 10/17] Documentation/bad_memory.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200
  [PATCH 05/17] README: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-09-22 14:00 +0200

csiph-web