From debbugs-submit-bounces@debbugs.gnu.org Sun Nov 11 04:33:01 2018 Received: (at submit) by debbugs.gnu.org; 11 Nov 2018 09:33:01 +0000 Received: from localhost ([127.0.0.1]:45305 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gLm73-0006j9-2t for submit@debbugs.gnu.org; Sun, 11 Nov 2018 04:33:01 -0500 Received: from eggs.gnu.org ([208.118.235.92]:52207) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gLm70-0006iv-BG for submit@debbugs.gnu.org; Sun, 11 Nov 2018 04:32:58 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gLm6r-0005qq-PU for submit@debbugs.gnu.org; Sun, 11 Nov 2018 04:32:53 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:38975) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gLm6m-0005Hd-Eq for submit@debbugs.gnu.org; Sun, 11 Nov 2018 04:32:45 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33554) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gLm6l-0005TJ-1H for guix-patches@gnu.org; Sun, 11 Nov 2018 04:32:44 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gLm6h-0004kf-5y for guix-patches@gnu.org; Sun, 11 Nov 2018 04:32:42 -0500 Received: from mx1.riseup.net ([198.252.153.129]:52046) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gLm6g-0004XO-AG for guix-patches@gnu.org; Sun, 11 Nov 2018 04:32:38 -0500 Received: from cotinga.riseup.net (cotinga-pn.riseup.net [10.0.1.164]) (using TLSv1 with cipher ECDHE-RSA-AES256-SHA (256/256 bits)) (Client CN "*.riseup.net", Issuer "COMODO RSA Domain Validation Secure Server CA" (verified OK)) by mx1.riseup.net (Postfix) with ESMTPS id E9DA11A019E for ; Sun, 11 Nov 2018 01:32:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=riseup.net; s=squak; t=1541928757; bh=u94hFZs14MkHYo+Rw9sq7aC1snLkDDUWoBoACAlpA8A=; h=To:From:Subject:Date:From; b=ILQdHnBMQ+lblOUnYpxDsMaiB2OVEmWOvVstjraODyiUu5LPjDzaV1clJkPsGrPkL 7FrkQBG0BqgqfAXnEc+blwaD2afO7ht84i1T7GH3XDMZm7ib+d6Bkz2rr4iPUT/IXx eIZnQu5olCFbjgHgvUR0rNtYVUkeLsvp8SLV6yt0= X-Riseup-User-ID: FD717A454BA634001E9B405290F42B6551AE61B3831246EA3DF096AEC10281BA Received: from [127.0.0.1] (localhost [127.0.0.1]) by cotinga.riseup.net with ESMTPSA id 53CF91027A1 for ; Sun, 11 Nov 2018 01:32:36 -0800 (PST) To: guix-patches@gnu.org From: swedebugia Subject: [PATCH] doc: Fix formatting of notes in multiple sections. Add note Message-ID: <2fcb93ed-1639-67e6-a9c2-603d64f56c4c@riseup.net> Date: Sun, 11 Nov 2018 10:32:33 +0100 MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="------------34E435219500CAA37A458332" Content-Language: en-US X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 2001:4830:134:3::11 X-Spam-Score: -4.1 (----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.1 (-----) This is a multi-part message in MIME format. --------------34E435219500CAA37A458332 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit -- Cheers Swedebugia --------------34E435219500CAA37A458332 Content-Type: text/x-patch; name="0001-doc-Fix-formatting-of-notes-in-multiple-sections.-Ad.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0001-doc-Fix-formatting-of-notes-in-multiple-sections.-Ad.pa"; filename*1="tch" 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 -- 2.18.0 --------------34E435219500CAA37A458332--