From debbugs-submit-bounces@debbugs.gnu.org Wed May 27 11:30:34 2020 Received: (at submit) by debbugs.gnu.org; 27 May 2020 15:30:34 +0000 Received: from localhost ([127.0.0.1]:49810 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jdy0n-0003Hg-R0 for submit@debbugs.gnu.org; Wed, 27 May 2020 11:30:34 -0400 Received: from lists.gnu.org ([209.51.188.17]:54830) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jdy0l-0003HW-Cs for submit@debbugs.gnu.org; Wed, 27 May 2020 11:30:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50148) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jdy0l-00023z-6o for guix-patches@gnu.org; Wed, 27 May 2020 11:30:31 -0400 Received: from lepiller.eu ([2a00:5884:8208::1]:38712) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jdy0j-0004ew-CV for guix-patches@gnu.org; Wed, 27 May 2020 11:30:30 -0400 Received: from lepiller.eu (localhost [127.0.0.1]) by lepiller.eu (OpenSMTPD) with ESMTP id 901dcd66 for ; Wed, 27 May 2020 15:30:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=lepiller.eu; h=date:from :to:subject:message-id:mime-version:content-type; s=dkim; bh=T4A eurHFY730cve1u6prug6QbfBWbVON8RQtbwjz7pg=; b=SRsLiaxQPYEuFPUPmh/ f1ZDcH5IMAOJMQBatks3rkLbfoSM/ZQ0GGqQjiuhsIkrY+xGKTKc0/+i5OdYF804 7tYT75OImua1/whsxDBMu1GB1hFMqMJEYpS0aTiQm8BgJ6u16xSSq53igBkuDYz5 9sepmEUmyXmHuKwEOBCtfjl5Vmnf0wS5puLBmmNNIifnqZrs6T5+eWV1sM3RK5Qt Q/lCuNsHJIgBObIAuIut3PIy6+CeSr90Zbb4V1bkXitsqeioSdUPF5niFXGTVDD7 ET0m0NxlEamG81wxs18IRhcTLSZZkodMleUPvYyho039um8Xh9LhnP8S+pa47kmK ZpA== Received: by lepiller.eu (OpenSMTPD) with ESMTPSA id af3ea93e (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256:NO) for ; Wed, 27 May 2020 15:30:21 +0000 (UTC) Date: Wed, 27 May 2020 17:30:13 +0200 From: Julien Lepiller To: guix-patches@gnu.org Subject: [PATCH] doc: Use existing URLs and file names in installation instructions. Message-ID: <20200527173013.36a11a54@tachikoma.lepiller.eu> X-Mailer: Claws Mail 3.17.5 (GTK+ 2.24.32; x86_64-unknown-linux-gnu) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="MP_/UJ50M5TzkZNZGpWyA00xEhj" Received-SPF: none client-ip=2a00:5884:8208::1; envelope-from=julien@lepiller.eu; helo=lepiller.eu X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) --MP_/UJ50M5TzkZNZGpWyA00xEhj Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Content-Disposition: inline Some users seem to be confused by the fact that our URLs in the manual don't work for them. This is most likely because they copy them without reading the rest of the text which clearly says they should replace @var{system} with one of the supported values. One example of this confusion is this conversation: https://mastodon.social/@Nixfreak/104224784493287104 Since our current approach doesn't seem to be very effective, I propose to change the URLs and file names with actual ones, using x86_64-linux as the system because this is the most popular platform that we support nowadays. I keep mentioning the other architectures as alternatives, hoping that users will notice the x86_64 in the URL and keep reading to learn how to install Guix for another architecture if they want to. Wdyt? --MP_/UJ50M5TzkZNZGpWyA00xEhj Content-Type: text/x-patch Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename=0001-doc-Use-existing-URLs-and-file-names-in-installation.patch From 5be064d009e3e45029fe8c5b9a7cc0c8275bec50 Mon Sep 17 00:00:00 2001 From: Julien Lepiller Date: Wed, 27 May 2020 16:52:53 +0200 Subject: [PATCH] doc: Use existing URLs and file names in installation instructions. Some users are confused that these URLs and file names don't work, so change them to the most popular architecture, while still mentioning alternatives. * doc/guix.texi (USB Stick and DVD Installation): Use x86_64-linux URLs by default. --- doc/guix.texi | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 4dbbf96db9..695b0c4485 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -567,17 +567,18 @@ Installing goes along these lines: @item @cindex downloading Guix binary Download the binary tarball from -@indicateurl{@value{BASE-URL}/guix-binary-@value{VERSION}.@var{system}.tar.xz}, -where @var{system} is @code{x86_64-linux} for an @code{x86_64} machine -already running the kernel Linux, and so on. +@indicateurl{@value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz}, +where @code{x86_64-linux} can be replaced with @code{xi686-linux} for an +@code{i686} (32-bits) machine already running the kernel Linux, and so on +(@pxref{GNU Distribution}). @c The following is somewhat duplicated in ``System Installation''. Make sure to download the associated @file{.sig} file and to verify the authenticity of the tarball against it, along these lines: @example -$ wget @value{BASE-URL}/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig -$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig +$ wget @value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig +$ gpg --verify guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig @end example If that command fails because you do not have the required public key, @@ -603,7 +604,7 @@ you may have to run @code{su -} or @code{sudo -i}. As @code{root}, run: @example # cd /tmp # tar --warning=no-timestamp -xf \ - /path/to/guix-binary-@value{VERSION}.@var{system}.tar.xz + /path/to/guix-binary-@value{VERSION}.x86_64-linux.tar.xz # mv var/guix /var/ && mv gnu / @end example @@ -1917,8 +1918,8 @@ about their support in GNU/Linux. An ISO-9660 installation image that can be written to a USB stick or burnt to a DVD can be downloaded from -@indicateurl{@value{BASE-URL}/guix-system-install-@value{VERSION}.@var{system}.iso.xz}, -where @var{system} is one of: +@indicateurl{@value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.xz}, +where you can replace @code{x86_64-linux} with one of: @table @code @item x86_64-linux @@ -1933,8 +1934,8 @@ Make sure to download the associated @file{.sig} file and to verify the authenticity of the image against it, along these lines: @example -$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.@var{system}.iso.xz.sig -$ gpg --verify guix-system-install-@value{VERSION}.@var{system}.iso.xz.sig +$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.xz.sig +$ gpg --verify guix-system-install-@value{VERSION}.x86_64-linux.iso.xz.sig @end example If that command fails because you do not have the required public key, @@ -1965,7 +1966,7 @@ To copy the image to a USB stick, follow these steps: Decompress the image using the @command{xz} command: @example -xz -d guix-system-install-@value{VERSION}.@var{system}.iso.xz +xz -d guix-system-install-@value{VERSION}.x86_64-linux.iso.xz @end example @item @@ -1974,7 +1975,7 @@ its device name. Assuming that the USB stick is known as @file{/dev/sdX}, copy the image with: @example -dd if=guix-system-install-@value{VERSION}.@var{system}.iso of=/dev/sdX +dd if=guix-system-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX sync @end example @@ -1990,7 +1991,7 @@ To copy the image to a DVD, follow these steps: Decompress the image using the @command{xz} command: @example -xz -d guix-system-install-@value{VERSION}.@var{system}.iso.xz +xz -d guix-system-install-@value{VERSION}.x86_64-linux.iso.xz @end example @item @@ -1999,7 +2000,7 @@ its device name. Assuming that the DVD drive is known as @file{/dev/srX}, copy the image with: @example -growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.@var{system}.iso +growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.x86_64-linux.iso @end example Access to @file{/dev/srX} usually requires root privileges. -- 2.26.2 --MP_/UJ50M5TzkZNZGpWyA00xEhj--