civodul pushed a commit to branch master
in repository guix.
commit 2fd345cdfdd45dd48c9392a26793e442d680968b
Author: Ludovic Courtès <l...@gnu.org>
Date: Tue May 15 22:26:05 2018 +0200
doc: Improve 'guix size' documentation.
Suggested by Martin Castillo <casti...@uni-bremen.de>.
Fixes <https://bugs.gnu.org/31456>.
* doc/guix.texi (Invoking guix size): Clarify that 'guix size' looks for
ungrafted packages. Clarify that it can be passed several package
specifications.
---
doc/guix.texi | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index a771ab7..2234d95 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -6905,7 +6905,8 @@ single output for a package that could easily be split
(@pxref{Packages
with Multiple Outputs}). Such are the typical issues that
@command{guix size} can highlight.
-The command can be passed a package specification such as @code{gcc@@4.8}
+The command can be passed one or more package specifications
+such as @code{gcc@@4.8}
or @code{guile:debug}, or a file name in the store. Consider this
example:
@@ -6941,13 +6942,16 @@ In this example, we see that the closure of Coreutils
weighs in at
large fraction of the closure is not a problem @i{per se} because it is
always available on the system anyway.)
-When the package passed to @command{guix size} is available in the
-store, @command{guix size} queries the daemon to determine its
+When the package(s) passed to @command{guix size} are available in the
+store@footnote{More precisely, @command{guix size} looks for the
+@emph{ungrafted} variant of the given package(s), as returned by
+@code{guix build @var{package} --no-grafts}. @xref{Security Updates},
+for information on grafts.}, @command{guix size} queries the daemon to
determine its
dependencies, and measures its size in the store, similar to @command{du
-ms --apparent-size} (@pxref{du invocation,,, coreutils, GNU
Coreutils}).
-When the given package is @emph{not} in the store, @command{guix size}
+When the given packages are @emph{not} in the store, @command{guix size}
reports information based on the available substitutes
(@pxref{Substitutes}). This makes it possible it to profile disk usage of
store items that are not even on disk, only available remotely.
