bug#35525: guix-manual proposals

bug#35525: guix-manual proposals

[znavko]

[-- Attachment #1: Type: text/plain, Size: 1732 bytes --]

Hello! 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 run@footnote{This 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}.}:"
Also, writing configuration step is not so easy when using manual installation. I think, there also should be a message with link to 'Graphical Installation', that you can use graphical installation that will generate configuration you need automatically.

#. type: Plain text
#: doc/guix.texi:2315
msgid ""
"@xref{Using the Configuration System}, for an overview of the configuration "
"file. The example configurations discussed in that section are available "
"under @file{/etc/configuration} in the installation image. Thus, to get "
"started with a system configuration providing a graphical display server (a "
"``desktop'' system), you can run something along these lines:"

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

[-- Attachment #2: Type: text/html, Size: 2053 bytes --]

bug#35525: guix-manual proposals

[znavko]

[-- Attachment #1: Type: text/plain, Size: 4417 bytes --]

Also 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:"
And this text is English-specific, lacks its features in another language, words 'force a local build' and 'challenge providers' in Russian has no direct translations:

#. type: Plain text
#: doc/guix.texi:2589 doc/guix.texi:2582
msgid ""
"This foundation allows Guix to support @dfn{transparent binary/source "
"deployment}. When a pre-built binary for a @file{/gnu/store} item is "
"available from an external source---a @dfn{substitute}, Guix just downloads "
"it and unpacks it; otherwise, it builds the package from source, locally "
"(@pxref{Substitutes}). Because build results are usually bit-for-bit "
"reproducible, users do not have to trust servers that provide substitutes: "
"they can force a local build and @emph{challenge} providers (@pxref{Invoking "
"guix challenge})."
msgstr "Эта концепция позволяет Guix поддерживать @dfn{прозрачное внедрение бинарников/исходников}. Когда доступен элемент @file{/gnu/store}, собранный заранее на внешнем источнике, то есть готова @dfn{подстановка}, Guix просто скачивает и распаковывает его. В противном случае он собирает пакет из исходников на локальной машине (@pxref{Substitutes}). Так как результаты сборки обычно воспроизводимы бит-к-биту, пользователи не должны доверять серверам, которые поставляют подстановки --- они могут целенаправленно запросить локальную сборку и @emph{не пользоваться} серверами подстановки (@pxref{Invoking guix challenge})."

force a local build  - Russian equivalent can be only 'purposely ask local build'
challenge providers - in Russian we do not have such idea (as some others equivalents of words too), so I've translated exactly 'do not use substitute servers'

I think this text may be simplified and extended a bit.
May 1, 2019 4:00 PM, znavko@disroot.org (mailto:znavko@disroot.org) wrote:
Hello! 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 run@footnote{This 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}.}:"
Also, writing configuration step is not so easy when using manual installation. I think, there also should be a message with link to 'Graphical Installation', that you can use graphical installation that will generate configuration you need automatically.

#. type: Plain text
#: doc/guix.texi:2315
msgid ""
"@xref{Using the Configuration System}, for an overview of the configuration "
"file. The example configurations discussed in that section are available "
"under @file{/etc/configuration} in the installation image. Thus, to get "
"started with a system configuration providing a graphical display server (a "
"``desktop'' system), you can run something along these lines:"

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 (https://translationproject.org/domain/guix-manual)."
"html, Translation Project}."

[-- Attachment #2: Type: text/html, Size: 5089 bytes --]

bug#35525: guix-manual proposals

[znavko]

[-- Attachment #1: Type: text/plain, Size: 4988 bytes --]

I think here the word 'installed' is wrong:

#. type: itemx
#: doc/guix.texi:3011 doc/guix.texi:3024
#, no-wrap
msgid "-A [@var{regexp}]"

#. 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.
May 1, 2019 6:04 PM, znavko@disroot.org (mailto:znavko@disroot.org) wrote:
Also 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:"
And this text is English-specific, lacks its features in another language, words 'force a local build' and 'challenge providers' in Russian has no direct translations:

#. type: Plain text
#: doc/guix.texi:2589 doc/guix.texi:2582
msgid ""
"This foundation allows Guix to support @dfn{transparent binary/source "
"deployment}. When a pre-built binary for a @file{/gnu/store} item is "
"available from an external source---a @dfn{substitute}, Guix just downloads "
"it and unpacks it; otherwise, it builds the package from source, locally "
"(@pxref{Substitutes}). Because build results are usually bit-for-bit "
"reproducible, users do not have to trust servers that provide substitutes: "
"they can force a local build and @emph{challenge} providers (@pxref{Invoking "
"guix challenge})."
msgstr "Эта концепция позволяет Guix поддерживать @dfn{прозрачное внедрение бинарников/исходников}. Когда доступен элемент @file{/gnu/store}, собранный заранее на внешнем источнике, то есть готова @dfn{подстановка}, Guix просто скачивает и распаковывает его. В противном случае он собирает пакет из исходников на локальной машине (@pxref{Substitutes}). Так как результаты сборки обычно воспроизводимы бит-к-биту, пользователи не должны доверять серверам, которые поставляют подстановки --- они могут целенаправленно запросить локальную сборку и @emph{не пользоваться} серверами подстановки (@pxref{Invoking guix challenge})."

force a local build  - Russian equivalent can be only 'purposely ask local build'
challenge providers - in Russian we do not have such idea (as some others equivalents of words too), so I've translated exactly 'do not use substitute servers'

I think this text may be simplified and extended a bit.
May 1, 2019 4:00 PM, znavko@disroot.org (mailto:znavko@disroot.org) wrote:
Hello! 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 run@footnote{This 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}.}:"
Also, writing configuration step is not so easy when using manual installation. I think, there also should be a message with link to 'Graphical Installation', that you can use graphical installation that will generate configuration you need automatically.

#. type: Plain text
#: doc/guix.texi:2315
msgid ""
"@xref{Using the Configuration System}, for an overview of the configuration "
"file. The example configurations discussed in that section are available "
"under @file{/etc/configuration} in the installation image. Thus, to get "
"started with a system configuration providing a graphical display server (a "
"``desktop'' system), you can run something along these lines:"

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 (https://translationproject.org/domain/guix-manual)."
"html, Translation Project}."

[-- Attachment #2: Type: text/html, Size: 5995 bytes --]

bug#35525: guix-manual proposals

[Ludovic Courtès]

Hi znavko,

We do not handle translations here.  Please contact directly the
relevant team at the Translation Project:

  https://translationproject.org/domain/guix-manual.html

Thanks,
Ludo’.

bug#35525: guix-manual proposals

[Danny Milosavljevic]

[-- Attachment #1: Type: text/plain, Size: 376 bytes --]

Hi Ludo,

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

doc/guix.texi:

@item --list-available[=@var{regexp}]
@itemx -A [@var{regexp}]
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}.
^^^^^^^^^ ??

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

bug#35525: guix-manual proposals

[Ludovic Courtès]

Danny Milosavljevic <dannym@scratchpost.org> skribis:

> as far as I can see, it's also wrong in the original in the manual.
>
> doc/guix.texi:
>
> @item --list-available[=@var{regexp}]
> @itemx -A [@var{regexp}]
> 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'.

bug#35525: guix-manual proposals

[znavko]

[-- Attachment #1: Type: text/plain, Size: 3121 bytes --]

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 [@var{regexp}]"

#. 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 run@footnote{This 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" <ludo@gnu.org (mailto:ludo@gnu.org)> wrote:
 Danny Milosavljevic <dannym@scratchpost.org (mailto:dannym@scratchpost.org)> skribis:
 as far as I can see, it's also wrong in the original in the manual.

doc/guix.texi:

@item --list-available[=@var{regexp}]
@itemx -A [@var{regexp}]
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'.

[-- Attachment #2: Type: text/html, Size: 3750 bytes --]

bug#35525: guix-manual proposals

[znavko]

[-- Attachment #1: Type: text/plain, Size: 5911 bytes --]

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 API@. 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 [@var{regexp}]"

#. 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, znavko@disroot.org (mailto:znavko@disroot.org) 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 [@var{regexp}]"

#. 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 run@footnote{This 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 (https://translationproject.org/domain/guix-manual)."
"html, Translation Project}."
May 2, 2019 9:43 PM, "Ludovic Courtès" <ludo@gnu.org (mailto:ludo@gnu.org)> wrote:

 Danny Milosavljevic <dannym@scratchpost.org (mailto:dannym@scratchpost.org)> skribis:as far as I can see, it's also wrong in the original in the manual.

doc/guix.texi:

@item --list-available[=@var{regexp}]
@itemx -A [@var{regexp}]
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'.

[-- Attachment #2: Type: text/html, Size: 6975 bytes --]