From: Christopher Baines <mail@cbaines.net>
To: "Miguel Ángel Arruga Vivas" <rosen644835@gmail.com>
Cc: 44207-done@debbugs.gnu.org
Subject: bug#44207: [PATCH] doc: Document the postgresql-config-file.
Date: Sun, 25 Oct 2020 11:06:20 +0000 [thread overview]
Message-ID: <87imaya7kj.fsf@cbaines.net> (raw)
In-Reply-To: <87eelm7gik.fsf@gmail.com>
[-- Attachment #1: Type: text/plain, Size: 1998 bytes --]
Miguel Ángel Arruga Vivas <rosen644835@gmail.com> writes:
> Hi!
>
> Some comments inline.
Hey, thanks for the quick comments :)
> Christopher Baines <mail@cbaines.net> 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.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 987 bytes --]
prev parent reply other threads:[~2020-10-25 11:07 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-25 8:51 [bug#44207] [PATCH] doc: Document the postgresql-config-file Christopher Baines
2020-10-25 10:21 ` Miguel Ángel Arruga Vivas
2020-10-25 11:06 ` Christopher Baines [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87imaya7kj.fsf@cbaines.net \
--to=mail@cbaines.net \
--cc=44207-done@debbugs.gnu.org \
--cc=rosen644835@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).