diff mbox series

[bug#66577,2/4] doc: Mention Guix Home in “Getting Started”.

Message ID 2de53646c5355b42fec247780399fccb7c6a4f38.1697459606.git.ludo@gnu.org
State New
Headers show
Series Newcomer-oriented improvements to the manual and cookbook | expand

Commit Message

Ludovic Courtès Oct. 16, 2023, 12:43 p.m. UTC
* doc/guix.texi (Getting Started): Mention Guix Home.
(Home Configuration): Remove “still under development” note.
---
 doc/guix.texi | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

Comments

Simon Tournier Oct. 18, 2023, 4:19 p.m. UTC | #1
Hi Ludo,


On Mon, 16 Oct 2023 at 14:43, Ludovic Courtès <ludo@gnu.org> wrote:

>  @quotation Going further
>  @xref{Package Management}, for more about package management.  You may
>  like @dfn{declarative} package management with @command{guix package
> ---manifest}, managing separate @dfn{profiles} with @option{--profile},
> +--manifest},
>  deleting old generations, collecting garbage, and other nifty features
>  that will come in handy as you become more familiar with Guix.  If you
>  are a developer, @pxref{Development} for additional tools.  And if
>  you're curious, @pxref{Features}, to peek under the hood.

It is part of “Going further”, so I would let « managing separate
@dfn{profiles} with @option{--profile} ».  For what it is worth, I
recommend for some newcomer to still use a separated profile inside the
project folder, just aside the files manifest.scm and channels.scm.

I agree that “guix shell” is really cool now, but all the balance is the
duration of the project with the cache cleanup.

Well, this mention does not bother, IMHO, and it invites to know more
for the interested reader since it is “Going further”…

> +You can also manage the configuration of your entire @dfn{home
> +environment}---your user ``dot files'', services, and packages---using
> +Guix Home.  @xref{Home Configuration}, to learn more about it!
>  @end quotation

…I mean, similarly, Guix Home is not something I recommend for
newcomers.  But it is good to mention it in “Going further”. :-)


Cheers,
simon
Ludovic Courtès Oct. 24, 2023, 1:53 p.m. UTC | #2
Hi,

Simon Tournier <zimon.toutoune@gmail.com> skribis:

> On Mon, 16 Oct 2023 at 14:43, Ludovic Courtès <ludo@gnu.org> wrote:
>
>>  @quotation Going further
>>  @xref{Package Management}, for more about package management.  You may
>>  like @dfn{declarative} package management with @command{guix package
>> ---manifest}, managing separate @dfn{profiles} with @option{--profile},
>> +--manifest},
>>  deleting old generations, collecting garbage, and other nifty features
>>  that will come in handy as you become more familiar with Guix.  If you
>>  are a developer, @pxref{Development} for additional tools.  And if
>>  you're curious, @pxref{Features}, to peek under the hood.
>
> It is part of “Going further”, so I would let « managing separate
> @dfn{profiles} with @option{--profile} ».  For what it is worth, I
> recommend for some newcomer to still use a separated profile inside the
> project folder, just aside the files manifest.scm and channels.scm.

Yeah, I thought about concision and ‘--profile’ seemed less important
than “deleting old generations” etc.

Also, caching in ‘guix shell’ was designed to automate what one would do
manually with ‘-p’: registering the GC root, cleaning things up that are
unused.  The goal was to provide a simpler interface, which ideally also
means simpler onboarding.

Anyway, no strong opinion, so I’ve re-added the “managing separate
profiles” bit.

Thanks,
Ludo’.
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 8ebf50469e..f5d20873be 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -3069,11 +3069,15 @@  Getting Started
 @quotation Going further
 @xref{Package Management}, for more about package management.  You may
 like @dfn{declarative} package management with @command{guix package
---manifest}, managing separate @dfn{profiles} with @option{--profile},
+--manifest},
 deleting old generations, collecting garbage, and other nifty features
 that will come in handy as you become more familiar with Guix.  If you
 are a developer, @pxref{Development} for additional tools.  And if
 you're curious, @pxref{Features}, to peek under the hood.
+
+You can also manage the configuration of your entire @dfn{home
+environment}---your user ``dot files'', services, and packages---using
+Guix Home.  @xref{Home Configuration}, to learn more about it!
 @end quotation
 
 Once you've installed a set of packages, you will want to periodically
@@ -43036,12 +43040,6 @@  Home Configuration
 @c Maybe later, it will be possible to make home configuration a part of
 @c system configuration to make everything managed by guix system.
 
-@quotation Note
-The functionality described in this section is still under development
-and is subject to change.  Get in touch with us on
-@email{guix-devel@@gnu.org}!
-@end quotation
-
 The user's home environment usually consists of three basic parts:
 software, configuration, and state.  Software in mainstream distros are
 usually installed system-wide, but with GNU Guix most software packages