| Message ID | QsmxdpChZZ6_dApCuCPCwhTl2o_jmQB5_QAMv-UNVIpr_oIhL5bwfyJsOwEyj-vN5qlFOqVz-G6hM5epRI-2ba6X3RpmlMQAy5tXxkwueF0=@protonmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [bug#51538] First Patch Submit Ever: Additions to the Cookbook Documentation | expand |
| Context | Check | Description |
|---|---|---|
| cbaines/comparison | success | View comparision |
| cbaines/git branch | success | View Git branch |
| cbaines/applying patch | fail | View Laminar job |
| cbaines/issue | success | View issue |
Disseminate, thank you for your work. On Mon, Nov 08, 2021 at 01:48:39PM +0000, Disseminate Dissent wrote: > Thanks for the comments Florian, > > Added periods and removed whitespace. > > In my initial Guix setup I was unable to clear the terminal with > neither `clear` nor C-l. Installing ncurses solved that issue and is > listed as a dependency for GNU Readline. Bash always enables readline as far as I can see. Perhaps you used a system that disabled C-l in the ~/.inputrc file, which would also disable it for a Guix-installed bash? Some Slackware users complain about non-working C-l on stackoverflow. Anyway I will leave this patch for experienced guix commiters to decide; IMHO the clear command should not be needed with Guix and the cookbook so far contains only what can be done with Guix itself. Even though I like the idea of a FAQ section and am happy about new Guix contributors such as you. As for the patch: On Mon, Nov 08, 2021 at 01:50:20PM +0000, Disseminate Dissent via Guix-patches via wrote: > Corrected missing periods and whitespace. > You have not addressed this latter passive Added instead of Add: On Mon, Nov 08, 2021 at 10:29:00AM +0100, pelzflorian (Florian Pelz) wrote: > For the commit message, Guix uses the active voice “Add a FAQ section > with …”. > > > > * doc/guix-cookbook.texi: Added FAQ section. > > Here too. Then: On Mon, Nov 08, 2021 at 01:50:20PM +0000, Disseminate Dissent via Guix-patches via wrote: > @menu > * Scheme tutorials:: Meet your new favorite language! > -* Packaging:: Packaging tutorials > -* System Configuration:: Customizing the GNU System > +* Packaging:: Packaging tutorials. > +* System Configuration:: Customizing the GNU System. > * Advanced package management:: Power to the users! > -* Environment management:: Control environment > +* Environment management:: Control environment. > +* FAQ:: Commonly asked questions. Your commit should only add the period to your sentence; other sentences should remain untouched (fixing them belongs in a separate commit). I should fix such things myself in other commits; probably I won’t do it. Other than that, it is a nicely written patch. It seems the issue when running the commands from `info "(guix)Building from Git"` is that the other menu > +@menu > +* How do I clear my terminal screen? > +@end menu does not contain double colons followed by a sentence like the other @menu. Regards, Florian
I think this is fine. The cookbook should recommend using Ctrl-L and suggest you can install clear with the ncurses package. We get that question from time to time, so I think it belongs to a FAQ :) Le 8 novembre 2021 12:18:50 GMT-05:00, "pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> a écrit : >Disseminate, thank you for your work. > >On Mon, Nov 08, 2021 at 01:48:39PM +0000, Disseminate Dissent wrote: >> Thanks for the comments Florian, >> >> Added periods and removed whitespace. >> >> In my initial Guix setup I was unable to clear the terminal with >> neither `clear` nor C-l. Installing ncurses solved that issue and is >> listed as a dependency for GNU Readline. > >Bash always enables readline as far as I can see. Perhaps you used a >system that disabled C-l in the ~/.inputrc file, which would also >disable it for a Guix-installed bash? Some Slackware users complain >about non-working C-l on stackoverflow. Anyway I will leave this >patch for experienced guix commiters to decide; IMHO the clear command >should not be needed with Guix and the cookbook so far contains only >what can be done with Guix itself. Even though I like the idea of a >FAQ section and am happy about new Guix contributors such as you. > >As for the patch: > >On Mon, Nov 08, 2021 at 01:50:20PM +0000, Disseminate Dissent via Guix-patches via wrote: >> Corrected missing periods and whitespace. >> > >You have not addressed this latter passive Added instead of Add: > >On Mon, Nov 08, 2021 at 10:29:00AM +0100, pelzflorian (Florian Pelz) wrote: >> For the commit message, Guix uses the active voice “Add a FAQ section >> with …”. >> >> >> > * doc/guix-cookbook.texi: Added FAQ section. >> >> Here too. > >Then: > >On Mon, Nov 08, 2021 at 01:50:20PM +0000, Disseminate Dissent via Guix-patches via wrote: >> @menu >> * Scheme tutorials:: Meet your new favorite language! >> -* Packaging:: Packaging tutorials >> -* System Configuration:: Customizing the GNU System >> +* Packaging:: Packaging tutorials. >> +* System Configuration:: Customizing the GNU System. >> * Advanced package management:: Power to the users! >> -* Environment management:: Control environment >> +* Environment management:: Control environment. >> +* FAQ:: Commonly asked questions. > >Your commit should only add the period to your sentence; other >sentences should remain untouched (fixing them belongs in a separate >commit). I should fix such things myself in other commits; probably I >won’t do it. > >Other than that, it is a nicely written patch. > >It seems the issue when running the commands from >`info "(guix)Building from Git"` is that the other menu > >> +@menu >> +* How do I clear my terminal screen? >> +@end menu > >does not contain double colons followed by a sentence like the other >@menu. > >Regards, >Florian > > > >
On Mon, Nov 08, 2021 at 02:04:12PM -0500, Julien Lepiller wrote: > Le 8 novembre 2021 12:18:50 GMT-05:00, "pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> a écrit : > >Bash always enables readline as far as I can see. Perhaps you used a > >system that disabled C-l in the ~/.inputrc file, which would also > >disable it for a Guix-installed bash? Some Slackware users complain > >about non-working C-l on stackoverflow. Anyway I will leave this > >patch for experienced guix commiters to decide; IMHO the clear command > >should not be needed with Guix and the cookbook so far contains only > >what can be done with Guix itself. Even though I like the idea of a > >FAQ section and am happy about new Guix contributors such as you. > I think this is fine. The cookbook should recommend using Ctrl-L and > suggest you can install clear with the ncurses package. We get that > question from time to time, so I think it belongs to a FAQ :) One might expect terminal clearing with C-l or clear in an operating system manual, but is role of Guix to be an operating system? I’d think not, the manual/cookbook would blow up too much. A command to search what package provides the program clear is what belongs in the manual. Regards, Florian
From 66947f766c59a1ecbf7cb1fc91f404653e74d7e5 Mon Sep 17 00:00:00 2001 From: dissent <disseminatedissent@protonmail.com> Date: Sat, 30 Oct 2021 17:00:02 -0400 Subject: [PATCH] doc: Add a FAQ section with entry on using clear. * doc/guix-cookbook.texi: Added FAQ section. --- doc/guix-cookbook.texi | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi index dc52f6d38c..0718a6711d 100644 --- a/doc/guix-cookbook.texi +++ b/doc/guix-cookbook.texi @@ -66,10 +66,11 @@ Weblate} (@pxref{Translating Guix,,, guix, GNU Guix reference manual}). @menu * Scheme tutorials:: Meet your new favorite language! -* Packaging:: Packaging tutorials -* System Configuration:: Customizing the GNU System +* Packaging:: Packaging tutorials. +* System Configuration:: Customizing the GNU System. * Advanced package management:: Power to the users! -* Environment management:: Control environment +* Environment management:: Control environment. +* FAQ:: Commonly asked questions. * Acknowledgments:: Thanks! * GNU Free Documentation License:: The license of this document. @@ -2964,6 +2965,21 @@ will have predefined environment variables and procedures. Run @command{direnv allow} to setup the environment for the first time. +@c ********************************************************************* +@node FAQ +@chapter FAQ + +This chapter collects some frequently asked questions that might arise for new users. + +@menu +* How do I clear my terminal screen? +@end menu + +@node How do I clear my terminal screen? +@section How do I clear my terminal screen? + +The @command{clear} command is found in the @command{ncurses} package. + @c ********************************************************************* @node Acknowledgments @chapter Acknowledgments -- 2.33.1