lkml.org 
[lkml]   [2019]   [Apr]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 66/79] docs: namespaces: convert to ReST
    Date
    Rename the namespaces documentation files to ReST, add an
    index for them and adjust in order to produce a nice html
    output via the Sphinx build system.

    There are two upper case file names. Rename them to
    lower case, as we're working to avoid upper case file
    names at Documentation.

    At its new index.rst, let's add a :orphan: while this is not linked to
    the main index.rst file, in order to avoid build warnings.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
    ---
    ...{compatibility-list.txt => compatibility-list.rst} | 9 +++++++--
    Documentation/namespaces/index.rst | 11 +++++++++++
    .../{resource-control.txt => resource-control.rst} | 4 ++++
    3 files changed, 22 insertions(+), 2 deletions(-)
    rename Documentation/namespaces/{compatibility-list.txt => compatibility-list.rst} (86%)
    create mode 100644 Documentation/namespaces/index.rst
    rename Documentation/namespaces/{resource-control.txt => resource-control.rst} (89%)

    diff --git a/Documentation/namespaces/compatibility-list.txt b/Documentation/namespaces/compatibility-list.rst
    similarity index 86%
    rename from Documentation/namespaces/compatibility-list.txt
    rename to Documentation/namespaces/compatibility-list.rst
    index defc5589bfcd..3af5b05156e7 100644
    --- a/Documentation/namespaces/compatibility-list.txt
    +++ b/Documentation/namespaces/compatibility-list.rst
    @@ -1,4 +1,6 @@
    - Namespaces compatibility list
    +=============================
    +Namespaces compatibility list
    +=============================

    This document contains the information about the problems user
    may have when creating tasks living in different namespaces.
    @@ -7,13 +9,16 @@ Here's the summary. This matrix shows the known problems, that
    occur when tasks share some namespace (the columns) while living
    in different other namespaces (the rows):

    - UTS IPC VFS PID User Net
    +==== === === === === ==== ===
    +- UTS IPC VFS PID User Net
    +==== === === === === ==== ===
    UTS X
    IPC X 1
    VFS X
    PID 1 1 X
    User 2 2 X
    Net X
    +==== === === === === ==== ===

    1. Both the IPC and the PID namespaces provide IDs to address
    object inside the kernel. E.g. semaphore with IPCID or
    diff --git a/Documentation/namespaces/index.rst b/Documentation/namespaces/index.rst
    new file mode 100644
    index 000000000000..bf40625dd11a
    --- /dev/null
    +++ b/Documentation/namespaces/index.rst
    @@ -0,0 +1,11 @@
    +:orphan:
    +
    +==========
    +Namespaces
    +==========
    +
    +.. toctree::
    + :maxdepth: 1
    +
    + compatibility-list
    + resource-control
    diff --git a/Documentation/namespaces/resource-control.txt b/Documentation/namespaces/resource-control.rst
    similarity index 89%
    rename from Documentation/namespaces/resource-control.txt
    rename to Documentation/namespaces/resource-control.rst
    index abc13c394738..369556e00f0c 100644
    --- a/Documentation/namespaces/resource-control.txt
    +++ b/Documentation/namespaces/resource-control.rst
    @@ -1,3 +1,7 @@
    +===========================
    +Namespaces research control
    +===========================
    +
    There are a lot of kinds of objects in the kernel that don't have
    individual limits or that have limits that are ineffective when a set
    of processes is allowed to switch user ids. With user namespaces
    --
    2.20.1
    \
     
     \ /
      Last update: 2019-04-22 15:35    [W:2.050 / U:1.340 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site