[PATCH] Mention service key word more prominently in pg_service.conf docs - Mailing list pgsql-hackers

From Dagfinn Ilmari Mannsåker
Subject [PATCH] Mention service key word more prominently in pg_service.conf docs
Date
Msg-id 87r09ibpke.fsf@wibble.ilmari.org
Whole thread Raw
Responses Re: [PATCH] Mention service key word more prominently in pg_service.conf docs
List pgsql-hackers
Hi hackers,

I just noticed that the docs for pg_service.conf
(https://www.postgresql.org/docs/current/libpq-pgservice.html) don't
mention the actual key word to use in the libpq connection string until
the example in the last sentence, but it mentions the env var in the
first paragraph.  Here's a patch to make the key word equally prominent.

- ilmari

From 380f9a717ff8216201e44c4f2caa34b596b13e7a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dagfinn=20Ilmari=20Manns=C3=A5ker?= <ilmari@ilmari.org>
Date: Tue, 17 Sep 2024 10:17:46 +0100
Subject: [PATCH] Mention the `service` key word more prominently in the
 pg_service.conf docs

The env var was mentioned in the first paragraph, but the key word
wasn't mentioned until the last sentence.
---
 doc/src/sgml/libpq.sgml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 783e8e750b..ef7e3076ce 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -9317,7 +9317,8 @@
   <para>
    The connection service file allows libpq connection parameters to be
    associated with a single service name. That service name can then be
-   specified in a libpq connection string, and the associated settings will be
+   specified using the <literal>service</literal> key word
+   in a libpq connection string, and the associated settings will be
    used. This allows connection parameters to be modified without requiring
    a recompile of the libpq-using application. The service name can also be
    specified using the <envar>PGSERVICE</envar> environment variable.
-- 
2.39.5


pgsql-hackers by date:

Previous
From: Amit Kapila
Date:
Subject: Re: Using per-transaction memory contexts for storing decoded tuples
Next
From: Florents Tselai
Date:
Subject: jsonb_strip_nulls with arrays?