04/04: doc: Explain that '--profile' expects a file name.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit cb3ee1c5070ad3b82491d7ba61fc120910427121
Author: Ludovic Courtès <address@hidden>
Date:   Mon Sep 23 12:26:59 2019 +0200

    doc: Explain that '--profile' expects a file name.
    
    * doc/guix.texi (Invoking guix package): Explain that the argument to
    --profile is a file name.
---
 doc/guix.texi | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index 4830f39..d3170bb 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