From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id BLxXMmhclV+kUQAA0tVLHw (envelope-from ) for ; Sun, 25 Oct 2020 11:07:20 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id CPGNLWhclV+XZwAA1q6Kng (envelope-from ) for ; Sun, 25 Oct 2020 11:07:20 +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 729FA94042B for ; Sun, 25 Oct 2020 11:07:20 +0000 (UTC) Received: from localhost ([::1]:42674 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kWdrr-0003ki-Dq for larch@yhetil.org; Sun, 25 Oct 2020 07:07:19 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52380) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kWdrb-0003jp-VL for guix-patches@gnu.org; Sun, 25 Oct 2020 07:07:04 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:52540) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kWdrb-00065G-5k for guix-patches@gnu.org; Sun, 25 Oct 2020 07:07:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kWdrb-0004MS-1e for guix-patches@gnu.org; Sun, 25 Oct 2020 07:07:03 -0400 Subject: bug#44207: [PATCH] doc: Document the postgresql-config-file. Resent-From: Christopher Baines Original-Sender: "Debbugs-submit" Resent-To: guix-patches@gnu.org Resent-Date: Sun, 25 Oct 2020 11:07:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 44207 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Miguel =?UTF-8?Q?=C3=81ngel?= Arruga Vivas Cc: 44207-done@debbugs.gnu.org Mail-Followup-To: 44207@debbugs.gnu.org, mail@cbaines.net, mail@cbaines.net Received: via spool by 44207-done@debbugs.gnu.org id=D44207.160362398916687 (code D ref 44207); Sun, 25 Oct 2020 11:07:02 +0000 Received: (at 44207-done) by debbugs.gnu.org; 25 Oct 2020 11:06:29 +0000 Received: from localhost ([127.0.0.1]:35846 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kWdr3-0004L5-Ej for submit@debbugs.gnu.org; Sun, 25 Oct 2020 07:06:29 -0400 Received: from mira.cbaines.net ([212.71.252.8]:34982) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kWdr1-0004Kw-LW for 44207-done@debbugs.gnu.org; Sun, 25 Oct 2020 07:06:28 -0400 Received: from localhost (92.41.179.191.threembb.co.uk [92.41.179.191]) by mira.cbaines.net (Postfix) with ESMTPSA id 4BD2C27BBF0; Sun, 25 Oct 2020 11:06:26 +0000 (GMT) Received: from capella (localhost [127.0.0.1]) by localhost (OpenSMTPD) with ESMTP id a2a90709; Sun, 25 Oct 2020 11:06:23 +0000 (UTC) References: <20201025085134.14378-1-mail@cbaines.net> <87eelm7gik.fsf@gmail.com> User-agent: mu4e 1.4.13; emacs 27.1 From: Christopher Baines In-reply-to: <87eelm7gik.fsf@gmail.com> Date: Sun, 25 Oct 2020 11:06:20 +0000 Message-ID: <87imaya7kj.fsf@cbaines.net> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature" X-Spam-Score: -0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-Spam-Score: -1.0 (-) 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-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=none; 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-Spam-Score: -3.11 X-TUID: vL4RpU3lpBCL --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Miguel =C3=81ngel Arruga Vivas writes: > Hi! > > Some comments inline. Hey, thanks for the quick comments :) > Christopher Baines writes: >> +@deftp {Data Type} postgresql-config-file >> +Data type representing the PostgreSQL configuration file. As shown in >> +the following example, this can be used to customise the configuration >> +of PostgreSQL. Note that you can use any G-expression or filename in >> +place of this record, if you already have a configuration file you'd >> +like to use for example. > > I'm pretty sure you should s/customise/customize/, as the manual is > written in US English. Indeed, old habits :) > Also, I'd move the last sentence to the hba-file description as an > example there, something like: "Filename or G-expression for the > host-based authentication configuration. If you already have a > configuration file, you can use it here." While the same is true for the hba-file, and ident-file bit, I wanted to make this point for the postgresql-config-file record as a whole. Hopefully that makes sense? > [...] >> +@item @var{log-destination} (default: @code{"syslog"}) > [...] >> +@item @var{hba-file} (default: @code{%default-postgres-hba}) > [...] >> +@item @var{ident-file} (default: @code{%default-postgres-ident}) > [...] >> +@item @var{extra-config} (default: @code{'()}) > > These should be @code, not @var, because they represent symbols from the > configuration. The typical use of @var is for arguments---e.g. > @code{(call-something @var{param1} @var{param2})}---, whose names > don't have a meaning outside the actual implementation, but these > identifiers are symbols included in the API. Ah, this is probably something I got wrong when documenting the postgresql-configuration record, I wonder if I copied that from somewhere else... anyway, I've fixed this now. > Apart from that, LGTM. :-) Great, I've pushed now with the above changes. --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQKlBAEBCgCPFiEEPonu50WOcg2XVOCyXiijOwuE9XcFAl+VXC1fFIAAAAAALgAo aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDNF ODlFRUU3NDU4RTcyMEQ5NzU0RTBCMjVFMjhBMzNCMEI4NEY1NzcRHG1haWxAY2Jh aW5lcy5uZXQACgkQXiijOwuE9XfQqQ/+IaJelrvCq4fdm9X0KsBEkw0xq+zLauRh taI3G3FYh0+QbdpmCX8JzpBhEAZ+8jgh3QvzvCNXAnh6xa13UnKWGoi0AT1UJgsZ wK5GMcTQIDsP5O53TpCkWmM9bKeEea2xac6CB5qCTAkHecGt9fkV3Lnr9AxX9f/b Sa0X3HKM4j6O/2AYDOkPBmQCR/IQCkXfAZoVt+SKypc13tNbWeRpP3HcwPR8YkuM jJqxM4OE2uLjiMFGII0NxE6YMlLjIDut7pfTVTOgmPwUdFML4P70Lc0GAzzCX+ko F5EhIxlCNl9pPxoiFZlq9r+4JGPgIpeHimsVAkFCwy3lxaMSH/x+lWZZXr6B+FaY m5+k8JTmahwWXr52ZctecY/YDDM5pIYLZUXzzPxk4yaTugrsucCU6QrJxqLxuJqu v+R+JTo+zvV32zeAGjoWcH3r+nZgBlDacGn51L5DOjJLbJmBWnT4pMW8WHdI2IHv bB6S1APgRI7nAxfp7tw07jhSEOPTLOe+89XVh+UiLeZ+xs9xZ5r4DqZgGhXPoDX9 4Zq96ET/emCP3sX0a6JWc8n0virqJipxEmN7XB02KTV0dLkPf4/6CyyxljJwdqV4 5X0+3YrohEWNmAHQO81O7Qct/Hog9ZO9sD/VyOmA/pisgETu+aLI7VOq7hYnn9ey vhQCdKsAWdQ= =Og4a -----END PGP SIGNATURE----- --=-=-=--