public inbox for [email protected]
help / color / mirror / Atom feedFrom: =?utf-8?B?Wml6aHVhbkxpdSBYLU1BTg==?= <[email protected]>
To: =?utf-8?B?S3lvdGFybyBIb3JpZ3VjaGk=?= <[email protected]>
Cc: =?utf-8?B?cGdzcWwtaGFja2Vycw==?= <[email protected]>
Cc: =?utf-8?B?5oiR6Ieq5bex55qE6YKu566x?= <[email protected]>
Subject: Re: [PATCH] Doc: Mention OFF as an alias for EXPLAIN SERIALIZE NONE
Date: Mon, 8 Jun 2026 23:31:21 +0800
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
<[email protected]>
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)
[email protected]
Attachments:
[application/octet-stream] v2-0001-DOCS-Mention-OFF-as-an-alias-for-EXPLAIN-SERIALIZ.patch (1.2K, 2-v2-0001-DOCS-Mention-OFF-as-an-alias-for-EXPLAIN-SERIALIZ.patch)
download | inline diff:
From 08ab0cc42c9dea209c3285111daeb7bfe348be67 Mon Sep 17 00:00:00 2001
From: "ZizhuanLiu(X-MAN)" <[email protected]>
Date: Mon, 8 Jun 2026 23:08:23 +0800
Subject: [PATCH v2] DOCS:Mention OFF as an alias for EXPLAIN SERIALIZE NONE
---
doc/src/sgml/ref/explain.sgml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml
index e95e190..5beefe8 100644
--- a/doc/src/sgml/ref/explain.sgml
+++ b/doc/src/sgml/ref/explain.sgml
@@ -222,8 +222,8 @@ ROLLBACK;
execution of the query, if the datatype output functions are
expensive or if <acronym>TOAST</acronym>ed values must be fetched
from out-of-line storage. <command>EXPLAIN</command>'s default
- behavior, <literal>SERIALIZE NONE</literal>, does not perform these
- conversions. If <literal>SERIALIZE TEXT</literal>
+ behavior, <literal>SERIALIZE NONE</literal>(or <literal>OFF</literal>),
+ does not perform these conversions. If <literal>SERIALIZE TEXT</literal>
or <literal>SERIALIZE BINARY</literal> is specified, the appropriate
conversions are performed, and the time spent doing so is measured
(unless <literal>TIMING OFF</literal> is specified). If
--
2.43.0
[application/octet-stream] sql-explain.html (24.1K, 3-sql-explain.html)
download
[application/octet-stream] EXPLAIN.7 (17.8K, 4-EXPLAIN.7)
download
view thread (3+ messages)
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected], [email protected]
Subject: Re: [PATCH] Doc: Mention OFF as an alias for EXPLAIN SERIALIZE NONE
In-Reply-To: <[email protected]>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox