Re: Contributing to the manual

[Gábor Boskovits]

Hello Quiliro,

Quiliro Ordonez  ezt írta (időpont: 2018. nov. 9., P, 6:29):
>
> I have read the manual almost completely. Here is a list of observations
> I have made. I can continue to report. The first few are just notes to
> definitions of terms such as "derivation", "input", "BAG", "implicit
> inputs", etc. But after that I mostly report errors on the manual. If am
> not sure how to change the manual or if my suggestions are acceptable.
> So please use these if they are appropiate or show me what to do about
> them.
>
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 93 | posición 1413 | Añadido el jueves, 11 de
> octubre de 2018 19:55:15
>
> Derivation
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 93 | posición 1411-1413 | Añadido el jueves,
> 11 de octubre de 2018 19:55:15
>
> A derivation is a low-level representation of the build actions to be
> taken, and the environment in which they should occur—derivations are to
> package definitions what assembly is to C programs. The term
> “derivation” comes from the fact that build results derive from them.
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 108 | posición 1642 | Añadido el domingo, 14 de
> octubre de 2018 7:28:57
>
> BAG
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 107 | posición 1640-1642 | Añadido el
> domingo, 14 de octubre de 2018 7:28:57
>
> bag is like a package, but with less ornamentation—in other words, a bag
> is a lower-level representation of a package, which includes all the
> inputs of that package, including some that were implicitly added by the
> build system.
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 110 | posición 1684 | Añadido el lunes, 15 de
> octubre de 2018 1:46:36
>
> implicit inputs
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 110 | posición 1684-1685 | Añadido el lunes,
> 15 de octubre de 2018 1:46:36
>
> implicit inputs of a package, because package definitions do not have to
> mention them.
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 101 | posición 1548 | Añadido el lunes, 15 de
> octubre de 2018 8:54:09
>
> inputs
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 101 | posición 1539-1548 | Añadido el lunes,
> 15 de octubre de 2018 8:54:10
>
> The distinction between native-inputs and inputs is necessary when
> considering cross-compilation. When cross-compiling, dependencies listed
> in inputs are built for the target architecture; conversely,
> dependencies listed in native-inputs are built for the architecture of
> the build machine. native-inputs is typically used to list tools needed
> at build time, but not at run time, such as Autoconf, Automake,
> pkg-config, Gettext, or Bison. guix lint can report likely mistakes in
> this area (see Invoking guix lint). Lastly, propagated-inputs is similar
> to inputs, but the specified packages will be automatically installed
> alongside the package they belong to (see guix package, for information
> on how guix package deals with propagated inputs.)
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 128 | posición 1958 | Añadido el lunes, 15 de
> octubre de 2018 15:05:40
>
> replace has with: produces
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 128 | posición 1958-1958 | Añadido el lunes,
> 15 de octubre de 2018 15:05:40
>
> A derivation contains the following pieces of information:
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 128 | posición 1958 | Añadido el lunes, 15 de
> octubre de 2018 15:06:15
>
> replace contains with: produces
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 128 | posición 1958 | Añadido el lunes, 15 de
> octubre de 2018 15:07:49
>
> unclear
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 176 | posición 2696 | Añadido el martes, 16 de
> octubre de 2018 17:18:01
>
> corregir
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 176 | posición 2696-2696 | Añadido el
> martes, 16 de octubre de 2018 17:18:01
>
> The command command below
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 178 | posición 2715 | Añadido el martes, 16 de
> octubre de 2018 17:21:57
>
> corregir
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 178 | posición 2715-2715 | Añadido el
> martes, 16 de octubre de 2018 17:21:57
>
> The command command below
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu nota en la página 194 | posición 2964 | Añadido el miércoles, 17 de
> octubre de 2018 17:00:19
>
> unclear because last column lacks label
> ==
> GNU Guix Reference Manual (Desconocido)
> - Tu subrayado en la página 194 | posi

Re: Contributing to the manual

[Quiliro Ordonez]

I have read the manual almost completely. Here is a list of observations
I have made. I can continue to report. The first few are just notes to
definitions of terms such as "derivation", "input", "BAG", "implicit
inputs", etc. But after that I mostly report errors on the manual. If am
not sure how to change the manual or if my suggestions are acceptable.
So please use these if they are appropiate or show me what to do about
them.

GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 93 | posición 1413 | Añadido el jueves, 11 de
octubre de 2018 19:55:15

Derivation
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 93 | posición 1411-1413 | Añadido el jueves,
11 de octubre de 2018 19:55:15

A derivation is a low-level representation of the build actions to be
taken, and the environment in which they should occur—derivations are to
package definitions what assembly is to C programs. The term
“derivation” comes from the fact that build results derive from them.
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 108 | posición 1642 | Añadido el domingo, 14 de
octubre de 2018 7:28:57

BAG
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 107 | posición 1640-1642 | Añadido el
domingo, 14 de octubre de 2018 7:28:57

bag is like a package, but with less ornamentation—in other words, a bag
is a lower-level representation of a package, which includes all the
inputs of that package, including some that were implicitly added by the
build system.
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 110 | posición 1684 | Añadido el lunes, 15 de
octubre de 2018 1:46:36

implicit inputs
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 110 | posición 1684-1685 | Añadido el lunes,
15 de octubre de 2018 1:46:36

implicit inputs of a package, because package definitions do not have to
mention them.
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 101 | posición 1548 | Añadido el lunes, 15 de
octubre de 2018 8:54:09

inputs
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 101 | posición 1539-1548 | Añadido el lunes,
15 de octubre de 2018 8:54:10

The distinction between native-inputs and inputs is necessary when
considering cross-compilation. When cross-compiling, dependencies listed
in inputs are built for the target architecture; conversely,
dependencies listed in native-inputs are built for the architecture of
the build machine. native-inputs is typically used to list tools needed
at build time, but not at run time, such as Autoconf, Automake,
pkg-config, Gettext, or Bison. guix lint can report likely mistakes in
this area (see Invoking guix lint). Lastly, propagated-inputs is similar
to inputs, but the specified packages will be automatically installed
alongside the package they belong to (see guix package, for information
on how guix package deals with propagated inputs.)
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 128 | posición 1958 | Añadido el lunes, 15 de
octubre de 2018 15:05:40

replace has with: produces
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 128 | posición 1958-1958 | Añadido el lunes,
15 de octubre de 2018 15:05:40

A derivation contains the following pieces of information:
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 128 | posición 1958 | Añadido el lunes, 15 de
octubre de 2018 15:06:15

replace contains with: produces
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 128 | posición 1958 | Añadido el lunes, 15 de
octubre de 2018 15:07:49

unclear
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 176 | posición 2696 | Añadido el martes, 16 de
octubre de 2018 17:18:01

corregir
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 176 | posición 2696-2696 | Añadido el
martes, 16 de octubre de 2018 17:18:01

The command command below
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 178 | posición 2715 | Añadido el martes, 16 de
octubre de 2018 17:21:57

corregir
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 178 | posición 2715-2715 | Añadido el
martes, 16 de octubre de 2018 17:21:57

The command command below
==
GNU Guix Reference Manual (Desconocido)
- Tu nota en la página 194 | posición 2964 | Añadido el miércoles, 17 de
octubre de 2018 17:00:19

unclear because last column lacks label
==
GNU Guix Reference Manual (Desconocido)
- Tu subrayado en la página 194 | posición 2962-2964 | Añadido el
miércoles, 17 de octubre de 2018 17:00:19

The first column, labeled “total”, shows the size in mebibytes (MiB) of
the closure of the store item—that is, its own size plus the size of all
its dependencies. The next column, labeled “self”, shows the size of the
item itself. The last column s

Contributing to the manual

[Ludovic Courtès]

Hello!

Quiliro  skribis:

> El Sun, 21 May 2017 13:43:02 +0200
> Fox  escribió:
>
>> Adonay Felipe Nogueira wrote:
>> > 
>> > Whenever possible, plase avoid duplicating efforts.
>> > 
>> > Happy hacking! :)
>> 
>> 
>> yup, duplicated efforts are not cogent nor expedient. Everything of 
>> importance ought to be part of the original GNUsite.
>
> How to contribute to the main site then?

The manual of Guix, a copy of which can be seen at
, is maintained in Guix itself:

  https://git.savannah.gnu.org/cgit/guix.git/tree/doc/guix.texi#n264

It is written in Texinfo, which is a lightweight markup language.

We definitely welcome improvements to the manual!  Before adding
something to the manual, please make sure it’s not already there ;-),
and make sure that what you add is properly integrated and linked to the
rest of the manual.

Once you’re done, you can submit a patch in the usual way:

  https://www.gnu.org/software/guix/manual/html_node/Submitting-Patches.html

Ludo’.