From mboxrd@z Thu Jan 1 00:00:00 1970 From: znavko@disroot.org Subject: bug#35525: guix-manual proposals Date: Thu, 09 May 2019 19:12:31 +0000 Message-ID: <6fc33b228dc5956eb23e82e6bcc6c49d@disroot.org> References: <87h8acsfbm.fsf@gnu.org> <2530df52d53c8ac976ce37ed854b509a@disroot.org> <87tvecubi7.fsf@gnu.org> <20190502173714.2cb399c3@scratchpost.org> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="--=_RainLoop_224_431844835.1557429151" Return-path: Received: from eggs.gnu.org ([209.51.188.92]:51195) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hOoTb-0001VD-8Y for bug-guix@gnu.org; Thu, 09 May 2019 15:13:09 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hOoTY-0004PQ-0f for bug-guix@gnu.org; Thu, 09 May 2019 15:13:07 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:51143) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hOoTX-0004PM-U7 for bug-guix@gnu.org; Thu, 09 May 2019 15:13:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hOoTX-0004yU-JI for bug-guix@gnu.org; Thu, 09 May 2019 15:13:03 -0400 Sender: "Debbugs-submit" Resent-Message-ID: In-Reply-To: List-Id: Bug reports for GNU Guix List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-guix-bounces+gcggb-bug-guix=m.gmane.org@gnu.org Sender: "bug-Guix" To: Ludovic =?UTF-8?Q?Court=C3=A8s?= , Danny Milosavljevic Cc: 35525-done@debbugs.gnu.org ----=_RainLoop_224_431844835.1557429151 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Hello! Thank you for your corrections. I've discovered new mistakes in th= e Guix Manual:=0A=0A;;09-05-2019=0A;; what is API@ ? is @ symbol necessar= y there?=0A=0A#. type: Plain text=0A#: doc/guix.texi:3987=0Amsgid "When c= ombined with channels (@pxref{Channels}), inferiors provide a simple way = to interact with a separate revision of Guix. For example, let's assume y= ou want to install in your profile the current @code{guile} package, alon= g 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 wri= te a manifest for use by @code{guix package --manifest} (@pxref{Invoking = guix package}); in that manifest, you would create an inferior for that o= ld Guix revision you care about, and you would look up the @code{guile-js= on} package in the inferior:"=0A;;09-05-2019=0A;; why '(as always!)@:'? i= s @ symbol necessary there?=0A=0A#. type: Plain text=0A#: doc/guix.texi:3= 850=0Amsgid "Note that the snippet above is (as always!)@: Scheme code; w= e 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 list= s,, guile, GNU Guile Reference Manual}). With this file in place, @comman= d{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:"=0A;;09-05-2019=0A;; 'to' is misse= d here: 'to add a channel .. the list'=0A#. type: Plain text=0A#: doc/gui= x.texi:3850=0Amsgid "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 fr= om your own repository. The result in @file{~/.config/guix/current} is th= e union of Guix with your own package modules:"=0AThe word 'installed' is= wrong:=0A=0A#. type: itemx=0A#: doc/guix.texi:3011 doc/guix.texi:3024=0A= #, no-wrap=0Amsgid "-A [@var{regexp}]"=0A=0A#. type: table=0A#: doc/guix.= texi:3015 doc/guix.texi:3028=0Amsgid ""=0A"List packages currently availa= ble in the distribution for this system "=0A"(@pxref{GNU Distribution}). = When @var{regexp} is specified, list only "=0A"installed packages whose n= ame matches @var{regexp}."=0A=0AIn my own as I see, it does not list inst= alled but all available packages.=0APlease, inform me if these mistakes a= re not mistakes or when they will be corrected for I to be patient.=0AMay= 3, 2019 4:52 AM, znavko@disroot.org (mailto:znavko@disroot.org) wrote:= =0AThese are my current suggestions:=0AHere GuixSD rests instead of Guix = System:=0A=0A#. type: Plain text=0A#: doc/guix.texi:2650=0Amsgid ""=0A"If= you are not using the Guix System Distribution, consider adding the "=0A= "following lines to your @file{~/.bash_profile} (@pxref{Bash Startup File= s,,, "=0A"bash, The GNU Bash Reference Manual}) so that newly-spawned she= lls get all "=0A"the right environment variable definitions:"=0A#. type: = Plain text=0A#: doc/guix.texi:3140=0Amsgid ""=0A"Substitutes from the off= icial build farm are enabled by default when using "=0A"the Guix System D= istribution (@pxref{GNU Distribution}). However, they are "=0A"disabled b= y default when using Guix on a foreign distribution, unless you "=0A"have= explicitly enabled them via one of the recommended installation steps "= =0A"(@pxref{Installation}). The following paragraphs describe how to enab= le or "=0A"disable substitutes for the official build farm; the same proc= edure can also "=0A"be used to enable substitutes for any other substitut= e server."=0AThe word 'installed' is wrong:=0A=0A#. type: itemx=0A#: doc/= guix.texi:3011 doc/guix.texi:3024=0A#, no-wrap=0Amsgid "-A [@var{regexp}]= "=0A=0A#. type: table=0A#: doc/guix.texi:3015 doc/guix.texi:3028=0Amsgid = ""=0A"List packages currently available in the distribution for this syst= em "=0A"(@pxref{GNU Distribution}). When @var{regexp} is specified, list = only "=0A"installed packages whose name matches @var{regexp}."=0A=0AIn my= own as I see, it does not list installed but all available packages.=0AH= ere it is 'many types of fs', but only one mentioned as example:=0A=0A#. = type: Plain text=0A#: doc/guix.texi:2268=0Amsgid ""=0A"Alternatively, you= may use a swap file. For example, assuming that in the "=0A"new system y= ou want to use the file @file{/swapfile} as a swap file, you "=0A"would r= un@footnote{This example will work for many types of file systems (e."=0A= "g., ext4). However, for copy-on-write file systems (e.g., btrfs), the "= =0A"required steps may be different. For details, see the manual pages fo= r "=0A"@command{mkswap} and @command{swapon}.}:"=0AAnd also if another la= nguage is ready to use (Spanish), need to say it on:=0A=0A#. type: Plain = text=0A#: doc/guix.texi:117=0Amsgid ""=0A"This manual is also available i= n French (@pxref{Top,,, guix.fr, Manuel de "=0A"r=C3=A9f=C3=A9rence de GN= U Guix}) and German (@pxref{Top,,, guix.de, Referenzhandbuch "=0A"zu GNU = Guix}). If you would like to translate it in your native language, "=0A"c= onsider joining the @uref{https://translationproject.org/domain/guix-manu= al (https://translationproject.org/domain/guix-manual)."=0A"html, Transla= tion Project}."=0AMay 2, 2019 9:43 PM, "Ludovic Court=C3=A8s" wrote:=0A=0A Danny Milosavljevic skribis:as far as I can see, i= t's also wrong in the original in the manual.=0A=0Adoc/guix.texi:=0A=0A@i= tem --list-available[=3D@var{regexp}]=0A@itemx -A [@var{regexp}]=0AList p= ackages currently available in the distribution for this system=0A(@pxref= {GNU Distribution}). When @var{regexp} is specified, list only=0Ainstalle= d packages whose name matches @var{regexp}.=0A^^^^^^^^^ ?? =0A=0AOops ind= eed! I guess you can push a fix. :-)=0A=0ALudo'. ----=_RainLoop_224_431844835.1557429151 Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: quoted-printable
H= ello! Thank you for your corrections. I've discovered new mistakes in the= Guix Manual:

;;09-05-2019
;; what is API@ ? is @ symbol necess= ary there?

#. type: Plain text
#: doc/guix.texi:3987
msgid "= When combined with channels (@pxref{Channels}), inferiors provide a simpl= e way to interact with a separate revision of Guix. For example, let's as= sume 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 AP= I and you want to run your code against the old API@. To do that, you cou= ld write a manifest for use by @code{guix package --manifest} (@pxref{Inv= oking 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{gu= ile-json} package in the inferior:"


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

#. type: Plain text#: doc/guix.texi:3850
msgid "Note that the snippet above is (as alway= s!)@: Scheme code; we use @code{cons} to add a channel the list of channe= ls that the variable @code{%default-channels} is bound to (@pxref{Pairs, = @code{cons} and lists,, guile, GNU Guile Reference Manual}). With this fi= le in place, @command{guix pull} builds not only Guix but also the packag= e modules from your own repository. The result in @file{~/.config/guix/cu= rrent} 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 snipp= et above is (as always!)@: Scheme code; we use @code{cons} to add a chann= el the list of channels that the variable @code{%default-channels} is bou= nd to (@pxref{Pairs, @code{cons} and lists,, guile, GNU Guile Reference M= anual}). With this file in place, @command{guix pull} builds not only Gui= x but also the package modules from your own repository. The result in @f= ile{~/.config/guix/current} is the union of Guix with your own package mo= dules:"




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/g= uix.texi:3028
msgid ""
"List packages currently available in the di= stribution for this system "
"(@pxref{GNU Distribution}). When @var{re= gexp} 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 a= re not mistakes or when they will be corrected for I to be patient.



May 3, 2019 4:52 AM, znavko@disroot.org wrote:
These are my current suggestions:




Here GuixSD re= sts instead of Guix System:

#. type: Plain text
#: doc/guix.tex= i: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 variab= le definitions:"


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



Th= e word 'installed' is wrong:

#. type: itemx
#: doc/guix.texi:30= 11 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 "<= br>"(@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.
<= br>


Here it is 'many types of fs', but only one mentioned as e= xample:

#. 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 syste= ms (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<= br>msgid ""
"This manual is also available in French (@pxref{Top,,, gu= ix.fr, Manuel de "
"r=C3=A9f=C3=A9rence de GNU Guix}) and German (@pxr= ef{Top,,, guix.de, Referenzhandbuch "
"zu GNU Guix}). If you would lik= e to translate it in your native language, "
"consider joining the @ur= ef{https://translationproject.org/doma= in/guix-manual."
"html, Translation Project}."




=
May 2, 2019 9:43 PM, "Ludovic Court=C3=A8s" <ludo@gnu.org> wrote:

Danny M= ilosavljevic <dannym@= scratchpost.org> skribis:
as far as I can see, it's als= o wrong in the original in the manual.

doc/guix.texi:

@item= --list-available[=3D@var{regexp}]
@itemx -A [@var{regexp}]
List pa= ckages currently available in the distribution for this system
(@pxref= {GNU Distribution}). When @var{regexp} is specified, list only
install= ed packages whose name matches @var{regexp}.
^^^^^^^^^ ??
=

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

Ludo'.


<= /div> ----=_RainLoop_224_431844835.1557429151--