From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id XYugGHTuiGH2RgAAgWs5BA (envelope-from ) for ; Mon, 08 Nov 2021 10:31:32 +0100 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id mHSoE3TuiGEGMwAAB5/wlQ (envelope-from ) for ; Mon, 08 Nov 2021 09:31:32 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 26003131DB for ; Mon, 8 Nov 2021 10:31:32 +0100 (CET) Received: from localhost ([::1]:41252 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mk0zz-0003oY-B3 for larch@yhetil.org; Mon, 08 Nov 2021 04:31:31 -0500 Received: from eggs.gnu.org ([209.51.188.92]:54974) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mk0yZ-0002af-4q for guix-patches@gnu.org; Mon, 08 Nov 2021 04:30:03 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:44789) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mk0yY-0006az-Rw for guix-patches@gnu.org; Mon, 08 Nov 2021 04:30:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mk0yY-0004ca-N4 for guix-patches@gnu.org; Mon, 08 Nov 2021 04:30:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#51538] First Patch Submit Ever: Additions to the Cookbook Documentation Resent-From: "pelzflorian (Florian Pelz)" Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 08 Nov 2021 09:30:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 51538 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: To: Disseminate Dissent Cc: 51538@debbugs.gnu.org Received: via spool by 51538-submit@debbugs.gnu.org id=B51538.163636375117673 (code B ref 51538); Mon, 08 Nov 2021 09:30:02 +0000 Received: (at 51538) by debbugs.gnu.org; 8 Nov 2021 09:29:11 +0000 Received: from localhost ([127.0.0.1]:56335 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mk0xj-0004az-0u for submit@debbugs.gnu.org; Mon, 08 Nov 2021 04:29:11 -0500 Received: from pelzflorian.de ([5.45.111.108]:57658 helo=mail.pelzflorian.de) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mk0xg-0004aq-PD for 51538@debbugs.gnu.org; Mon, 08 Nov 2021 04:29:09 -0500 Received: from pelzflorian.localdomain (unknown [5.45.111.108]) by mail.pelzflorian.de (Postfix) with ESMTPSA id 88BFB3606F5; Mon, 8 Nov 2021 10:29:07 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=pelzflorian.de; s=mail; t=1636363747; bh=m3CfuiJaU8PCo3A3jOCWQQYeOK33hayEnj60NwrPw5A=; h=Date:From:To:Cc:Subject:References:In-Reply-To; b=yxbIkDqBSuZnZvlZswd/Nv/cvcFCsVJnhJgP0SK+YYhVPMHePqAPn0WvbQljMVz4T YPJfxBzWVlg+jFHop8kELIzYgfR6JrRQisfk0iFidBtKv9UBTKKhorxj1NgS1nvrF6 S8+pwDeKkSK7nm8xsXyJCoiqaoMWJE33+QM+yzT4= Date: Mon, 8 Nov 2021 10:29:00 +0100 From: "pelzflorian (Florian Pelz)" Message-ID: <20211108092900.ldk4lkh3p7wl7msd@pelzflorian.localdomain> References: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: "Guix-patches" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1636363892; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=EVfnobBDHtOqtP2/NK2363Qd7jN0UrHM0Wul7ZDq3uA=; b=sedY+BcA35IUn01uohpmSw9q36RbIIB41rQ8xUHt5o0CrZNphF3hI/zuQKbeSYuUSXU4GY z+TRf9miUNW+kt0JYfjVLopbRTnl7Zvu1V3APjzXHp2gaTBlmwjRKuJK7zDyNEoIs9wbHl AiaySbyaMXtuqLqRbqnq6qBvvfTAfosIR28OqSl26bbxoie9rWeixGoNe2G2cDcrJZKFfk NqbphEGvyHR6TO5afp6vRH8ynSGMbcQF52ZYnWU6yR+axajN0QQ2QsX17v2jjHIaMijqxw LjM7KHUorynw8Csgzc29ACU9SqKa+TSn3JITsXdF7p7Q2KH78Pfm3u3X0b+EJw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1636363892; a=rsa-sha256; cv=none; b=X/YK0PP+0kKg0aWPimVBKbhQJIj8zjI6FXzJrMYFwm0qGiz46W7Wci/C4EX9mNwf7MrnfJ x6b9S4O8zQP/Oey5b1plp/gd/Elfi1F8YwvwH2MRnmgd1qMBcaDviCGCnX2t8mggAf0s3W iOOFL/EAhuMHHpw9QLEbp9xE+umCmQQ/4kwRKHgOZOuI2OUzXsOhdf5Bz9VtmVEdMNNvis KnTgxEDTT6LmOand/3L8YIt1rJ9Ip9wkIfAfWWl1s89Tink6AoBDB7d+2u82VP/5KwaAlS tLhOYDZgkXM8X20HpBi8Wrrat+SRhoVDe7LuRdYbPIAnCZ4lvk395scZ1BSSHg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=pelzflorian.de header.s=mail header.b=yxbIkDqB; dmarc=none; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Spam-Score: 0.08 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=pelzflorian.de header.s=mail header.b=yxbIkDqB; dmarc=none; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Queue-Id: 26003131DB X-Spam-Score: 0.08 X-Migadu-Scanner: scn0.migadu.com X-TUID: 7gnl4C0cu3TI Hello Disseminate. On Thu, Nov 04, 2021 at 03:17:48PM +0000, Disseminate Dissent via Guix-patches via wrote: > Fixed the previous commit by adding the corresponding ToC heading to the new FAQ section. > > Disseminate, Peace. Thank you for your contribution! It is good you add what you are missing. I’d prefer if someone else commented, though here are my thoughts. A FAQ seems like a good idea, however see below. On Thu, Nov 04, 2021 at 03:17:48PM +0000, Disseminate Dissent via Guix-patches via wrote: > From fce239a311724e38987640af02127179d569d88e Mon Sep 17 00:00:00 2001 > From: dissent > Date: Sat, 30 Oct 2021 17:00:02 -0400 > Subject: [PATCH] doc: Added FAQ section with entry on using clear. For the commit message, Guix uses the active voice “Add a FAQ section with …”. > * doc/guix-cookbook.texi: Added FAQ section. Here too. > --- > doc/guix-cookbook.texi | 16 ++++++++++++++++ > 1 file changed, 16 insertions(+) > > diff --git a/doc/guix-cookbook.texi b/doc/guix-cookbook.texi > index dc52f6d38c..14c55926c2 100644 > --- a/doc/guix-cookbook.texi > +++ b/doc/guix-cookbook.texi > @@ -70,6 +70,7 @@ Weblate} (@pxref{Translating Guix,,, guix, GNU Guix reference manual}). > * System Configuration:: Customizing the GNU System > * Advanced package management:: Power to the users! > * Environment management:: Control environment > +* FAQ:: Commonly asked questions > > * Acknowledgments:: Thanks! > * GNU Free Documentation License:: The license of this document. Menu comments like “Commonly asked questions” usually end in a period, although the surrounding menu comments are missing the period as well. Could you add a period for “Commonly asked questions”? But see below. > @@ -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 I am uncertain if this tip should be in the cookbook, because I think GNU Bash’s C-l (control+L) keyboard shortcutis easier to use and is available in a default setup. (Actually it may be GNU Readline’s keyboard shortcut and Bash just uses Readline?) Now indeed users may not know about it. I do not know how to help Guix users learn about features of programs that Guix offers but are not part of Guix. Nitpick: you have added an unnecessary space character at the end of the line > +The @command{clear} command is found in the @command{ncurses} package. You should configure your editor to display those. Regards, Florian