diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/manual/manual.xml | 8 | ||||
| -rw-r--r-- | doc/manual/nix-pack-closure.xml | 82 | ||||
| -rw-r--r-- | doc/manual/nix-unpack-closure.xml | 42 | ||||
| -rw-r--r-- | doc/manual/release-notes.xml | 7 |
5 files changed, 7 insertions, 133 deletions
diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am index 1011ee7aa1b2..62a7e9bff410 100644 --- a/doc/manual/Makefile.am +++ b/doc/manual/Makefile.am @@ -14,7 +14,6 @@ XSLTPROC = $(xsltproc) $(xmlflags) \ man1_MANS = nix-env.1 nix-build.1 nix-store.1 nix-instantiate.1 \ nix-collect-garbage.1 nix-push.1 nix-pull.1 \ nix-prefetch-url.1 nix-channel.1 \ - nix-pack-closure.1 nix-unpack-closure.1 \ nix-install-package.1 nix-hash.1 nix-copy-closure.1 FIGURES = figures/user-environments.png diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml index d564b09d89a8..22e9f6afd84d 100644 --- a/doc/manual/manual.xml +++ b/doc/manual/manual.xml @@ -89,10 +89,6 @@ <title>nix-install-package</title> <xi:include href="nix-install-package.xml" /> </section> - <section xml:id="sec-nix-pack-closure"> - <title>nix-pack-closure</title> - <xi:include href="nix-pack-closure.xml" /> - </section> <section xml:id="sec-nix-prefetch-url"> <title>nix-prefetch-url</title> <xi:include href="nix-prefetch-url.xml" /> @@ -105,10 +101,6 @@ <title>nix-push</title> <xi:include href="nix-push.xml" /> </section> - <section xml:id="sec-nix-unpack-closure"> - <title>nix-unpack-closure</title> - <xi:include href="nix-unpack-closure.xml" /> - </section> </section> </appendix> diff --git a/doc/manual/nix-pack-closure.xml b/doc/manual/nix-pack-closure.xml deleted file mode 100644 index c11dacd26f54..000000000000 --- a/doc/manual/nix-pack-closure.xml +++ /dev/null @@ -1,82 +0,0 @@ -<refentry xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle>nix-pack-closure</refentrytitle> - <manvolnum>1</manvolnum> - <refmiscinfo class="source">Nix</refmiscinfo> - <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -</refmeta> - -<refnamediv> - <refname>nix-pack-closure</refname> - <refpurpose>pack the closure of a store path into a single file that - can be unpacked with - <command>nix-unpack-closure</command></refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nix-pack-closure</command> - <arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg> - </cmdsynopsis> -</refsynopsisdiv> - - -<refsection><title>Description</title> - -<para>The command <command>nix-pack-closure</command> packs the -contents of the store paths <replaceable>paths</replaceable> and -<emphasis>all their dependencies</emphasis> into a single file, which -is written to standard output. (That is, it -<emphasis>serialises</emphasis> <replaceable>paths</replaceable>.) -The output can then be unpacked into the Nix store of another machine -using <command>nix-unpack-closure</command>.</para> - -<para>Together, <command>nix-pack-closure</command> and -<command>nix-unpack-closure</command> provide a quick and easy way to -deploy a package to a different machine. However, as the output of -<command>nix-pack-closure</command> tends to be rather large (since it -contains all dependencies), it’s not very efficient. -<command>nix-push</command> and <command>nix-pull</command> are more -efficient, but are also a bit more cumbersome to use.</para> - -</refsection> - - -<refsection><title>Examples</title> - -<para>To copy some instance of Subversion with all its dependencies to -another machine: - -<screen> -$ nix-pack-closure /nix/store/hj232g1r...-subversion-1.3.0 > svn.closure - -<lineannotation>Copy <!-- !!! <filename> -->svn.closure to the remote machine, then on the remote machine do:</lineannotation> -$ nix-unpack-closure < svn.closure</screen> - -</para> - -<para>Copy the program <command>azureus</command> with all its -dependencies to the machine <literal>scratchy</literal>: - -<screen> -$ nix-pack-closure $(which azureus) | ssh scratchy nix-unpack-closure</screen> - -</para> - -<para>As a variation on the previous example, copy -<command>azureus</command>, and also install it in the user’s profile -on the target machine: - -<screen> -$ nix-pack-closure $(which azureus) | ssh scratchy 'nix-env -i $(nix-unpack-closure)'</screen> - -</para> - - -</refsection> - - -</refentry> diff --git a/doc/manual/nix-unpack-closure.xml b/doc/manual/nix-unpack-closure.xml deleted file mode 100644 index dce0d1db43fa..000000000000 --- a/doc/manual/nix-unpack-closure.xml +++ /dev/null @@ -1,42 +0,0 @@ -<refentry xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle>nix-unpack-closure</refentrytitle> - <manvolnum>1</manvolnum> - <refmiscinfo class="source">Nix</refmiscinfo> - <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -</refmeta> - -<refnamediv> - <refname>nix-unpack-closure</refname> - <refpurpose>unpack the closure of a store path created by <command>nix-pack-closure</command> into the Nix store</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nix-unpack-closure</command> - </cmdsynopsis> -</refsynopsisdiv> - - -<refsection><title>Description</title> - -<para>The command <command>nix-unpack-closure</command> unpacks the -closure of a set of store paths created by -<command>nix-pack-closure</command> into the local Nix store. The -closure is a single file read from standard input. See the -description of <command>nix-pack-closure</command> for details and -examples.</para> - -<para>The top-level paths in the closure (i.e., the paths passed to -the original <command>nix-pack-closure</command> call that created the -closure) are printed on standard output. These paths can be passed, -for instance, to <literal>nix-env -i</literal> to install them into a -user environment on the target machine.</para> - -</refsection> - - -</refentry> diff --git a/doc/manual/release-notes.xml b/doc/manual/release-notes.xml index 112ffabd7013..b64e2025c452 100644 --- a/doc/manual/release-notes.xml +++ b/doc/manual/release-notes.xml @@ -47,6 +47,13 @@ <listitem><para><command>nix-prefetch-url</command> now supports <literal>mirror://</literal> URLs.</para></listitem> + <listitem><para>Removed the commands + <command>nix-pack-closure</command> and + <command>nix-unpack-closure</command>. You can do almost the same + thing but much more efficiently by doing <literal>nix-store --export + $(nix-store -qR <replaceable>paths</replaceable>) > closure</literal> and + <literal>nix-store --import < closure</literal>.</para></listitem> + </itemizedlist> </section> |