From 806b91f1040d75ca5331445272ecc46adac1c9ef Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Thu, 7 Apr 2005 08:17:04 +0000 Subject: [PATCH] * GC docs. --- doc/manual/nix-collect-garbage.xml | 92 ++++---------- doc/manual/nix-store.xml | 192 ++++++++++++++--------------- doc/manual/style.css | 5 - 3 files changed, 112 insertions(+), 177 deletions(-) diff --git a/doc/manual/nix-collect-garbage.xml b/doc/manual/nix-collect-garbage.xml index dc84cd803..3e4ab0925 100644 --- a/doc/manual/nix-collect-garbage.xml +++ b/doc/manual/nix-collect-garbage.xml @@ -1,77 +1,29 @@ - - nix-collect-garbage - remove unreachable store paths - + + + nix-collect-garbage + delete unreachable store paths + - - - nix-collect-garbage - - - - - age - - + + + nix-collect-garbage + + + + + + + + - - Description +Description - - The command nix-collect-garbage performs a - garbage collection on the Nix store: any paths in the Nix store - that are garbage (not reachable from a set of root store - expressions) are deleted. - +The command nix-collect-garbage is an +obsolete wrapper around nix-store +--gc. - - The roots of the garbage collector are the store expressions - mentioned in the files in the directory - prefix/var/nix/gcroots. - By default, the roots are all user environments in - prefix/var/nix/profiles. - You can register other store expressions as roots by writing the - full path of the store expression to an arbitrary file in the - gcroots directory (or a subdirectory - thereof). - + - - - - Options - - - - - / - - - These options cause the set of live or dead paths to be - printed, respectively, rather than performing an actual - garbage collector. They correspond exactly with the - sub-operations in nix-store - . - - - - - - - - - - Examples - - - To delete all unreachable paths, just do: - - -$ nix-collect-garbage - - - - - diff --git a/doc/manual/nix-store.xml b/doc/manual/nix-store.xml index 0ad0f32a5..ac803ce5f 100644 --- a/doc/manual/nix-store.xml +++ b/doc/manual/nix-store.xml @@ -146,126 +146,121 @@ output. - - Operation <option>--gc</option> +Operation <option>--gc</option> - - Synopsis - - nix-store - - - - - - - age - - +Synopsis - - Description + + nix-store + + + + + + + + + + + +Description - - Without additional flags, the operation - performs a garbage collection on the Nix store. That is, all - paths in the Nix store not reachable via file system - references from a set of roots, are deleted. - +Without additional flags, the operation +performs a garbage collection on the Nix store. That is, all paths in +the Nix store not reachable via file system references from a set of +roots, are deleted. - - The following flags may be specified: - +The following suboperations may be specified: - + - - - - - This operation prints on standard output the set of - roots used by the garbage collector. - - - + + + This operation prints on standard output the set + of roots used by the garbage collector. + + - - - - - This operation prints on standard output the set of - live store paths, which are all the store - paths reachable from the roots. Live paths should never - be deleted, since that would break consistency — it - would become possible that applications are installed - that reference things that are no longer present in the - store. - - - + + + This operation prints on standard output the set + of live store paths, which are all the store paths + reachable from the roots. Live paths should never be deleted, + since that would break consistency — it would become possible that + applications are installed that reference things that are no + longer present in the store. + + - - - - - This operation prints out on standard output the set of - dead store paths, which is just the - opposite of the set of live paths: any path in the store - that is not live (with respect to the roots) is dead. - - - + + + This operation prints out on standard output the + set of dead store paths, which is just the opposite + of the set of live paths: any path in the store that is not live + (with respect to the roots) is dead. + + - - - - - This operation performs an actual garbage collection. - All dead paths are removed from the store. - - - + + + This operation performs an actual garbage + collection. All dead paths are removed from the + store. This is the default. + + - + - - - - Roots + - The roots of the garbage collector are all store paths to - which there are symlinks in the - directory prefix/nix/var/nix/gcroots. - For instance, the following command makes the - path /nix/store/d718ef...-foo a root of - the collector: + +Roots + +The roots of the garbage collector are all store paths to which +there are symlinks in the directory +prefix/nix/var/nix/gcroots. +For instance, the following command makes the path +/nix/store/d718ef...-foo a root of the collector: $ ln -s /nix/store/d718ef...-foo /nix/var/nix/gcroots/bar - That is, after this command, the garbage collector will not - remove /nix/store/d718ef...-foo or any of - its dependencies. +That is, after this command, the garbage collector will not remove +/nix/store/d718ef...-foo or any of its +dependencies. - Subdirectories - of prefix/nix/var/nix/gcroots - are also searched for symlinks. Symlinks to non-store paths are - followed and searched for roots, but TODO. +Subdirectories of +prefix/nix/var/nix/gcroots +are also searched for symlinks. Symlinks to non-store paths are +followed and searched for roots, but TODO. - + - - Configuration file - TODO +Configuration file - +TODO - + + + +Examples + +To delete all unreachable paths, just do: + + +$ nix-store --gc + + + + + + + - + Operation <option>--query</option> @@ -586,10 +581,3 @@ x=`nix-store --query --normalise --force-realise /nix/store/bla.store` - - - diff --git a/doc/manual/style.css b/doc/manual/style.css index 544acb61e..533104229 100644 --- a/doc/manual/style.css +++ b/doc/manual/style.css @@ -230,8 +230,3 @@ table.productionset table.productionset { font-family: monospace; } - -a[href] { - text-decoration: none; - border-bottom: 1px dotted #005aa0; -}