From: Matt <matt@excalamus.com>
To: "Josselin Poiret" <dev@jpoiret.xyz>
Cc: "Maxim Cournoyer" <maxim.cournoyer@gmail.com>,
"Christian Miller" <christian.miller@dadoes.de>,
"guix-devel" <guix-devel@gnu.org>
Subject: Re: Feedback of the GNU Guix manual
Date: Wed, 21 Feb 2024 19:27:05 +0100 [thread overview]
Message-ID: <18dccebd9cd.10edff446211282.2752429425913724128@excalamus.com> (raw)
In-Reply-To: <87sf1pc1wd.fsf@jpoiret.xyz>
[-- Attachment #1: Type: text/plain, Size: 1914 bytes --]
---- On Sun, 18 Feb 2024 14:55:46 +0100 Josselin Poiret wrote ---
> Matt matt@excalamus.com> writes:
>
> > Specific mention of installing Guix's dependencies was removed. Guix being installed implies that its dependencies are also installed.
>
> I don't agree here: it's often the case in Linux-land that binary
> archives are provided without their dependencies included, assuming that
> the user already has them, often by installing them via their own
> package manager. Keeping the mention that it is self-contained and that
> the dependencies are also included might clarify the situation for some
> users.
Thank you for the feedback.
I opted for only "self-contained" which seems to imply that dependencies are available, in addition to other things, perhaps like setting an environment or pathing. If "self-contained" is distinct from "includes dependencies," we could append something like "...and includes all dependencies" to the last sentence.
I also tried to distinguish that it's the installation *process* which requires GNU-tar and Xz and not the final installation, since that's self-contained.
Otherwise, I tried to simplify the language:
- archived binaries -> a binary archive
- are often quicker -> often go faster
- which is described in the next sections -> described later
This version has fewer words and one more sentence. However, each sentence has a single, hopefully clear, point:
1. What this section is about? Installing from a binary archive.
2. Why you might want this section? It's faster than building.
3. What's needed? A Linux or Hurd-system with GNU-tar and Xz.
4. What do you get? A self-contained Guix installation.
Original: Region has 5 lines, 3 sentences, 51 words, and 301 characters
v2: Region has 5 lines, 4 sentences, 45 words, and 292 characters
If this is good, I can write up a commit message and format the change as a patch.
[-- Attachment #2: v2-0001-binary-installation.diff --]
[-- Type: application/octet-stream, Size: 1249 bytes --]
diff --git a/doc/guix.texi b/doc/guix.texi
index 9966a8e697..a5558300fa 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -732,14 +732,17 @@ ready to use it.
@cindex installing Guix from binaries
@cindex installer script
-This section describes how to install Guix on an arbitrary system from a
-self-contained tarball providing binaries for Guix and for all its
-dependencies. This is often quicker than installing from source, which
-is described in the next sections. The only requirement is to have
-GNU@tie{}tar and Xz.
+This section describes how to install Guix from a binary archive. Such
+installations often go faster than building from source, described
+later. Guix requires a Linux or Hurd-based system and unpacking the
+archive requires GNU@tie{}tar and Xz. The resulting installation is
+self-contained.
+
+@quotation Important
+This section only applies to systems without Guix. Following it for
+existing Guix installations will overwrite important system files.
@c Note duplicated from the ``Installation'' node.
-@quotation Note
We recommend the use of this
@uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh,
shell installer script}. The script automates the download, installation, and
next prev parent reply other threads:[~2024-02-21 20:45 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-14 15:01 Feedback of the GNU Guix manual Christian Miller
2024-01-15 17:52 ` Matt
2024-01-15 22:05 ` Christian Miller
2024-01-18 19:44 ` Maxim Cournoyer
2024-01-19 21:01 ` Matt
2024-01-26 23:59 ` Matt
2024-02-18 12:35 ` Matt
2024-02-18 13:55 ` Josselin Poiret
2024-02-21 18:27 ` Matt [this message]
2024-02-21 17:20 ` Maxim Cournoyer
2024-02-21 18:36 ` Matt
2024-02-23 2:46 ` Maxim Cournoyer
2024-02-23 18:37 ` Matt
2024-03-02 13:34 ` Matt
2024-03-06 17:15 ` doc: Removing much of Binary Installation (was: Feedback of the GNU Guix manual) pelzflorian (Florian Pelz)
2024-03-06 19:42 ` Matt
2024-03-06 20:52 ` doc: Removing much of Binary Installation Suhail Singh
2024-03-06 21:18 ` Suhail Singh
2024-03-07 17:03 ` pelzflorian (Florian Pelz)
2024-03-10 11:09 ` doc: installation: fix ~root confusion (was Re: doc: Removing much of Binary Installation) Matt
2024-03-10 20:42 ` Vagrant Cascadian
2024-03-10 23:21 ` Suhail Singh
2024-03-11 1:58 ` Vagrant Cascadian
2024-03-11 4:27 ` John Kehayias
2024-03-11 19:15 ` Vagrant Cascadian
2024-03-11 15:54 ` pelzflorian (Florian Pelz)
2024-03-16 10:47 ` Matt
2024-03-16 14:05 ` pelzflorian (Florian Pelz)
2024-03-17 17:34 ` Ludovic Courtès
2024-03-06 21:29 ` doc: Removing much of Binary Installation (was: Feedback of the GNU Guix manual) Vagrant Cascadian
2024-04-10 14:05 ` Fix grammar and markup (was " Matt
2024-04-11 12:59 ` Christian Miller
2024-04-12 14:41 ` pelzflorian (Florian Pelz)
2024-04-12 19:18 ` Matt
2024-04-13 12:02 ` pelzflorian (Florian Pelz)
2024-04-14 7:00 ` pelzflorian (Florian Pelz)
2024-04-19 14:09 ` Creating a documentation team? Ludovic Courtès
2024-04-19 15:32 ` Maxim Cournoyer
2024-04-19 17:32 ` pelzflorian (Florian Pelz)
2024-04-20 8:33 ` Matt
2024-05-01 20:34 ` Ludovic Courtès
2024-05-02 9:14 ` pelzflorian (Florian Pelz)
2024-04-12 20:16 ` Fix grammar and markup (was Re: Feedback of the GNU Guix manual) Ludovic Courtès
2024-04-13 8:22 ` Matt
2024-04-13 11:26 ` pelzflorian (Florian Pelz)
2024-04-14 14:50 ` Matt
2024-04-15 12:58 ` pelzflorian (Florian Pelz)
2024-04-15 18:39 ` Matt
2024-04-16 6:43 ` pelzflorian (Florian Pelz)
2024-04-18 17:15 ` Matt
2024-04-19 20:56 ` pelzflorian (Florian Pelz)
2024-04-20 8:36 ` Matt
2024-04-17 18:08 ` Maxim Cournoyer
2024-04-22 18:25 ` [PATCH] Fix typo (Re: " Matt
2024-04-22 22:43 ` pelzflorian (Florian Pelz)
2024-05-07 19:41 ` [PATCH] doc: Clarify need to update search paths on foreign distro (was " Matt
2024-05-07 20:41 ` Vagrant Cascadian
2024-05-10 9:57 ` Matt
2024-05-11 8:14 ` pelzflorian (Florian Pelz)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=18dccebd9cd.10edff446211282.2752429425913724128@excalamus.com \
--to=matt@excalamus.com \
--cc=christian.miller@dadoes.de \
--cc=dev@jpoiret.xyz \
--cc=guix-devel@gnu.org \
--cc=maxim.cournoyer@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).