[Pancutan-commits] r76 - in html/podhtml: . Pancutan Pancutan/Test
tincho-guest at alioth.debian.org
tincho-guest at alioth.debian.org
Mon Aug 20 18:52:57 UTC 2007
Author: tincho-guest
Date: 2007-08-20 18:52:57 +0000 (Mon, 20 Aug 2007)
New Revision: 76
Modified:
html/podhtml/Pancutan/Config.html
html/podhtml/Pancutan/Test/Booting.html
html/podhtml/Pancutan/Test/Files.html
html/podhtml/Pancutan/Test/Meta.html
html/podhtml/Pancutan/Test/Repositories.html
html/podhtml/Pancutan/Test/Sizes.html
html/podhtml/Pancutan/Test/Structural.html
html/podhtml/Pancutan/Tests.html
html/podhtml/Pancutan/Util.html
html/podhtml/index.html
html/podhtml/pancutan.html
Log:
update on html docs
Modified: html/podhtml/Pancutan/Config.html
===================================================================
--- html/podhtml/Pancutan/Config.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Config.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -1,4 +1,4 @@
-Cannot find page `YAML' at L<> on line 127
+Cannot find page `YAML' at L<> on line 291
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
@@ -60,7 +60,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Test/Booting.html
===================================================================
--- html/podhtml/Pancutan/Test/Booting.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Test/Booting.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -26,13 +26,26 @@
Tasks defined:
</p>
<dl class="POD_LIST">
-<dt class="POD_ITEM"><a name="read_eltorito"><b>read_eltorito</b></a>
+<dt class="POD_ITEM"><a name="detect_eltorito"><b>detect_eltorito</b></a>
+<dt><a name="detect_apm_partition"><b>detect_apm_partition</b></a>
+<dt><a name="detect_mbr_partition"><b>detect_mbr_partition</b></a>
+<dt><a name="detect_bsd_partition"><b>detect_bsd_partition</b></a>
+<dt><a name="detect_sparc_partiti"><b>detect_sparc_partition</b></a>
+<dt><a name="detect_sgi_partition"><b>detect_sgi_partition</b></a>
+<dt><a name="detect_pmax_boot"><b>detect_pmax_boot</b></a>
+<dt><a name="detect_alpha_boot"><b>detect_alpha_boot</b></a>
<dd>
Type: first_cd
<p class="POD_TEXT">
-Detects if an ISO image has an El Torito boot descriptor and verifies its
-validity.
+These routines scan the ISO image for the different boot methods of each
+architecture, perform sanity checks and detect the bootloaders and their
+configuration files, if any. That information is later parsed by
+<i>detect_boot_sequence</i>.
</p>
+<dt class="POD_ITEM"><a name="detect_boot_sequence"><b>detect_boot_sequence</b></a>
+<dd>
+Once detected all the possible boot methods, parses configuration files and
+determines which kernels and initrds are being loaded.
</dl>
<h2 class="POD_HEAD1"><a name="SEE_ALSO">SEE ALSO</a></h2>
<p class="POD_TEXT">
@@ -44,7 +57,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Test/Files.html
===================================================================
--- html/podhtml/Pancutan/Test/Files.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Test/Files.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -57,7 +57,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Test/Meta.html
===================================================================
--- html/podhtml/Pancutan/Test/Meta.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Test/Meta.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -88,7 +88,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Test/Repositories.html
===================================================================
--- html/podhtml/Pancutan/Test/Repositories.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Test/Repositories.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -45,7 +45,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Test/Sizes.html
===================================================================
--- html/podhtml/Pancutan/Test/Sizes.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Test/Sizes.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -44,7 +44,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Test/Structural.html
===================================================================
--- html/podhtml/Pancutan/Test/Structural.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Test/Structural.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -87,7 +87,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Tests.html
===================================================================
--- html/podhtml/Pancutan/Tests.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Tests.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -181,7 +181,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/Pancutan/Util.html
===================================================================
--- html/podhtml/Pancutan/Util.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/Pancutan/Util.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -1,4 +1,4 @@
-Cannot find page `run_task' at L<> on line 258
+Cannot find page `run_task' at L<> on line 388
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
@@ -32,7 +32,7 @@
warnn("This is a warning!");
$result = execute("/bin/ls", "-l");
$result = mount($iso, $mount_point");
- $result = umount($iso, $mount_point");
+ $result = umount_all();
use Pancutan::Util qw(:queue);
queue_init();
@@ -56,10 +56,32 @@
<dd>
Execute a command, verifying it return status.
<dt class="POD_ITEM"><a name="mount_FILE_MOUNT_POI"><b>mount</b> FILE MOUNT_POINT</a>
-<dt><a name="umount_FILE_MOUNT_PO"><b>umount</b> FILE MOUNT_POINT</a>
<dd>
-Try to mount or unmount an ISO image, using the commands set in the
-configuration file.
+Try to mount an ISO image, using the method set in the configuration file.
+<dt class="POD_ITEM"><a name="umount_all"><b>umount_all</b></a>
+<dd>
+Unmounts all the files that were mounted by the current process. It should not be called by modules, as it's automatically invoked during cleanup on exit.
+<dt class="POD_ITEM"><a name="mktmpfile_TEMPLATE_S"><b>mktmpfile</b> TEMPLATE SUFFIX</a>
+<dt><a name="mktmpdir_TEMPLATE_ER"><b>mktmpdir</b> TEMPLATE ERASE_CONTENTS</a>
+<dt><a name="rmtmpfiles"><b>rmtmpfiles</b></a>
+<dt><a name="rmtmpdirs"><b>rmtmpdirs</b></a>
+<dd>
+These four routines handle the creation and destruction of temporary files and
+directories. The destruction routines should not be called by modules, as they
+are automatically invoked during cleanup on exit, and they only deal with files
+or directories created by the current process.
+<p class="POD_TEXT">
+The temporary files and directories will be created inside the global
+<b>temp_dir</b>, using the <i>File::Temp</i> functions. As such both routines take an
+optional <i>TEMPLATE</i> argument, with the same semantics as in said module. The
+optional <i>ERASE_CONTENTS</i> argument to <b>mktmpdir</b> specifies if the contents of
+the directory should be wiped upon destruction, using the <i>rmtree</i> routine
+from the <i>File::Path</i> module.
+</p>
+<p class="POD_TEXT">
+Like their <i>File::Temp</i> counterparts, <b>mktmpfile</b> returns a list of
+(<i>filehandle</i>, <i>filename</i>) and <b>mktmpdir</b> returns the directory name.
+</p>
<dt class="POD_ITEM"><a name="queue_init"><b>queue_init</b></a>
<dd>
Initialises the queue for parallel task management.
@@ -101,7 +123,7 @@
</p>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/index.html
===================================================================
--- html/podhtml/index.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/index.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -23,7 +23,7 @@
</table>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
Modified: html/podhtml/pancutan.html
===================================================================
--- html/podhtml/pancutan.html 2007-08-20 18:47:32 UTC (rev 75)
+++ html/podhtml/pancutan.html 2007-08-20 18:52:57 UTC (rev 76)
@@ -1,4 +1,4 @@
-Cannot find page `YAML' at L<> on line 254
+Cannot find page `YAML' at L<> on line 277
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
@@ -14,8 +14,9 @@
<ul>
<li><a class="POD_NAVLINK" href="#NAME">NAME</a>
<li><a class="POD_NAVLINK" href="#SYNOPSIS">SYNOPSIS</a>
+<li><a class="POD_NAVLINK" href="#DESCRIPTION">DESCRIPTION</a>
<li><a class="POD_NAVLINK" href="#OPTIONS">OPTIONS</a>
-<li><a class="POD_NAVLINK" href="#DESCRIPTION">DESCRIPTION</a>
+<li><a class="POD_NAVLINK" href="#CONFIGURATION">CONFIGURATION</a>
</ul>
<hr />
<h2 class="POD_HEAD1"><a name="NAME">NAME</a></h2>
@@ -26,7 +27,25 @@
<p class="POD_TEXT">
pancutan [options] <i>ISO_FILE</i> [<i>ISO_FILE</i> ...]
</p>
+<h2 class="POD_HEAD1"><a name="DESCRIPTION">DESCRIPTION</a></h2>
+<p class="POD_TEXT">
+<b>pancutan</b> runs automated tests on sets of CD images and reports errors in
+standard output. It expects debian-cd generated images, but it can operate on
+any ISO-9660 image, and even display some useful information.
+</p>
+<p class="POD_TEXT">
+To this end, each image is mounted with one of three different methods, which
+are described under <b>OPTIONS</b>, and then different tests are run on them. A
+fully modular architecture has been built to allow for easy development of new
+tests. The documentation that specifies the calling convention and result
+passing can be found in the <a class="POD_LINK" href="Pancutan/Tests.html">Pancutan::Tests</a> man page.
+</p>
<h2 class="POD_HEAD1"><a name="OPTIONS">OPTIONS</a></h2>
+<p class="POD_TEXT">
+Each file specified in the command line should be an ISO-9660 filesystem image
+or a block device where an ISO-9660 filesystem resides, <b>pancutan</b> will handle
+them automatically.
+</p>
<dl class="POD_LIST">
<dt class="POD_ITEM"><a name="_help"><b>--help</b></a>
<dd>
@@ -46,48 +65,62 @@
<dt class="POD_ITEM"><a name="_continue_on_fatal"><b>--continue-on-fatal</b></a>
<dd>
Continue testing after a fatal error
-<dt class="POD_ITEM"><a name="_tests_def_glob_GLOB"><b>--tests-def-glob</b> <i>GLOB</i></a>
+<dt class="POD_ITEM"><a name="_testdef_dir_DIR"><b>--testdef-dir</b> <i>DIR</i></a>
<dd>
-Glob for finding test defitions (default: "/usr/share/pancutan/tests/*.yaml")
+Directory containing test definitions (default: "/usr/share/pancutan/tests/")
<dt class="POD_ITEM"><a name="_temp_dir_DIR"><b>--temp-dir</b> <i>DIR</i></a>
<dd>
Temporary directory (default: ".pancutan.$$")
-</dl>
-<h2 class="POD_HEAD1"><a name="DESCRIPTION">DESCRIPTION</a></h2>
+<dt class="POD_ITEM"><a name="_mount_method_sudomo"><b>--mount-method</b> sudomount | fuseiso9660 | uml</a>
+<dd>
+Specifies which method to use for mounting the images, defaults to
+<b>sudomount</b>.
<p class="POD_TEXT">
-<b>pancutan</b> runs automated tests on sets of CD images and reports errors in
-standard output.
+<b>sudomount</b> uses the standard mount, calling sudo to gain root. It uses
+loopback devices when needed. It should be noted that for this to work
+correctly, you need the loop module installed with enough loop devices
+configured, e.g.:
</p>
+<pre class="POD_VERBATIM">
+ # modprobe loop max_loop=20
+</pre>
<p class="POD_TEXT">
-It's behaviour can be controlled by the command line or with a configuration
-file, located by default in <i>/etc/pancutan.conf</i>. This file follows <u>YAML</u>
-format, and allows the following parameters:
+<b>fuseiso9660</b> uses the FUSE module to mount filesystems without root
+privileges. Requires FUSE, fuseiso9660 and permissions to run it.
</p>
+<p class="POD_TEXT">
+<b>uml</b> runs the whole process inside an instance of user-mode-linux, and inside
+the virtual machine uses root privileges to execute mount as with <b>sudomount</b>.
+There is a problem when unmounting, as it should guess which loop device is
+being used, if it fails to correctly free it, the virtual machine can run out
+of free loop devices. Please report a bug if you find that the detection is not
+working correctly.
+</p>
+</dl>
+<h2 class="POD_HEAD1"><a name="CONFIGURATION">CONFIGURATION</a></h2>
+<p class="POD_TEXT">
+The behaviour of <b>pancutan</b> can be controlled by the command line or with a
+configuration file, located by default in <i>/etc/pancutan.conf</i>. This file
+follows <u>YAML</u> format, and allows the following parameters:
+</p>
<dl class="POD_LIST">
<dt class="POD_ITEM"><a name="concurrency"><b>concurrency</b></a>
<dt><a name="verbose"><b>verbose</b></a>
<dt><a name="continue_on_fatal"><b>continue_on_fatal</b></a>
-<dt><a name="tests_def_glob"><b>tests_def_glob</b></a>
+<dt><a name="testdef_dir"><b>testdef_dir</b></a>
<dt><a name="temp_dir"><b>temp_dir</b></a>
+<dt><a name="mount_method"><b>mount_method</b></a>
<dd>
These parameters are the same as in the command line.
-<dt class="POD_ITEM"><a name="mount_command"><b>mount_command</b></a>
-<dt><a name="unmount_command"><b>unmount_command</b></a>
+<dt class="POD_ITEM"><a name="uml_args"><b>uml_args</b></a>
<dd>
-Those two parameters allow to define the commands for mounting and unmounting
-each ISO image. They can contain two parameters: %file and %mntpnt, which are
-replaced with the ISO file and the mount point. The default values for those
-parameters are:
-<p class="POD_TEXT">
-mount_command: fuseiso9660 %file %mntpnt
-</p>
-<p class="POD_TEXT">
-unmount_command: fusermount -u %mntpnt
-</p>
+Allows to pass extra parameters to user-mode-linux. It should be an array ref
+of strings to be passed to exec(), or a string if it's onle one parameter.
+Defaults to <b>mem=64M</b>.
</dl>
<hr />
<a class="POD_NAVLINK" href="#Pod_TOP_OF_PAGE">[Top]</a>
-Generated by Marek::Pod::HTML 0.49 on Mon Aug 13 05:50:22 2007
+Generated by Marek::Pod::HTML 0.49 on Mon Aug 20 17:35:57 2007
</body>
</html>
More information about the Pancutan-commits
mailing list