| From: | ZizhuanLiu X-MAN <44973863(at)qq(dot)com> |
|---|---|
| To: | Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com> |
| Cc: | pgsql-hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>, 我自己的邮箱 <44973863(at)qq(dot)com> |
| Subject: | Re: [PATCH] Doc: Mention OFF as an alias for EXPLAIN SERIALIZE NONE |
| Date: | 2026-06-08 15:31:21 |
| Message-ID: | tencent_BCE037DB8468792726BE792CB9A8E51BC309@qq.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
Hi Kyotaro,
Thanks a lot for your careful review and clear explanation of the community convention.
>Some enum-valued options accept boolean-style representations that are
>not mentioned in the documentation. In some cases this is simply an
>implementation detail, while in others it is provided as a convenience
>or for consistency with existing conventions.
Following your lead, I checked guc_tables.c and its corresponding official
documentation for GUC parameters, and noticed that OFF is commonly
documented as a valid enum/configuration option in many existing entries.
>Even so, if we do decide to mention it, the proposed wording feels a
>bit heavy to me. Something like "SERIALIZE NONE (or OFF)" would
>probably be sufficient.
So I fully agree with your suggestion to use minimal wording rather than
a separate explanatory paragraph. I will revise the docs to simply write
NONE (or OFF) as you proposed.
The patch has been recompiled, and the updated HTML documentation
and man 7 manual pages have been regenerated and verified.
regards,
--
ZizhuanLiu (X-MAN)
44973863(at)qq(dot)com
| Attachment | Content-Type | Size |
|---|---|---|
| v2-0001-DOCS-Mention-OFF-as-an-alias-for-EXPLAIN-SERIALIZ.patch | application/octet-stream | 1.2 KB |
| sql-explain.html | application/octet-stream | 24.1 KB |
| EXPLAIN.7 | application/octet-stream | 17.8 KB |
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Nathan Bossart | 2026-06-08 15:36:26 | Re: expand refint docs with usage info |
| Previous Message | Tomas Vondra | 2026-06-08 15:27:13 | Re: Subquery pull-up increases jointree search space |