Re: 2 (possible) problems in documentation

[Mathieu Lirzin <mthl@gnu.org>]

[-- Attachment #1: Type: text/plain, Size: 1020 bytes --]

Hi,

Alex Vong <alexvong1995@gmail.com> writes:

> On 01/11/2015, Alex Kost <alezost@gmail.com> wrote:
>> I think this on-line manual is for the current version (0.8.3).  The
>> typo you mention was fixed in the git repo:
>> <http://git.savannah.gnu.org/cgit/guix.git/commit/?id=8fe5b1d1d1d188cbc6eb1b644fdc0d9fff255d4e>
>>
> Thanks! I wasn't aware that the web version not being up to date.

The online manual is up to date with the current release but not with
the master branch.  Maybe we could provide a link to it like Guile:

  https://www.gnu.org/software/guile/docs/docs.html

> What I mean is "guix pull" only works after Guix is installed, so what
> the documentation says, "To that end, all the command-line tools can
> be used even if you have not run make install", is inaccurate. Should
> we note this in the documentation?

I think you mean that ‘pre-inst-env guix pull’ does not work if you have
not run ‘make install’ before?  What do you think of the following
patch?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-Add-an-exception-in-Running-Guix-Before-It-Is-In.patch --]
[-- Type: text/x-diff, Size: 1285 bytes --]

From ee2f4467d84ad9516b14c7bd14f821e4bec443cc Mon Sep 17 00:00:00 2001
From: Mathieu Lirzin <mthl@gnu.org>
Date: Sun, 1 Nov 2015 16:27:07 +0100
Subject: [PATCH] doc: Add an exception in "Running Guix Before It Is
 Installed".

* doc/contributing.texi (Running Guix Before It Is Installed): Add an
  exception footnote for `guix pull'.

Suggested-by: Alex Vong <alexvong1995@gmail.com>
---
 doc/contributing.texi | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index f855daf..d033b1f 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -72,8 +72,9 @@ test the changes made in your local source tree checkout without
 actually installing them.  So that you can distinguish between your
 ``end-user'' hat and your ``motley'' costume.
 
-To that end, all the command-line tools can be used even if you have not
-run @code{make install}.  To do that, prefix each command with
+To that end, all the command-line tools@footnote{@code{guix pull} is an
+exception (@pxref{Invoking guix pull}).} can be used even if you have
+not run @code{make install}.  To do that, prefix each command with
 @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the
 top build tree of Guix), as in:
 
-- 
2.6.1


[-- Attachment #3: Type: text/plain, Size: 28 bytes --]


Thanks,

--
Mathieu Lirzin