From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: pgsql-docs@postgresql.org
Subject: list of flags that pg_settings_get_flags reports
Date: Fri, 15 Jul 2022 22:23:12 +0900
Message-ID: <f093edf9-6e5a-b119-ee50-6a2c97c79ee8@oss.nttdata.com> (raw)
Hi,
In the docs, the display of the list of flags that pg_settings_get_flags reports looks a bit odd to me [*1]. To make it smarter, how about using <itemizedlist> instead of <simplelist>, to list thoes flags within <row>? Patch attached.
Regards,
[*1] https://www.postgresql.org/docs/devel/functions-info.html#id-1.5.8.32.19.2.2.25.1.1.1
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
From 735f4f095516ac7b1d4d838aeada3acffb4ae036 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Fri, 15 Jul 2022 22:19:58 +0900
Subject: [PATCH] Improve pg_settings_get_flags docs.
---
doc/src/sgml/func.sgml | 52 +++++++++++++++++++++++++-----------------
1 file changed, 31 insertions(+), 21 deletions(-)
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgmlindex b6783b7ad0..f79a8e807c 100644--- a/doc/src/sgml/func.sgml+++ b/doc/src/sgml/func.sgml@@ -24976,27 +24976,37 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
<literal>NULL</literal> if it does not exist. The result is
an empty array if the GUC exists but there are no flags to show.
Only the most useful flags are exposed, as of the following:
- <simplelist>- <member>- <literal>EXPLAIN</literal>: parameters included in- <command>EXPLAIN (SETTINGS)</command> commands.- </member>- <member>- <literal>NO_SHOW_ALL</literal>: parameters excluded from- <command>SHOW ALL</command> commands.- </member>- <member>- <literal>NO_RESET_ALL</literal>: parameters excluded from- <command>RESET ALL</command> commands.- </member>- <member>- <literal>NOT_IN_SAMPLE</literal>: parameters not included in- <filename>postgresql.conf</filename> by default.- </member>- <member>- <literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.- </member>- </simplelist>+ <itemizedlist spacing="compact">+ <listitem>+ <para>+ <literal>EXPLAIN</literal>: parameters included in+ <command>EXPLAIN (SETTINGS)</command> commands.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>NO_SHOW_ALL</literal>: parameters excluded from+ <command>SHOW ALL</command> commands.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>NO_RESET_ALL</literal>: parameters excluded from+ <command>RESET ALL</command> commands.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>NOT_IN_SAMPLE</literal>: parameters not included in+ <filename>postgresql.conf</filename> by default.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.+ </para>+ </listitem>+ </itemizedlist>
</para></entry>
</row>
--
2.36.0
Attachments:
[text/plain] 0001-Improve-pg_settings_get_flags-docs.patch (2.6K, ../f093edf9-6e5a-b119-ee50-6a2c97c79ee8@oss.nttdata.com/2-0001-Improve-pg_settings_get_flags-docs.patch)
download | inline diff:
From 735f4f095516ac7b1d4d838aeada3acffb4ae036 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Fri, 15 Jul 2022 22:19:58 +0900
Subject: [PATCH] Improve pg_settings_get_flags docs.
---
doc/src/sgml/func.sgml | 52 +++++++++++++++++++++++++-----------------
1 file changed, 31 insertions(+), 21 deletions(-)
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgmlindex b6783b7ad0..f79a8e807c 100644--- a/doc/src/sgml/func.sgml+++ b/doc/src/sgml/func.sgml@@ -24976,27 +24976,37 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
<literal>NULL</literal> if it does not exist. The result is
an empty array if the GUC exists but there are no flags to show.
Only the most useful flags are exposed, as of the following:
- <simplelist>- <member>- <literal>EXPLAIN</literal>: parameters included in- <command>EXPLAIN (SETTINGS)</command> commands.- </member>- <member>- <literal>NO_SHOW_ALL</literal>: parameters excluded from- <command>SHOW ALL</command> commands.- </member>- <member>- <literal>NO_RESET_ALL</literal>: parameters excluded from- <command>RESET ALL</command> commands.- </member>- <member>- <literal>NOT_IN_SAMPLE</literal>: parameters not included in- <filename>postgresql.conf</filename> by default.- </member>- <member>- <literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.- </member>- </simplelist>+ <itemizedlist spacing="compact">+ <listitem>+ <para>+ <literal>EXPLAIN</literal>: parameters included in+ <command>EXPLAIN (SETTINGS)</command> commands.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>NO_SHOW_ALL</literal>: parameters excluded from+ <command>SHOW ALL</command> commands.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>NO_RESET_ALL</literal>: parameters excluded from+ <command>RESET ALL</command> commands.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>NOT_IN_SAMPLE</literal>: parameters not included in+ <filename>postgresql.conf</filename> by default.+ </para>+ </listitem>+ <listitem>+ <para>+ <literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.+ </para>+ </listitem>+ </itemizedlist>
</para></entry>
</row>
--
2.36.0
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: pgsql-docs@postgresql.org
Cc: masao.fujii@oss.nttdata.com
Subject: Re: list of flags that pg_settings_get_flags reports
In-Reply-To: <f093edf9-6e5a-b119-ee50-6a2c97c79ee8@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox