summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2015-02-23 23:28:58 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2015-02-23 23:28:58 +0000
commitfe1f70d5f729e331facf481ec45cc1c64e095d85 (patch)
tree54ecbfa97635cf15f1e7b1cbd8eae33939ad1747 /doc
parent1a193920ece5297d8676afef5b1e69e785522ad3 (diff)
downloads6-portable-utils-fe1f70d5f729e331facf481ec45cc1c64e095d85.tar.xz
Add s6-hiercopy (based on skalibs)v2.0.2.0
Version: rc for 2.0.2.0
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html6
-rw-r--r--doc/s6-hiercopy.html66
-rw-r--r--doc/upgrade.html8
3 files changed, 78 insertions, 2 deletions
diff --git a/doc/index.html b/doc/index.html
index 5d00821..95b4372 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -60,7 +60,9 @@ the package is now used to host specific utilities such as
<li> A POSIX-compliant system with a standard C development environment </li>
<li> GNU make, version 4.0 or later </li>
<li> <a href="http://skarnet.org/software/skalibs/">skalibs</a> version
-2.2.0.0 or later </li>
+2.3.1.0 or later. It's a build-time requirement. It's also a run-time
+requirement if you link against the shared version of the skalibs
+library. </li>
</ul>
<h3> Licensing </h3>
@@ -74,7 +76,7 @@ the package is now used to host specific utilities such as
<ul>
<li> The current released version of s6-portable-utils is
-<a href="s6-portable-utils-2.0.1.0.tar.gz">2.0.1.0</a>. </li>
+<a href="s6-portable-utils-2.0.2.0.tar.gz">2.0.2.0</a>. </li>
<li> Alternatively, you can checkout a copy of the s6-portable-utils git repository:
<pre> git clone git://git.skarnet.org/s6-portable-utils </pre> </li>
</ul>
diff --git a/doc/s6-hiercopy.html b/doc/s6-hiercopy.html
new file mode 100644
index 0000000..a4c12f0
--- /dev/null
+++ b/doc/s6-hiercopy.html
@@ -0,0 +1,66 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>s6-portable-utils: the s6-hiercopy program</title>
+ <meta name="Description" content="s6-portable-utils: the s6-hiercopy program" />
+ <meta name="Keywords" content="s6 linux administration root utilities hiercopy cp -a" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">s6-portable-utils</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>s6-hiercopy</tt> program </h1>
+
+<p>
+<tt>s6-hiercopy</tt> copies a directory structure recursively.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ s6-hiercopy <em>source</em> <em>destination</em>
+</pre>
+
+<ul>
+ <li> <tt>s6-hiercopy</tt> recursively copies <em>source</em> to
+<em>destination</em>, which is created if it doesn't exist.
+The permissions are preserved. The owner and group are preserved
+if the user is the superuser. </li>
+ <li> It exits 0 on success and 111 on temporary failure. </li>
+</ul>
+
+<h2> Notes </h2>
+
+<ul>
+ <li> Copying files and browsing through directories is one of Unix's
+weakest points, and <tt>s6-hiercopy</tt> is not meant to work around
+the problem; it's only a quick hack that I needed to boot my embedded
+platform. I originally planned to write the ultimate <tt>cp</tt> utility,
+portable and reliable and featureful and everything - while needing
+approximately a hundred times less resources than GNU <tt>cp</tt> does,
+of course. But I eventually dropped the idea: it's impossible to
+design, much less write, such a utility. Notably,
+ you cannot make it reliable because Unix's set of filesystem
+management primitives is just too weak. It lacks a lot of atomic
+operations, and filesystem transactions. As a result, <tt>s6-hiercopy</tt>
+is a walking race condition and should <strong>absolutely not</strong>
+be considered instant when used in a multitasking environment.
+But then, <tt>cp</tt> shouldn't either. </li>
+ <li> There is no standard way of creating device nodes on a
+filesystem, so any <tt>cp</tt>-like utility is inherently
+non-portable. Fortunately, most systems still agree on the non-portable usages of
+<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/mknod.html">mknod
+specification</a>, so things should work in practice. Consequently,
+the s6-hiercopy utility has been moved from
+<a href="http://skarnet.org/software/s6-linux-utils/">s6-linux-utils</a>
+to s6-portable-utils. </li>
+</ul>
+
+</body>
+</html>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 70d8b07..26bb1a8 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -17,6 +17,14 @@
<h1> What has changed in s6-portable-utils </h1>
+<h2> in 2.0.2.0 </h2>
+
+<ul>
+ <li> skalibs dependency bumped to 2.3.1.0. </li>
+ <li> s6-hiercopy now belongs to this package. (It formely belonged
+to s6-linux-utils, but it is actually portable in practice.) </li>
+</ul>
+
<h2> in 2.0.1.0 </h2>
<ul>