lkml.org 
[lkml]   [2016]   [Oct]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 06/32] docs-rst: create an user's manual book
    Date
    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/conf.py | 2 ++
    Documentation/index.rst | 1 +
    Documentation/user/README.rst | 1 +
    Documentation/user/REPORTING-BUGS.rst | 1 +
    Documentation/user/SecurityBugs.rst | 1 +
    Documentation/user/conf.py | 10 ++++++++++
    Documentation/user/index.rst | 13 +++++++++++++
    Documentation/user/kernel-parameters.rst | 1 +
    9 files changed, 36 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/conf.py
    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/conf.py b/Documentation/conf.py
    index bf6f310e5170..b77b23cc1a86 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'),
    ('development-process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
    diff --git a/Documentation/index.rst b/Documentation/index.rst
    index c53d089455a4..891b0291d9e0 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/conf.py b/Documentation/user/conf.py
    new file mode 100644
    index 000000000000..86f738953799
    --- /dev/null
    +++ b/Documentation/user/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/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

    \
     
     \ /
      Last update: 2016-10-17 19:05    [W:4.112 / U:0.012 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site