]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: namespaces: convert to ReST
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Thu, 18 Apr 2019 15:43:16 +0000 (12:43 -0300)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Mon, 15 Jul 2019 12:20:25 +0000 (09:20 -0300)
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>
Documentation/namespaces/compatibility-list.rst [moved from Documentation/namespaces/compatibility-list.txt with 86% similarity]
Documentation/namespaces/index.rst [new file with mode: 0644]
Documentation/namespaces/resource-control.rst [moved from Documentation/namespaces/resource-control.txt with 89% similarity]

similarity index 86%
rename from Documentation/namespaces/compatibility-list.txt
rename to Documentation/namespaces/compatibility-list.rst
index defc5589bfcd20e776446e52e3becc00860d54a7..318800b2a943a4a97db69ed32ee9ee50cb0f54e6 100644 (file)
@@ -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
@@ -36,4 +41,3 @@ Net                                            X
    even having equal UIDs.
 
    But currently this is not so.
-
diff --git a/Documentation/namespaces/index.rst b/Documentation/namespaces/index.rst
new file mode 100644 (file)
index 0000000..bf40625
--- /dev/null
@@ -0,0 +1,11 @@
+:orphan:
+
+==========
+Namespaces
+==========
+
+.. toctree::
+   :maxdepth: 1
+
+   compatibility-list
+   resource-control
similarity index 89%
rename from Documentation/namespaces/resource-control.txt
rename to Documentation/namespaces/resource-control.rst
index abc13c39473828a892cd85e5d0b3a61c5bddb8f5..369556e00f0cbf6031818f2f03c3525a0bbdbc10 100644 (file)
@@ -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