[PATCH 0/2] Clarify VM installation instructions

[PATCH 0/2] Clarify VM installation instructions

[Leo Famulari]

There is a subtle confuser in the instructions about installing GuixSD
in a VM. I missed it the first time it was pointed out to me, because I
already knew how to install GuixSD. But if you begin with Guix by
installing GuixSD in a VM, this might waste a few minutes of your time.

The instructions start with "First, retrieve the GuixSD installation
image as described previously (see USB Stick Installation)." [0]

You go to USB Stick Installation, where it explains how to download the
image file and check the signature. [1] It continues to explain how to put
it on a USB stick, but you aren't doing that, so you go back to the VM
installation instructions and try booting the xz-compressed tarball.

The reader has not read the part about decompressing the tarball,
because that is under "To copy the image to a USB stick, follow these
steps[...]"

I've helped one person who made this mistake, and I can see how you'd
make it if you were a beginner.

[0]
https://www.gnu.org/software/guix/manual/html_node/Installing-GuixSD-in-a-VM.html

[1]
https://www.gnu.org/software/guix/manual/html_node/USB-Stick-Installation.html


Leo Famulari (1):
  doc: Clarify "Installing GuixSD in a VM".

 doc/guix.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.11.0

[PATCH 1/1] doc: Clarify "Installing GuixSD in a VM".

[Leo Famulari]

* doc/guix.texi (Installing GuixSD in a VM): Mention decompressing the
installation image.
---
 doc/guix.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index cb203fca2..bff1d03c6 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7119,8 +7119,8 @@ disk image, follow these steps:
 
 @enumerate
 @item
-First, retrieve the GuixSD installation image as described previously
-(@pxref{USB Stick Installation}).
+First, retrieve and decompress the GuixSD installation image as
+described previously (@pxref{USB Stick Installation}).
 
 @item
 Create a disk image that will hold the installed system.  To make a
-- 
2.11.0

Re: [PATCH 1/1] doc: Clarify "Installing GuixSD in a VM".

[Marius Bakke]

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

Leo Famulari <leo@famulari.name> writes:

> * doc/guix.texi (Installing GuixSD in a VM): Mention decompressing the
> installation image.
> ---
>  doc/guix.texi | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index cb203fca2..bff1d03c6 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -7119,8 +7119,8 @@ disk image, follow these steps:
>  
>  @enumerate
>  @item
> -First, retrieve the GuixSD installation image as described previously
> -(@pxref{USB Stick Installation}).
> +First, retrieve and decompress the GuixSD installation image as
> +described previously (@pxref{USB Stick Installation}).

LGTM, thanks!

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 487 bytes --]