guix-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] doc: Added some index entries.


From: Ludovic Courtès
Subject: Re: [PATCH] doc: Added some index entries.
Date: Wed, 09 Nov 2016 22:48:06 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux)

John Darrington <address@hidden> skribis:

> * doc/guix.texi: Added various @cindex tags to assist readers.

That’s a good idea, there were too few entries so far.

A general remark: please pay attention to spelling and case, like
“Guix”, “SSH”, etc.

> address@hidden installing guix
>  GNU Guix is available for download from its website at

“Guix”

> address@hidden installation guix from binaries

“installing Guix from binaries”

>  @item
> address@hidden authorized substitutes

Also:

  @cindex substitutes, authorization thereof

(I’ve just reread what the Texinfo manual has to say, and it’s always
enlightening (info "(texinfo) Index Entries").)

>  @item
> address@hidden substitutes
>  Installing @uref{http://gnutls.org/, GnuTLS-Guile} will allow you to
>  access @code{https} URLs for substitutes, which is highly recommended
>  (@pxref{Substitutes}).  It also allows you to access HTTPS URLs with the

This part doesn’t really talk about substitutes, not sure if it’s a good
idea to have an entry here.

> address@hidden nix

@cindex Nix, compatibility

>  @noindent
> address@hidden authorized substitutes
>  Each build machine must authorize the key of the master machine so that
>  it accepts store items it receives from the master:

This doesn’t talk about substitute authorization in general, so I
wouldn’t put this entry here.

> address@hidden installing packages
> address@hidden removing packages

Maybe also “package installation” and “package removal”.

>  @cindex security
>  @cindex digital signatures
> address@hidden authorized substitutes

Also @cindex substitutes, authorization thereof.

> address@hidden exporting

“exporting store items”

>  @item @code{initrd} (default: @code{base-initrd})
> address@hidden initrd

Also @cindex initial RAM disk.

>  @node User Accounts
>  @subsection User Accounts
>  
> address@hidden users

Also:
  @cindex user accounts
  @cindex accounts

> address@hidden tor

“Tor”

> address@hidden ssh

“SSH server”

> address@hidden ssh

Ditto.

OK with changes along these lines, thank you!

Ludo’.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]