bug#35525: guix-manual proposals

[znavko]

Hello! Thank you for your corrections. I've discovered new mistakes in the Guix Manual:

;;09-05-2019
;; what is API@ ? is @ symbol necessary there?

#. type: Plain text
#: doc/guix.texi:3987
msgid "When combined with channels (@pxref{Channels}), inferiors provide a simple way to interact with a separate revision of Guix. For example, let's assume you want to install in your profile the current @code{guile} package, along with the @code{guile-json} as it existed in an older revision of Guix---perhaps because the newer @code{guile-json} has an incompatible API and you want to run your code against the old address@hidden To do that, you could write a manifest for use by @code{guix package --manifest} (@pxref{Invoking guix package}); in that manifest, you would create an inferior for that old Guix revision you care about, and you would look up the @code{guile-json} package in the inferior:"


;;09-05-2019
;; why '(as always!)@:'? is @ symbol necessary there?

#. type: Plain text
#: doc/guix.texi:3850
msgid "Note that the snippet above is (as always!)@: Scheme code; we use @code{cons} to add a channel the list of channels that the variable @code{%default-channels} is bound to (@pxref{Pairs, @code{cons} and lists,, guile, GNU Guile Reference Manual}). With this file in place, @command{guix pull} builds not only Guix but also the package modules from your own repository. The result in @file{~/.config/guix/current} is the union of Guix with your own package modules:"


;;09-05-2019
;; 'to' is missed here: 'to add a channel .. the list'
#. type: Plain text
#: doc/guix.texi:3850
msgid "Note that the snippet above is (as always!)@: Scheme code; we use @code{cons} to add a channel the list of channels that the variable @code{%default-channels} is bound to (@pxref{Pairs, @code{cons} and lists,, guile, GNU Guile Reference Manual}). With this file in place, @command{guix pull} builds not only Guix but also the package modules from your own repository. The result in @file{~/.config/guix/current} is the union of Guix with your own package modules:"




The word 'installed' is wrong:

#. type: itemx
#: doc/guix.texi:3011 doc/guix.texi:3024
#, no-wrap
msgid "-A address@hidden"

#. type: table
#: doc/guix.texi:3015 doc/guix.texi:3028
msgid ""
"List packages currently available in the distribution for this system "
"(@pxref{GNU Distribution}). When @var{regexp} is specified, list only "
"installed packages whose name matches @var{regexp}."

In my own as I see, it does not list installed but all available packages.


Please, inform me if these mistakes are not mistakes or when they will be corrected for I to be patient.




May 3, 2019 4:52 AM, address@hidden wrote:

These are my current suggestions:




Here GuixSD rests instead of Guix System:

#. type: Plain text
#: doc/guix.texi:2650
msgid ""
"If you are not using the Guix System Distribution, consider adding the "
"following lines to your @file{~/.bash_profile} (@pxref{Bash Startup Files,,, "
"bash, The GNU Bash Reference Manual}) so that newly-spawned shells get all "
"the right environment variable definitions:"


#. type: Plain text
#: doc/guix.texi:3140
msgid ""
"Substitutes from the official build farm are enabled by default when using "
"the Guix System Distribution (@pxref{GNU Distribution}). However, they are "
"disabled by default when using Guix on a foreign distribution, unless you "
"have explicitly enabled them via one of the recommended installation steps "
"(@pxref{Installation}). The following paragraphs describe how to enable or "
"disable substitutes for the official build farm; the same procedure can also "
"be used to enable substitutes for any other substitute server."



The word 'installed' is wrong:

#. type: itemx
#: doc/guix.texi:3011 doc/guix.texi:3024
#, no-wrap
msgid "-A address@hidden"

#. type: table
#: doc/guix.texi:3015 doc/guix.texi:3028
msgid ""
"List packages currently available in the distribution for this system "
"(@pxref{GNU Distribution}). When @var{regexp} is specified, list only "
"installed packages whose name matches @var{regexp}."

In my own as I see, it does not list installed but all available packages.




Here it is 'many types of fs', but only one mentioned as example:

#. type: Plain text
#: doc/guix.texi:2268
msgid ""
"Alternatively, you may use a swap file. For example, assuming that in the "
"new system you want to use the file @file{/swapfile} as a swap file, you "
"would address@hidden example will work for many types of file systems (e."
"g., ext4). However, for copy-on-write file systems (e.g., btrfs), the "
"required steps may be different. For details, see the manual pages for "
"@command{mkswap} and @command{swapon}.}:"




And also if another language is ready to use (Spanish), need to say it on:

#. type: Plain text
#: doc/guix.texi:117
msgid ""
"This manual is also available in French (@pxref{Top,,, guix.fr, Manuel de "
"référence de GNU Guix}) and German (@pxref{Top,,, guix.de, Referenzhandbuch "
"zu GNU Guix}). If you would like to translate it in your native language, "
"consider joining the @uref{https://translationproject.org/domain/guix-manual."
"html, Translation Project}."





May 2, 2019 9:43 PM, "Ludovic Courtès" <address@hidden> wrote:

Danny Milosavljevic <address@hidden> skribis:

as far as I can see, it's also wrong in the original in the manual.

doc/guix.texi:

@item address@hidden
@itemx -A address@hidden
List packages currently available in the distribution for this system
(@pxref{GNU Distribution}). When @var{regexp} is specified, list only
installed packages whose name matches @var{regexp}.
^^^^^^^^^ ??

Oops indeed! I guess you can push a fix. :-)

Ludo'.