summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2019-09-23 12:26:59 +0200
committerLudovic Courtès <ludo@gnu.org>2019-09-23 12:26:59 +0200
commitcb3ee1c5070ad3b82491d7ba61fc120910427121 (patch)
treed861117335ef654b2590a33e5bec9a0eb3238c29
parent9338cbdbe04f1e2cacd593e3632a111687ffabf5 (diff)
doc: Explain that '--profile' expects a file name.
* doc/guix.texi (Invoking guix package): Explain that the argument to --profile is a file name.
-rw-r--r--doc/guix.texi19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 4830f39cdb..d3170bb46e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -2918,6 +2918,25 @@ variable, even though, taken individually, neither @file{foo} nor
@itemx -p @var{profile}
Use @var{profile} instead of the user's default profile.
+@var{profile} must be the name of a file that will be created upon
+completion. Concretely, @var{profile} will be a mere symbolic link
+(``symlink'') pointing to the actual profile where packages are
+installed:
+
+@example
+$ guix install hello -p ~/code/my-profile
+@dots{}
+$ ~/code/my-profile/bin/hello
+Hello, world!
+@end example
+
+All it takes to get rid of the profile is to remove this symlink and its
+siblings that point to specific generations:
+
+@example
+$ rm ~/code/my-profile ~/code/my-profile-*-link
+@end example
+
@cindex collisions, in a profile
@cindex colliding packages in profiles
@cindex profile collisions