From patchwork Tue Oct 27 09:54:15 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christopher Baines X-Patchwork-Id: 24824 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 0456327BBF3; Tue, 27 Oct 2020 09:55:10 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,UNPARSEABLE_RELAY,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id AB56727BBF2 for ; Tue, 27 Oct 2020 09:55:09 +0000 (GMT) Received: from localhost ([::1]:51030 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kXLh6-0003T3-Ml for patchwork@mira.cbaines.net; Tue, 27 Oct 2020 05:55:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53176) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kXLh0-0003Su-MI for guix-patches@gnu.org; Tue, 27 Oct 2020 05:55:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:59635) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kXLh0-0006zZ-CS for guix-patches@gnu.org; Tue, 27 Oct 2020 05:55:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kXLh0-0002sY-CL for guix-patches@gnu.org; Tue, 27 Oct 2020 05:55:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#44252] [PATCH] doc: Use @code rather than @var for data type items. Resent-From: Christopher Baines Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 27 Oct 2020 09:55:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 44252 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 44252@debbugs.gnu.org X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.160379246311015 (code B ref -1); Tue, 27 Oct 2020 09:55:02 +0000 Received: (at submit) by debbugs.gnu.org; 27 Oct 2020 09:54:23 +0000 Received: from localhost ([127.0.0.1]:42948 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kXLgN-0002ra-1v for submit@debbugs.gnu.org; Tue, 27 Oct 2020 05:54:23 -0400 Received: from lists.gnu.org ([209.51.188.17]:39784) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kXLgM-0002rU-4W for submit@debbugs.gnu.org; Tue, 27 Oct 2020 05:54:22 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53114) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kXLgL-0003Q5-Sx for guix-patches@gnu.org; Tue, 27 Oct 2020 05:54:21 -0400 Received: from mira.cbaines.net ([2a01:7e00:e000:2f8:fd4d:b5c7:13fb:3d27]:44273) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kXLgJ-0006ld-P6 for guix-patches@gnu.org; Tue, 27 Oct 2020 05:54:21 -0400 Received: from localhost (92.41.179.191.threembb.co.uk [92.41.179.191]) by mira.cbaines.net (Postfix) with ESMTPSA id 879C027BBF2 for ; Tue, 27 Oct 2020 09:54:17 +0000 (GMT) Received: from localhost (localhost [local]) by localhost (OpenSMTPD) with ESMTPA id 907611ff for ; Tue, 27 Oct 2020 09:54:15 +0000 (UTC) From: Christopher Baines Date: Tue, 27 Oct 2020 09:54:15 +0000 Message-Id: <20201027095415.18584-1-mail@cbaines.net> X-Mailer: git-send-email 2.28.0 MIME-Version: 1.0 Received-SPF: pass client-ip=2a01:7e00:e000:2f8:fd4d:b5c7:13fb:3d27; envelope-from=mail@cbaines.net; helo=mira.cbaines.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/27 05:46:05 X-ACL-Warn: Detected OS = ??? X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, UNPARSEABLE_RELAY=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches In the couple of cases where it's inconsistent. * doc/guix.texi (PostgreSQL, Sound Services): Replace @var with @code within data type sections. --- doc/guix.texi | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index a8aa2de0a6..ed15876ed5 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -18564,20 +18564,20 @@ without a @code{pulseaudio} package, consider enabling it through the Data type representing the configuration for @code{pulseaudio-service}. @table @asis -@item @var{client-conf} (default: @code{'()}) +@item @code{client-conf} (default: @code{'()}) List of settings to set in @file{client.conf}. Accepts a list of strings or a symbol-value pairs. A string will be inserted as-is with a newline added. A pair will be formatted as ``key = value'', again with a newline added. -@item @var{daemon-conf} (default: @code{'((flat-volumes . no))}) +@item @code{daemon-conf} (default: @code{'((flat-volumes . no))}) List of settings to set in @file{daemon.conf}, formatted just like @var{client-conf}. -@item @var{script-file} (default: @code{(file-append pulseaudio "/etc/pulse/default.pa")}) +@item @code{script-file} (default: @code{(file-append pulseaudio "/etc/pulse/default.pa")}) Script file to use as @file{default.pa}. -@item @var{system-script-file} (default: @code{(file-append pulseaudio "/etc/pulse/system.pa")}) +@item @code{system-script-file} (default: @code{(file-append pulseaudio "/etc/pulse/system.pa")}) Script file to use as @file{system.pa}. @end table @end deftp @@ -18640,24 +18640,24 @@ Data type representing the configuration for the @code{postgresql-service-type}. @table @asis -@item @var{postgresql} +@item @code{postgresql} PostgreSQL package to use for the service. -@item @var{port} (default: @code{5432}) +@item @code{port} (default: @code{5432}) Port on which PostgreSQL should listen. -@item @var{locale} (default: @code{"en_US.utf8"}) +@item @code{locale} (default: @code{"en_US.utf8"}) Locale to use as the default when creating the database cluster. -@item @var{config-file} (default: @code{(postgresql-config-file)}) +@item @code{config-file} (default: @code{(postgresql-config-file)}) The configuration file to use when running PostgreSQL. The default behaviour uses the postgresql-config-file record with the default values for the fields. -@item @var{data-directory} (default: @code{"/var/lib/postgresql/data"}) +@item @code{data-directory} (default: @code{"/var/lib/postgresql/data"}) Directory in which to store the data. -@item @var{extension-packages} (default: @code{'()}) +@item @code{extension-packages} (default: @code{'()}) @cindex postgresql extension-packages Additional extensions are loaded from packages listed in @var{extension-packages}. Extensions are available at runtime. For instance,