From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id gAcpEyLRTmLHaQEAgWs5BA (envelope-from ) for ; Thu, 07 Apr 2022 13:55:14 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id aH2lECLRTmJ7hQAA9RJhRA (envelope-from ) for ; Thu, 07 Apr 2022 13:55:14 +0200 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 C78E18A8D for ; Thu, 7 Apr 2022 13:55:13 +0200 (CEST) Received: from localhost ([::1]:52090 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ncQjI-0004Bf-5m for larch@yhetil.org; Thu, 07 Apr 2022 07:55:12 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58434) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ncQj8-0004Aw-F0 for guix-patches@gnu.org; Thu, 07 Apr 2022 07:55:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:37909) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ncQj8-0008Gi-1s for guix-patches@gnu.org; Thu, 07 Apr 2022 07:55:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ncQj8-0002FJ-1e for guix-patches@gnu.org; Thu, 07 Apr 2022 07:55:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#33342] [PATCH] doc: Fix formatting of notes in multiple sections. Add note Resent-From: zimoun Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 07 Apr 2022 11:55:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 33342 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: swedebugia , ludo@gnu.org Cc: 33342@debbugs.gnu.org Received: via spool by 33342-submit@debbugs.gnu.org id=B33342.16493324708583 (code B ref 33342); Thu, 07 Apr 2022 11:55:02 +0000 Received: (at 33342) by debbugs.gnu.org; 7 Apr 2022 11:54:30 +0000 Received: from localhost ([127.0.0.1]:60038 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ncQic-0002EM-2l for submit@debbugs.gnu.org; Thu, 07 Apr 2022 07:54:30 -0400 Received: from mail-wr1-f52.google.com ([209.85.221.52]:36389) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ncQiZ-0002Dw-RH for 33342@debbugs.gnu.org; Thu, 07 Apr 2022 07:54:29 -0400 Received: by mail-wr1-f52.google.com with SMTP id u3so7503017wrg.3 for <33342@debbugs.gnu.org>; Thu, 07 Apr 2022 04:54:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=8Q9TPU0bxzecXaxEIWvsWrhKQqErftpHlasRvJa2MuY=; b=RAMFhTOSQFW3q6VNCU/kPPSN6SAHMW53/yRBFnnzYKjIuF0nwXTG4kEJ5vw0pJGVrE RG8JBaoCWj6vNvPeLuAhiP/gPBGPm64boVdpqCNsCsYuJFGDa2IGZa8IisznCi5mwAL4 k8jaePJp+B9th58VjWvvejHnjhmwO9DPJXX3n79Vu1hqGO8pqhM+nIFoPFD2re21uu+E fm0z/+fVn1I+dIeamQgGMWWBZ22K3g6B/zU1HSLEqXqbV62fEOhUjaAmDcf2MS/QTm+E 3G+VvdpQj93FKkpQ+4e9BIQNx3sOpZzYBjxvr11v6WrqHoGbZBEyCWMmXjsy4J03oTLf yMEg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=8Q9TPU0bxzecXaxEIWvsWrhKQqErftpHlasRvJa2MuY=; b=ohon+sDuh++iyDGK+awNX/UIbvbrNjIFWaLUdylQFbTPAmfPo1osgam1EvOeZjH/dR wtdCj1onGTesoyVrvJyF8Ov5gK4rYvPNAhGrswpQC7Dc5HVaoCBdgFY6Fyq03oeI0UdD KXsTsidy6h/vQDHGkW5fZEUYRcIc9RM5S5qp/dIYIyIk6t5JZyLkHthMEIUXpl3iv53o lkTAJ2vdFQT4RT+g1XXY3nbSz30pOj8UweSZlmr5RPbs60/YcWZSIThAy18coVwLB+fF JENy4P/01pWFJoLtFOzFZnWSMPhBbsROkz0Osd6UwrX7O/WCJnEbSp/6kp3jPsW/BEuo InFQ== X-Gm-Message-State: AOAM530yM0ttY9d78WDTqHCE7aMc3aGM08SnFjJ0SVZYSLd6GOA/ZSAd Go4FvLdhECFWTuWiyGxrttY8C3FoEfE= X-Google-Smtp-Source: ABdhPJzf+fm46KyQzuChIc4+UeZv99LzT7+RbsQt07qnxWebgCeYoBe06RpIaBfn5ePiggF6qa7I/Q== X-Received: by 2002:adf:f5c4:0:b0:205:2836:f1e5 with SMTP id k4-20020adff5c4000000b002052836f1e5mr10326073wrp.519.1649332462124; Thu, 07 Apr 2022 04:54:22 -0700 (PDT) Received: from lili ([2a01:e0a:59b:9120:65d2:2476:f637:db1e]) by smtp.gmail.com with ESMTPSA id p125-20020a1c2983000000b0038e6c62f527sm10600788wmp.14.2022.04.07.04.54.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 07 Apr 2022 04:54:21 -0700 (PDT) From: zimoun References: <2fcb93ed-1639-67e6-a9c2-603d64f56c4c@riseup.net> Date: Thu, 07 Apr 2022 13:51:07 +0200 In-Reply-To: <2fcb93ed-1639-67e6-a9c2-603d64f56c4c@riseup.net> (swedebugia@riseup.net's message of "Sun, 11 Nov 2018 10:32:33 +0100") Message-ID: <86a6cx3ydw.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain 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 X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1649332513; 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: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=8Q9TPU0bxzecXaxEIWvsWrhKQqErftpHlasRvJa2MuY=; b=tfb2eBUv1I/Zjks3Q5rP1K0SBBOWEAY62A04AwJgEr1DNDyr9I/7kTerSK9HYNqHlI+GBr u7+EQFmPTXg4ed1Y1GXRA7kMRnHBaWO21+A0hSe7iTeYQrMsQogTGWvo2hW0yqAtXomi+q Ds/KIsJOxeJITrQf6F7p6qGPvU0HIv8r423cqcnRx+Zn+7Z0KEtHJrGebCJd0PsFWpUJsb P2KqKHUtBXKPv1XCSXQBzwUAeyJKT69zINuU7z0W5oW1BeTdw4+dp50BwoIfOL1eTxmmD5 TNB4pQlgHeuF8VWfpuywYIYYjeQoI8pZl4XnxtMYBINjXP4yLoDIZdILown+Yw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1649332513; a=rsa-sha256; cv=none; b=CFailbE3CRtRu2xeVJ+/KVd0gTrsWgE5Xan4y2dccvYkw3toEU7JVUF+KJ3kIumwdbhbni uk0Z3GjBSeH3HohY6M+vsxfEiGwBCHOngD44G1SupWZIhZ5fKQTsLHDry/e5pbC7j/dCnV PiwLzD3U4jdsn9QSsbvMfm7w7SxtKsH7dTpSN6wlfGS/bkKLaNuvn5LEe5TGEeItgt6U1+ 3oUFHneIO6ggEGv1k8uAO05FaXCiAThX1MmL6SOSFIqd+nXuy5cYO49pGytNfe3UeMwS1s AeXzRsZ5xbGtRhaJfF88U/ki5NIZQvwNVY75iSMbJ+NU/zxra1mGmAe0ttJ2JQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=RAMFhTOS; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: 4.94 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=RAMFhTOS; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: C78E18A8D X-Spam-Score: 4.94 X-Migadu-Scanner: scn0.migadu.com X-TUID: VPDBiVHaLTIG Hi, This patch#33342 seems felt into the cracks: http://issues.guix.gnu.org/issue/33342 and it appears to me an improvement. The commit title and the commit message are not ready tough. Do we apply it? On Sun, 11 Nov 2018 at 10:32, swedebugia wrote: >>>From 27ee648a921f1586f6a2d145de06fe93635102cd Mon Sep 17 00:00:00 2001 > From: swedebugia > Date: Sun, 11 Nov 2018 10:28:23 +0100 > Subject: [PATCH] doc: Fix formatting of notes in multiple sections. Add note > > * doc/guix.texi (Instantiating the system): Add suggestion to keep > config.scm under version control. > --- > doc/guix.texi | 40 ++++++++++++++++++++++++++++++---------- > 1 file changed, 30 insertions(+), 10 deletions(-) > > diff --git a/doc/guix.texi b/doc/guix.texi > index c74351dd8..cbf65c2df 100644 > --- a/doc/guix.texi > +++ b/doc/guix.texi > @@ -9780,6 +9780,11 @@ file, the @command{guix system reconfigure my-system-config.scm} command > instantiates that configuration, and makes it the default GRUB boot > entry (@pxref{Invoking guix system}). > > +@quotation Note > +Note: We recommend that you keep this my-system-config.scm-file safe and under > +version control to easily track changes to your configuration. > +@end quotation > + > The normal way to change the system configuration is by updating this > file and re-running @command{guix system reconfigure}. One should never > have to touch files in @file{/etc} or to run commands that modify the > @@ -12853,9 +12858,11 @@ like this (you need to use the @code{(gnu packages cups)} module): > (list cups-filters escpr hplip-minimal)))) > @end example > > +@quotation Note > Note: If you wish to use the Qt5 based GUI which comes with the hplip > package then it is suggested that you install the @code{hplip} package, > either in your OS configuration file or as your user. > +@end quotation > > The available configuration parameters follow. Each parameter > definition is preceded by its type; for example, @samp{string-list foo} > @@ -15930,11 +15937,13 @@ example if you want your users to have addresses like > @samp{"john.smith@@example.com"} then you need to add a host > @samp{"example.com"}. All options in this list will apply only to this host. > > +@quotation Note > Note: the name "virtual" host is used in configuration to avoid confusion with > the actual physical host that Prosody is installed on. A single Prosody > instance can serve many domains, each one defined as a VirtualHost entry in > Prosody's configuration. Conversely a server that hosts a single domain would > have just one VirtualHost entry. > +@end quotation > > See @url{https://prosody.im/doc/configure#virtual_host_settings}. > > @@ -16274,9 +16283,11 @@ before setting it here, to get a feel for which cipher suites you will get. > After setting this option, it is recommend that you inspect your Murmur log > to ensure that Murmur is using the cipher suites that you expected it to. > > +@quotation Note > Note: Changing this option may impact the backwards compatibility of your > Murmur server, and can remove the ability for older Mumble clients to be able > to connect to it. > +@end quotation > > @item @code{public-registration} (default: @code{#f}) > Must be a @code{} record or @code{#f}. > @@ -18048,13 +18059,15 @@ configuration: > (service ddclient-service-type) > @end example > > -Note that ddclient needs to access credentials that are stored in a > +@quotation Note > +Note: ddclient needs to access credentials that are stored in a > @dfn{secret file}, by default @file{/etc/ddclient/secrets} (see > @code{secret-file} below.) You are expected to create this file manually, in > an ``out-of-band'' fashion (you @emph{could} make this file part of the > service configuration, for instance by using @code{plain-file}, but it will be > world-readable @i{via} @file{/gnu/store}.) See the examples in the > @file{share/ddclient} directory of the @code{ddclient} package. > +@end quotation > > @c %start of fragment > > @@ -21609,10 +21622,12 @@ to the @code{packages} field of the @code{operating-system} declaration > @code{nss-certs}, which is a set of CA certificates provided as part of > Mozilla's Network Security Services. > > -Note that it is @emph{not} part of @var{%base-packages}, so you need to > +@quotation Note > +Note: @code{nss-certs} is @emph{not} part of @var{%base-packages}, so you need to > explicitly add it. The @file{/etc/ssl/certs} directory, which is where > most applications and libraries look for certificates by default, points > to the certificates installed globally. > +@end quotation > > Unprivileged users, including users of Guix on a foreign distro, > can also install their own certificate package in > @@ -21700,13 +21715,14 @@ Do not worry: the @code{%mdns-host-lookup-nss} variable (see below) > contains this configuration, so you will not have to type it if all you > want is to have @code{.local} host lookup working. > > -Note that, in this case, in addition to setting the > -@code{name-service-switch} of the @code{operating-system} declaration, > -you also need to use @code{avahi-service} (@pxref{Networking Services, > -@code{avahi-service}}), or @var{%desktop-services}, which includes it > -(@pxref{Desktop Services}). Doing this makes @code{nss-mdns} accessible > -to the name service cache daemon (@pxref{Base Services, > -@code{nscd-service}}). > +@quotation Note > +Note: In addition to setting the @code{name-service-switch} of the > +@code{operating-system} declaration, you also need to use @code{avahi-service} > +(@pxref{Networking Services, @code{avahi-service}}), or > +@var{%desktop-services}, which includes it (@pxref{Desktop Services}). Doing > +this makes @code{nss-mdns} accessible to the name service cache daemon > +(@pxref{Base Services, @code{nscd-service}}). > +@end quotation > > For convenience, the following variables provide typical NSS > configurations. > @@ -22542,6 +22558,10 @@ $ guix system extension-graph @var{file} | dot -Tpdf > services.pdf > > produces a PDF file showing the extension relations among services. > > +@quotation Note > +Note: The @command{dot} program is provided by the @code{graphviz} package. > +@end quotation > + > @anchor{system-shepherd-graph} > @item shepherd-graph > Emit in Dot/Graphviz format to standard output the @dfn{dependency > @@ -22660,7 +22680,7 @@ VM. To enable that you'll also have to pass the following flags to @command{qem > name=com.redhat.spice.0 > @end example > > -You'll also need to add the @pxref{Miscellaneous Services, Spice service}. > +You'll also need to add the @code{(spice-service)}, @pxref{Miscellaneous Services, Spice service}. > > @node Defining Services > @subsection Defining Services Cheers, simon