aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Vong <alexvong1995@gmail.com>2015-11-02 23:34:16 +0800
committerLudovic Courtès <ludo@gnu.org>2015-11-03 09:56:48 +0100
commitef54b61dc6f67712c8a448b5fb17767b6b886ba4 (patch)
treeed7bf9070f49ad7c4a4714251bfad7a7f8b64353
parentdc57d527aee4eb18ec5fb345f90d6637bbd1a4d2 (diff)
downloadguix-ef54b61dc6f67712c8a448b5fb17767b6b886ba4.tar
guix-ef54b61dc6f67712c8a448b5fb17767b6b886ba4.tar.gz
doc: './pre-inst-env guix pull' won't upgrade local source tree.
* doc/contributing.texi (Running Guix Before It Is Installed): Clarify './pre-inst-env guix pull' won't upgrade local source tree. * doc/guix.texi (Invoking guix pull): Mention ~/.config/guix/latest. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
-rw-r--r--doc/contributing.texi5
-rw-r--r--doc/guix.texi4
2 files changed, 8 insertions, 1 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index f855daf2da..cdc3f6d2d7 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -116,6 +116,11 @@ $1 = 361
The @command{pre-inst-env} script sets up all the environment variables
necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}.
+Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade the
+local source tree; it simply updates the @file{~/.config/guix/latest}
+symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead if
+you want to upgrade your local source tree.
+
@node The Perfect Setup
@section The Perfect Setup
diff --git a/doc/guix.texi b/doc/guix.texi
index 3afa496ea3..836a0b4e0e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -1814,7 +1814,9 @@ On completion, @command{guix package} will use packages and package
versions from this just-retrieved copy of Guix. Not only that, but all
the Guix commands and Scheme modules will also be taken from that latest
version. New @command{guix} sub-commands added by the update also
-become available.
+become available@footnote{Under the hood, @command{guix pull} updates
+the @file{~/.config/guix/latest} symbolic link to point to the latest
+Guix, and the @command{guix} command loads code from there.}.
The @command{guix pull} command is usually invoked with no arguments,
but it supports the following options: