From: Julien Lepiller <julien@lepiller.eu>
To: 51538@debbugs.gnu.org, pelzflorian@pelzflorian.de,
disseminatedissent@protonmail.com
Subject: [bug#51538] First Patch Submit Ever: Additions to the Cookbook Documentation
Date: Mon, 08 Nov 2021 14:04:12 -0500 [thread overview]
Message-ID: <FC2C93E1-D906-4A5D-916B-F436E81AC35A@lepiller.eu> (raw)
In-Reply-To: <20211108171850.q6pqyiv4g5q2oktr@pelzflorian.localdomain>
[-- Attachment #1: Type: text/plain, Size: 3009 bytes --]
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
>
>
>
>
[-- Attachment #2: Type: text/html, Size: 4070 bytes --]
next prev parent reply other threads:[~2021-11-08 19:05 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-31 23:56 [bug#51538] First Patch Submit Ever: Additions to the Cookbook Documentation Disseminate Dissent via Guix-patches via
2021-11-01 15:10 ` [bug#51538] TOC jgart via Guix-patches via
2021-11-04 15:17 ` [bug#51538] First Patch Submit Ever: Additions to the Cookbook Documentation Disseminate Dissent via Guix-patches via
2021-11-08 9:29 ` pelzflorian (Florian Pelz)
2021-11-08 9:53 ` pelzflorian (Florian Pelz)
2021-11-08 13:50 ` Disseminate Dissent via Guix-patches via
2021-11-08 17:18 ` pelzflorian (Florian Pelz)
2021-11-08 19:04 ` Julien Lepiller [this message]
2021-11-11 17:04 ` pelzflorian (Florian Pelz)
2021-11-08 13:52 ` Disseminate Dissent via Guix-patches via
2021-11-09 0:21 ` [bug#51538] (no subject) jgart via Guix-patches via
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=FC2C93E1-D906-4A5D-916B-F436E81AC35A@lepiller.eu \
--to=julien@lepiller.eu \
--cc=51538@debbugs.gnu.org \
--cc=disseminatedissent@protonmail.com \
--cc=pelzflorian@pelzflorian.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.