MIME-Version: 1.0
References: <CAHut+Pv-kSN8SkxSdoHano_wPubqcg5789ejhCDZAcLFceBR-w@mail.gmail.com>
 <CAHut+PuDSj_knEzfXx+v9_-15XYSJAuFmpgubh8rN4nWjFMdUg@mail.gmail.com>
 <2CCB9293-BB93-44DC-8B6E-4C1D163C625B@yesql.se> <2758485.1698848717@sss.pgh.pa.us>
In-Reply-To: <2758485.1698848717@sss.pgh.pa.us>
From: Peter Smith <smithpb2250@gmail.com>
Date: Thu, 9 Nov 2023 12:55:44 +1100
Message-ID: <CAHut+Pv8VG7fvXzg5PNeQuUhJG17xwCWNpZSUUkN11ArV==Cdg@mail.gmail.com>
Subject: Re: GUC names in messages
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Daniel Gustafsson <daniel@yesql.se>, 
	PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Content-Type: multipart/mixed; boundary="0000000000000f6c100609ae8277"
Archived-At: <https://www.postgresql.org/message-id/CAHut%2BPv8VG7fvXzg5PNeQuUhJG17xwCWNpZSUUkN11ArV%3D%3DCdg%40mail.gmail.com>
Precedence: bulk

--0000000000000f6c100609ae8277
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Thu, Nov 2, 2023 at 1:25=E2=80=AFAM Tom Lane <tgl@sss.pgh.pa.us> wrote:
>
...
> Our error message style guidelines say not to assemble messages out
> of separate parts, because it makes translation difficult.  Originally
> we applied that rule to GUC names mentioned in messages as well.
> Awhile ago the translation team decided that that made for too many
> duplicative translations, so they'd be willing to compromise on
> substituting GUC names.  That's only been changed in a haphazard
> fashion though, mostly in cases where there actually were duplicative
> messages that could be merged this way.  And there's never been any
> real clarity about whether to quote GUC names, though certainly we're
> more likely to quote anything injected with %s.  So that's why we have
> a mishmash right now.

Right. While looking at all the messages I observed a number of them
having almost the same (but not quite the same) wording:

For example,

errhint("Consider increasing the configuration parameter \"max_wal_size\"."=
)));
errhint("You might need to increase %s.", "max_locks_per_transaction")));
errhint("You might need to increase %s.", "max_pred_locks_per_transaction")=
));
errmsg("could not find free replication state, increase
max_replication_slots")));
hint ? errhint("You might need to increase %s.", "max_slot_wal_keep_size") =
: 0);
errhint("You may need to increase max_worker_processes.")));
errhint("Consider increasing configuration parameter
\"max_worker_processes\".")));
errhint("Consider increasing the configuration parameter
\"max_worker_processes\".")));
errhint("You might need to increase %s.", "max_worker_processes")));
errhint("You may need to increase max_worker_processes.")));
errhint("You might need to increase %s.", "max_logical_replication_workers"=
)));

~

The most common pattern there is "You might need to increase %s.".

Here is a patch to modify those other similar variations so they share
that common wording.

PSA.

=3D=3D=3D=3D=3D=3D
Kind Regards,
Peter Smith.
Fujitsu Australia

--0000000000000f6c100609ae8277
Content-Type: application/octet-stream; 
	name="v1-0001-Use-a-common-message-for-increasing-a-GUC.patch"
Content-Disposition: attachment; 
	filename="v1-0001-Use-a-common-message-for-increasing-a-GUC.patch"
Content-Transfer-Encoding: base64
Content-ID: <f_loqjca040>
X-Attachment-Id: f_loqjca040

RnJvbSA1NzUwMTgzY2IzMjM2ZmVkZTJlMmQwNjE1NDRiYWE1NDc4M2YxZmQ4IE1vbiBTZXAgMTcg
MDA6MDA6MDAgMjAwMQpGcm9tOiBQZXRlciBTbWl0aCA8cGV0ZXIuYi5zbWl0aEBmdWppdHN1LmNv
bT4KRGF0ZTogVGh1LCA5IE5vdiAyMDIzIDEyOjM0OjE1ICsxMTAwClN1YmplY3Q6IFtQQVRDSCB2
MV0gVXNlIGEgY29tbW9uIG1lc3NhZ2UgZm9yIGluY3JlYXNpbmcgYSBHVUMKCi0tLQogY29udHJp
Yi9wZ19wcmV3YXJtL2F1dG9wcmV3YXJtLmMgICAgICAgICB8IDQgKystLQogc3JjL2JhY2tlbmQv
cG9zdG1hc3Rlci9iZ3dvcmtlci5jICAgICAgICB8IDIgKy0KIHNyYy9iYWNrZW5kL3Bvc3RtYXN0
ZXIvY2hlY2twb2ludGVyLmMgICAgfCAyICstCiBzcmMvYmFja2VuZC9yZXBsaWNhdGlvbi9sb2dp
Y2FsL29yaWdpbi5jIHwgNCArKystCiBzcmMvdGVzdC9tb2R1bGVzL3Rlc3Rfc2htX21xL3NldHVw
LmMgICAgIHwgMiArLQogNSBmaWxlcyBjaGFuZ2VkLCA4IGluc2VydGlvbnMoKyksIDYgZGVsZXRp
b25zKC0pCgpkaWZmIC0tZ2l0IGEvY29udHJpYi9wZ19wcmV3YXJtL2F1dG9wcmV3YXJtLmMgYi9j
b250cmliL3BnX3ByZXdhcm0vYXV0b3ByZXdhcm0uYwppbmRleCBkMGVmYzllLi5kYWYwYmNlIDEw
MDY0NAotLS0gYS9jb250cmliL3BnX3ByZXdhcm0vYXV0b3ByZXdhcm0uYworKysgYi9jb250cmli
L3BnX3ByZXdhcm0vYXV0b3ByZXdhcm0uYwpAQCAtODQxLDcgKzg0MSw3IEBAIGFwd19zdGFydF9s
ZWFkZXJfd29ya2VyKHZvaWQpCiAJCWVyZXBvcnQoRVJST1IsCiAJCQkJKGVycmNvZGUoRVJSQ09E
RV9JTlNVRkZJQ0lFTlRfUkVTT1VSQ0VTKSwKIAkJCQkgZXJybXNnKCJjb3VsZCBub3QgcmVnaXN0
ZXIgYmFja2dyb3VuZCBwcm9jZXNzIiksCi0JCQkJIGVycmhpbnQoIllvdSBtYXkgbmVlZCB0byBp
bmNyZWFzZSBtYXhfd29ya2VyX3Byb2Nlc3Nlcy4iKSkpOworCQkJCSBlcnJoaW50KCJZb3UgbWln
aHQgbmVlZCB0byBpbmNyZWFzZSAlcy4iLCAibWF4X3dvcmtlcl9wcm9jZXNzZXMiKSkpOwogCiAJ
c3RhdHVzID0gV2FpdEZvckJhY2tncm91bmRXb3JrZXJTdGFydHVwKGhhbmRsZSwgJnBpZCk7CiAJ
aWYgKHN0YXR1cyAhPSBCR1dIX1NUQVJURUQpCkBAIC04NzcsNyArODc3LDcgQEAgYXB3X3N0YXJ0
X2RhdGFiYXNlX3dvcmtlcih2b2lkKQogCQllcmVwb3J0KEVSUk9SLAogCQkJCShlcnJjb2RlKEVS
UkNPREVfSU5TVUZGSUNJRU5UX1JFU09VUkNFUyksCiAJCQkJIGVycm1zZygicmVnaXN0ZXJpbmcg
ZHluYW1pYyBiZ3dvcmtlciBhdXRvcHJld2FybSBmYWlsZWQiKSwKLQkJCQkgZXJyaGludCgiQ29u
c2lkZXIgaW5jcmVhc2luZyBjb25maWd1cmF0aW9uIHBhcmFtZXRlciBcIm1heF93b3JrZXJfcHJv
Y2Vzc2VzXCIuIikpKTsKKwkJCQkgZXJyaGludCgiWW91IG1pZ2h0IG5lZWQgdG8gaW5jcmVhc2Ug
JXMuIiwgIm1heF93b3JrZXJfcHJvY2Vzc2VzIikpKTsKIAogCS8qCiAJICogSWdub3JlIHJldHVy
biB2YWx1ZTsgaWYgaXQgZmFpbHMsIHBvc3RtYXN0ZXIgaGFzIGRpZWQsIGJ1dCB3ZSBoYXZlCmRp
ZmYgLS1naXQgYS9zcmMvYmFja2VuZC9wb3N0bWFzdGVyL2Jnd29ya2VyLmMgYi9zcmMvYmFja2Vu
ZC9wb3N0bWFzdGVyL2Jnd29ya2VyLmMKaW5kZXggNDhhOTkyNC4uN2E4YzhhZiAxMDA2NDQKLS0t
IGEvc3JjL2JhY2tlbmQvcG9zdG1hc3Rlci9iZ3dvcmtlci5jCisrKyBiL3NyYy9iYWNrZW5kL3Bv
c3RtYXN0ZXIvYmd3b3JrZXIuYwpAQCAtOTQ0LDcgKzk0NCw3IEBAIFJlZ2lzdGVyQmFja2dyb3Vu
ZFdvcmtlcihCYWNrZ3JvdW5kV29ya2VyICp3b3JrZXIpCiAJCQkJCQkJCSAgIlVwIHRvICVkIGJh
Y2tncm91bmQgd29ya2VycyBjYW4gYmUgcmVnaXN0ZXJlZCB3aXRoIHRoZSBjdXJyZW50IHNldHRp
bmdzLiIsCiAJCQkJCQkJCSAgbWF4X3dvcmtlcl9wcm9jZXNzZXMsCiAJCQkJCQkJCSAgbWF4X3dv
cmtlcl9wcm9jZXNzZXMpLAotCQkJCSBlcnJoaW50KCJDb25zaWRlciBpbmNyZWFzaW5nIHRoZSBj
b25maWd1cmF0aW9uIHBhcmFtZXRlciBcIm1heF93b3JrZXJfcHJvY2Vzc2VzXCIuIikpKTsKKwkJ
CQkgZXJyaGludCgiWW91IG1pZ2h0IG5lZWQgdG8gaW5jcmVhc2UgJXMuIiwgIm1heF93b3JrZXJf
cHJvY2Vzc2VzIikpKTsKIAkJcmV0dXJuOwogCX0KIApkaWZmIC0tZ2l0IGEvc3JjL2JhY2tlbmQv
cG9zdG1hc3Rlci9jaGVja3BvaW50ZXIuYyBiL3NyYy9iYWNrZW5kL3Bvc3RtYXN0ZXIvY2hlY2tw
b2ludGVyLmMKaW5kZXggYTNjMWFiYS4uM2RhYjVmOCAxMDA2NDQKLS0tIGEvc3JjL2JhY2tlbmQv
cG9zdG1hc3Rlci9jaGVja3BvaW50ZXIuYworKysgYi9zcmMvYmFja2VuZC9wb3N0bWFzdGVyL2No
ZWNrcG9pbnRlci5jCkBAIC00MjMsNyArNDIzLDcgQEAgQ2hlY2twb2ludGVyTWFpbih2b2lkKQog
CQkJCQkJCQkJICAgImNoZWNrcG9pbnRzIGFyZSBvY2N1cnJpbmcgdG9vIGZyZXF1ZW50bHkgKCVk
IHNlY29uZHMgYXBhcnQpIiwKIAkJCQkJCQkJCSAgIGVsYXBzZWRfc2VjcywKIAkJCQkJCQkJCSAg
IGVsYXBzZWRfc2VjcyksCi0JCQkJCQkgZXJyaGludCgiQ29uc2lkZXIgaW5jcmVhc2luZyB0aGUg
Y29uZmlndXJhdGlvbiBwYXJhbWV0ZXIgXCJtYXhfd2FsX3NpemVcIi4iKSkpOworCQkJCQkJIGVy
cmhpbnQoIllvdSBtaWdodCBuZWVkIHRvIGluY3JlYXNlICVzLiIsICJtYXhfd2FsX3NpemUiKSkp
OwogCiAJCQkvKgogCQkJICogSW5pdGlhbGl6ZSBjaGVja3BvaW50ZXItcHJpdmF0ZSB2YXJpYWJs
ZXMgdXNlZCBkdXJpbmcKZGlmZiAtLWdpdCBhL3NyYy9iYWNrZW5kL3JlcGxpY2F0aW9uL2xvZ2lj
YWwvb3JpZ2luLmMgYi9zcmMvYmFja2VuZC9yZXBsaWNhdGlvbi9sb2dpY2FsL29yaWdpbi5jCmlu
ZGV4IGIwMjU1ZmYuLmZjYTg5MjQgMTAwNjQ0Ci0tLSBhL3NyYy9iYWNrZW5kL3JlcGxpY2F0aW9u
L2xvZ2ljYWwvb3JpZ2luLmMKKysrIGIvc3JjL2JhY2tlbmQvcmVwbGljYXRpb24vbG9naWNhbC9v
cmlnaW4uYwpAQCAtNzk1LDcgKzc5NSw5IEBAIFN0YXJ0dXBSZXBsaWNhdGlvbk9yaWdpbih2b2lk
KQogCQlpZiAobGFzdF9zdGF0ZSA9PSBtYXhfcmVwbGljYXRpb25fc2xvdHMpCiAJCQllcmVwb3J0
KFBBTklDLAogCQkJCQkoZXJyY29kZShFUlJDT0RFX0NPTkZJR1VSQVRJT05fTElNSVRfRVhDRUVE
RUQpLAotCQkJCQkgZXJybXNnKCJjb3VsZCBub3QgZmluZCBmcmVlIHJlcGxpY2F0aW9uIHN0YXRl
LCBpbmNyZWFzZSBtYXhfcmVwbGljYXRpb25fc2xvdHMiKSkpOworCQkJCQkgZXJybXNnKCJjb3Vs
ZCBub3QgZmluZCBmcmVlIHJlcGxpY2F0aW9uIHN0YXRlIiksCisJCQkJCSBlcnJoaW50KCJZb3Ug
bWlnaHQgbmVlZCB0byBpbmNyZWFzZSAlcy4iLAorCQkJCQkJCSAibWF4X3JlcGxpY2F0aW9uX3Ns
b3RzIikpKTsKIAogCQkvKiBjb3B5IGRhdGEgdG8gc2hhcmVkIG1lbW9yeSAqLwogCQlyZXBsaWNh
dGlvbl9zdGF0ZXNbbGFzdF9zdGF0ZV0ucm9pZGVudCA9IGRpc2tfc3RhdGUucm9pZGVudDsKZGlm
ZiAtLWdpdCBhL3NyYy90ZXN0L21vZHVsZXMvdGVzdF9zaG1fbXEvc2V0dXAuYyBiL3NyYy90ZXN0
L21vZHVsZXMvdGVzdF9zaG1fbXEvc2V0dXAuYwppbmRleCBhYmM3OTM1Li5kMDA2NDhlIDEwMDY0
NAotLS0gYS9zcmMvdGVzdC9tb2R1bGVzL3Rlc3Rfc2htX21xL3NldHVwLmMKKysrIGIvc3JjL3Rl
c3QvbW9kdWxlcy90ZXN0X3NobV9tcS9zZXR1cC5jCkBAIC0yMzMsNyArMjMzLDcgQEAgc2V0dXBf
YmFja2dyb3VuZF93b3JrZXJzKGludCBud29ya2VycywgZHNtX3NlZ21lbnQgKnNlZykKIAkJCWVy
ZXBvcnQoRVJST1IsCiAJCQkJCShlcnJjb2RlKEVSUkNPREVfSU5TVUZGSUNJRU5UX1JFU09VUkNF
UyksCiAJCQkJCSBlcnJtc2coImNvdWxkIG5vdCByZWdpc3RlciBiYWNrZ3JvdW5kIHByb2Nlc3Mi
KSwKLQkJCQkJIGVycmhpbnQoIllvdSBtYXkgbmVlZCB0byBpbmNyZWFzZSBtYXhfd29ya2VyX3By
b2Nlc3Nlcy4iKSkpOworCQkJCQkgZXJyaGludCgiWW91IG1pZ2h0IG5lZWQgdG8gaW5jcmVhc2Ug
JXMuIiwgIm1heF93b3JrZXJfcHJvY2Vzc2VzIikpKTsKIAkJKyt3c3RhdGUtPm53b3JrZXJzOwog
CX0KIAotLSAKMS44LjMuMQoK
--0000000000000f6c100609ae8277--