documentation updates

3 files changed, 46 insertions, 7 deletions

diff --git a/ChangeLog b/ChangeLog
index c4e1d4c..c5f4204 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2003-04-17  Junichi Uekawa  <dancer@debian.org>
+
+	* Documentation/pbuilder-doc.xml (PBUILDER_UML_IMAGE): update and document 
+	/tmp peculiarity.
+
+	* pbuilder-user-mode-linux.1: document /tmp peculiarity
+
 2003-04-11  Junichi Uekawa  <dancer@debian.org>
 
 	* debian/TODO: update TODO, bind mount, and other entries.
diff --git a/Documentation/pbuilder-doc.xml b/Documentation/pbuilder-doc.xml
index 31ef0be..dfd8d6a 100644
--- a/Documentation/pbuilder-doc.xml
+++ b/Documentation/pbuilder-doc.xml
@@ -527,15 +527,18 @@ export DEBIAN_BUILDGCCVER=3.2
       <para>
 	It has been verified that pbuilder-uml works,
 	as of version 0.59.
+	And since then, pbuilder-uml has seen a rapid evolution.
 	The configuration of pbuilder-uml goes in two steps:
 	<itemizedlist>
 	  <listitem>
 	    <para>Configuration of rootstrap</para>
+	  </listitem>
+	  <listitem>
 	    <para>Configuration of pbuilder-uml</para>
 	  </listitem>
 	</itemizedlist>
       </para>
-      <sect2>
+      <sect2 id="rootstrap">
 	<title>Configuring rootstrap</title>
 	<para>
 	  <command>rootstrap</command> is a program that 
@@ -578,7 +581,7 @@ netmask=255.255.255.0
 	  </listitem>
 	</itemizedlist>
       </sect2>
-      <sect2>
+      <sect2 id="pbuilderumlconfig">
 	<title>Configuring pbuilder-uml</title>
 	<para>
 	  The following needs to happen:
@@ -610,7 +613,33 @@ PBUILDER_UML_IMAGE="/home/dancer/uml-image"
 	  </itemizedlist>
 	</para>
       </sect2>
-      <sect2>
+      <sect2 id="consideruml">
+	<title>Considerations for running pbuilder-uml</title>
+	<para>
+	  pbuilder-user-mode-linux emulates most of pbuilder, but there
+	  are some differences.
+	</para>
+	<itemizedlist>
+	  <listitem>
+	    <para>	  
+	      pbuilder-user-mode-linux does not support all options of pbuilder
+	      properly yet. This is a problem, and will be addressed as 
+	      specific areas are discovered.
+	    </para>
+	  </listitem>
+	  <listitem>
+	    <para>
+	      /tmp is handled differently inside pbuilder-uml.
+	      In pbuilder-uml, /tmp is mounted as tmpfs inside UML,
+	      so accessing files under /tmp outside the user-mode-linux
+	      does not work.
+	      It affects options like
+	      <command><option>--configfile</option></command>.
+	    </para>
+	  </listitem>
+	</itemizedlist>
+      </sect2>
+      <sect2 id="paralleluml">
 	<title>Parallel running of pbuilder-user-mode-linux</title>
 	<para>
 	  To run pbuilder-uml parallel on a system, there are a few things 
@@ -632,7 +661,7 @@ PBUILDER_UML_IMAGE="/home/dancer/uml-image"
 	  </listitem>
 	</itemizedlist>
       </sect2>
-      <sect2>
+      <sect2 id="pbuilderumlwrap">
 	<title>Using pbuilder-uml as a wrapper script to start up virtual machine</title>
 	<para>
 	  It is possible to use pbuilder-uml for other uses than just building Debian 
diff --git a/pbuilder-user-mode-linux.1 b/pbuilder-user-mode-linux.1
index b461cf5..b2af482 100644
--- a/pbuilder-user-mode-linux.1
+++ b/pbuilder-user-mode-linux.1
@@ -139,9 +139,6 @@ Enable tracing of shell scripts used by pbuilder-user-mode-linux.
 Bind-mount the directory inside the chroot inside the user-mode-linux.
 
 .SH "NOTES"
-This software is in early stage of development. 
-Reading the source may help you in case this software doesn't work for you.
-
 For 
 .B build
 and
@@ -150,6 +147,12 @@ targets,
 .B pbuider-user-mode-linux
 will try to use COW devices.
 
+Inside user-mode-linux, pbuilder-uml will mount 
+tmpfs as 
+.B /tmp
+to avoid temporary file race conditions with outside of UML.
+This may cause problems trying to use files in /tmp directory.
+
 .SH "FILES"
 .TP
 .I "/etc/pbuilderrc"