From 20a78ae9ed297f217537211e3304f525326ee517 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Thu, 18 Apr 2019 12:43:16 -0300 Subject: [PATCH] docs: namespaces: convert to ReST 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 --- ...{compatibility-list.txt => compatibility-list.rst} | 10 +++++++--- Documentation/namespaces/index.rst | 11 +++++++++++ .../{resource-control.txt => resource-control.rst} | 4 ++++ 3 files changed, 22 insertions(+), 3 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 defc5589bfcd2..318800b2a943a 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 @@ -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 index 0000000000000..bf40625dd11a8 --- /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 abc13c3947382..369556e00f0cb 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.30.2