From: Nicolas François <nicolas.francois@centraliens.net>
Date: Tue, 13 Aug 2013 17:28:07 +0000 (+0200)
Subject: Document the semantic of ranges.
X-Git-Tag: 4.2.1~29
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e1a4b6e57beaddea659e0a3e2e4c347e89464aea;p=thirdparty%2Fshadow.git

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 ff486f2dc..74de2e599 100644
--- 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 88cf76163..58d000f2a 100644
--- 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 4a8f6a5b1..725dcd604 100644
--- 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 924ed9d12..0bb47b2eb 100644
--- 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'>