GNU bug report logs - #41565
[PATCH] doc: Use existing URLs and file names in installation instructions.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 41565 in the body.
You can then email your comments to 41565 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Julien Lepiller <julien <at> lepiller.eu>
To: guix-patches <at> gnu.org
Subject: [PATCH] doc: Use existing URLs and file names in installation
 instructions.
Date: Wed, 27 May 2020 17:30:13 +0200

[Message part 1 (text/plain, 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?

[0001-doc-Use-existing-URLs-and-file-names-in-installation.patch (text/x-patch, attachment)]

Message #8 received at 41565 <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: Julien Lepiller <julien <at> lepiller.eu>
Cc: 41565 <at> debbugs.gnu.org
Subject: Re: [bug#41565] [PATCH] doc: Use existing URLs and file names in
 installation instructions.
Date: Wed, 27 May 2020 17:50:41 +0200

[Message part 1 (text/plain, inline)]

Julien,

Julien Lepiller 写道：
> https://mastodon.social/@Nixfreak/104224784493287104

Sigh :-)

> 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.

I like it!

Kind regards,

T G-R

[signature.asc (application/pgp-signature, inline)]

Message #11 received at 41565 <at> debbugs.gnu.org (full text, mbox):

From: Leo Famulari <leo <at> famulari.name>
To: Julien Lepiller <julien <at> lepiller.eu>
Cc: 41565 <at> debbugs.gnu.org
Subject: Re: [bug#41565] [PATCH] doc: Use existing URLs and file names in
 installation instructions.
Date: Wed, 27 May 2020 13:17:30 -0400

On Wed, May 27, 2020 at 05:30:13PM +0200, Julien Lepiller wrote:
> 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.

I agree, it's a common mistake for new users. Your patch seems like the
right thing to do...

Message #14 received at 41565 <at> debbugs.gnu.org (full text, mbox):

From: Marius Bakke <marius <at> gnu.org>
To: Julien Lepiller <julien <at> lepiller.eu>, 41565 <at> debbugs.gnu.org
Subject: Re: [bug#41565] [PATCH] doc: Use existing URLs and file names in
 installation instructions.
Date: Wed, 27 May 2020 22:44:44 +0200

[Message part 1 (text/plain, inline)]

Julien Lepiller <julien <at> lepiller.eu> writes:

> Wdyt?

Sgtm.

[...]

> -@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
                                                       ^^^ stray 'x'

[signature.asc (application/pgp-signature, inline)]

Message #19 received at 41565-done <at> debbugs.gnu.org (full text, mbox):

From: Julien Lepiller <julien <at> lepiller.eu>
To: 41565-done <at> debbugs.gnu.org
Subject: Re: [bug#41565] [PATCH] doc: Use existing URLs and file names in
 installation instructions.
Date: Wed, 27 May 2020 23:29:11 +0200

Le Wed, 27 May 2020 22:44:44 +0200,
Marius Bakke <marius <at> gnu.org> a écrit :

> Julien Lepiller <julien <at> lepiller.eu> writes:
> 
> > Wdyt?  
> 
> Sgtm.
> 
> [...]
> 
> > -@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  
>                                                        ^^^ stray 'x'


Pushed as f18d5d75979f5374962c03a8f3c266054a489e11 with this fix, a
copyright line for me and an improved commit message.

Thank you!

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.