Re: [PATCH] Doc: Mention OFF as an alias for EXPLAIN SERIALIZE NONE - Mailing list pgsql-hackers

From ZizhuanLiu X-MAN
Subject Re: [PATCH] Doc: Mention OFF as an alias for EXPLAIN SERIALIZE NONE
Date
Msg-id tencent_BCE037DB8468792726BE792CB9A8E51BC309@qq.com
Whole thread
In response to Re: [PATCH] Doc: Mention OFF as an alias for EXPLAIN SERIALIZE NONE  (Kyotaro Horiguchi <horikyota.ntt@gmail.com>)
List 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@qq.com
Attachment

pgsql-hackers by date:

Previous
From: Tomas Vondra
Date:
Subject: Re: Subquery pull-up increases jointree search space
Next
From: Nazir Bilal Yavuz
Date:
Subject: Re: ci: CCache churns through available space too quickly