Document the semantic of ranges.

	* libmisc/idmapping.h: Document what the upper and lower fields
	are in struct map_range.
	* man/newgidmap.1.xml: Document when the gid, gidlower and count
	argument are.
	* man/newuidmap.1.xml: Likewise for uid, uidlower and count.

diff --git a/ChangeLog b/ChangeLog
index ff486f2dcdc5663e2efd880420aeb46e8868987b..74de2e599b4a058fbda626c3f29650d7c531791e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2013-08-13  Nicolas François  <nicolas.francois@centraliens.net>
+
+       * libmisc/idmapping.h: Document what the upper and lower fields
+       are in struct map_range.
+       * man/newgidmap.1.xml: Document when the gid, gidlower and count
+       argument are.
+       * man/newuidmap.1.xml: Likewise for uid, uidlower and count.
+
 2013-08-13  Nicolas François  <nicolas.francois@centraliens.net>
 
        * libmisc/salt.c (shadow_random): Use long instead of size_t.

diff --git a/libmisc/idmapping.h b/libmisc/idmapping.h
index 88cf76163a677fdb26b38d30120df0e5a06df4b9..58d000f2aa83902bfdc73ef1b6fa8832d21a9e54 100644 (file)
--- a/libmisc/idmapping.h
+++ b/libmisc/idmapping.h
@@ -31,9 +31,9 @@
 #define _IDMAPPING_H_
 
 struct map_range {
-       unsigned long upper;
-       unsigned long lower;
-       unsigned long count;
+       unsigned long upper; /* first ID inside the namespace */
+       unsigned long lower; /* first ID outside the namespace */
+       unsigned long count; /* Length of the inside and outside ranges */
 };
 
 extern struct map_range *get_map_ranges(int ranges, int argc, char **argv);

diff --git a/man/newgidmap.1.xml b/man/newgidmap.1.xml
index 4a8f6a5b11588783b8a5181898d1349e29f5ee69..725dcd6047a012235063cc54a9142ee627bc06fb 100644 (file)
--- a/man/newgidmap.1.xml
+++ b/man/newgidmap.1.xml
@@ -87,6 +87,35 @@
       command line arguments and the gids allowed in <filename>/etc/subgid</filename>.
     </para>
 
+    <para>
+      After the pid argument, <command>newgidmap</command> expects sets of 3 integers:
+      <variablelist>
+       <varlistentry>
+         <term>gid</term>
+         <listitem>
+           <para>
+             Begining of the range of GIDs inside the user namespace.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>lowergid</term>
+         <listitem>
+           <para>
+             Begining of the range of GIDs outside the user namespace.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>count</term>
+         <listitem>
+           <para>
+             Length of the ranges (both inside and outside the user namespace).
+           </para>
+         </listitem>
+       </varlistentry>
+      </variablelist>
+    </para>
   </refsect1>
 
   <refsect1 id='options'>

diff --git a/man/newuidmap.1.xml b/man/newuidmap.1.xml
index 924ed9d12302559964ceb9f804622c019a1450dd..0bb47b2eb17886076beb5529c43bb4d3bb888109 100644 (file)
--- a/man/newuidmap.1.xml
+++ b/man/newuidmap.1.xml
@@ -84,6 +84,35 @@
       command line arguments and the uids allowed in <filename>/etc/subuid</filename>.
     </para>
 
+    <para>
+      After the pid argument, <command>newuidmap</command> expects sets of 3 integers:
+      <variablelist>
+       <varlistentry>
+         <term>uid</term>
+         <listitem>
+           <para>
+             Begining of the range of UIDs inside the user namespace.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>loweruid</term>
+         <listitem>
+           <para>
+             Begining of the range of UIDs outside the user namespace.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>count</term>
+         <listitem>
+           <para>
+             Length of the ranges (both inside and outside the user namespace).
+           </para>
+         </listitem>
+       </varlistentry>
+      </variablelist>
+    </para>
   </refsect1>
 
   <refsect1 id='options'>