Is the doc for SHOW somewhat stale?

Поиск
Список
Период
Сортировка
От Kyotaro Horiguchi
Тема Is the doc for SHOW somewhat stale?
Дата
Msg-id 20201006.165333.509085019657825445.horikyota.ntt@gmail.com
обсуждение исходный текст
Ответы Re: Is the doc for SHOW somewhat stale?  (Fujii Masao <masao.fujii@oss.nttdata.com>)
Список pgsql-hackers
Hello.

If I read the documentation of the SHOW command, it says:

https://www.postgresql.org/docs/13/sql-show.html

> name 
>   The name of a run-time parameter. Available parameters are documented
>   in Chapter 19 and on the SET reference page. In addition, there are a
>   few parameters that can be shown but not set:
>      SERVER_VERSION
>      SERVER_ENCODING
>      LC_COLLATE
>      LC_CTYPE
>      IS_SUPERUSER
> ALL
>   Show the values of all configuration parameters, with descriptions.

It seems to me GUC variables of PGC_INTERNAL are shown above, but
there are 13 other variables of that context.  On the other hand
is_superuser is not shown in pg_settings view nor by SHOW ALL
(GUC_NO_SHOW_ALL).

is_superuser is commented as the follows in guc.c:

> /* Not for general use --- used by SET SESSION AUTHORIZATION */

So, if I followed the current style of the page, we should:

 - remove IS_SUPERUSER  from the documentation.
 - add the 13 variables.

However, it seems better that that item simply points to "19.15 Preset
Options" instead, as attached.

By the way, SHOW ALL shows 329 rows as of PG13 whereas documentation
says 196 rows. (14 devel shows 331 rows.)

Thoughts?

regards.

-- 
Kyotaro Horiguchi
NTT Open Source Software Center
diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml
index 945b0491b1..5bb7a2ca1b 100644
--- a/doc/src/sgml/ref/show.sgml
+++ b/doc/src/sgml/ref/show.sgml
@@ -54,62 +54,8 @@ SHOW ALL
       documented in <xref linkend="runtime-config"/> and on the <xref
       linkend="sql-set"/> reference page.  In
       addition, there are a few parameters that can be shown but not
-      set:
-
-      <variablelist>
-       <varlistentry>
-        <term><literal>SERVER_VERSION</literal></term>
-        <listitem>
-         <para>
-          Shows the server's version number.
-         </para>
-        </listitem>
-       </varlistentry>
-
-       <varlistentry>
-        <term><literal>SERVER_ENCODING</literal></term>
-        <listitem>
-         <para>
-          Shows the server-side character set encoding.  At present,
-          this parameter can be shown but not set, because the
-          encoding is determined at database creation time.
-         </para>
-        </listitem>
-       </varlistentry>
-
-       <varlistentry>
-        <term><literal>LC_COLLATE</literal></term>
-        <listitem>
-         <para>
-          Shows the database's locale setting for collation (text
-          ordering).  At present, this parameter can be shown but not
-          set, because the setting is determined at database creation
-          time.
-         </para>
-        </listitem>
-       </varlistentry>
-
-       <varlistentry>
-        <term><literal>LC_CTYPE</literal></term>
-        <listitem>
-         <para>
-          Shows the database's locale setting for character
-          classification.  At present, this parameter can be shown but
-          not set, because the setting is determined at database creation
-          time.
-         </para>
-        </listitem>
-       </varlistentry>
-
-       <varlistentry>
-        <term><literal>IS_SUPERUSER</literal></term>
-        <listitem>
-         <para>
-          True if the current role has superuser privileges.
-         </para>
-        </listitem>
-       </varlistentry>
-      </variablelist></para>
+      set. See <xref linkend="runtime-config-preset"/> for details.
+     </para>
     </listitem>
    </varlistentry>
 
@@ -175,7 +121,7 @@ SHOW ALL;
     .
  xmloption               | content | Sets whether XML data in implicit parsing ...
  zero_damaged_pages      | off     | Continues processing past damaged page headers.
-(196 rows)
+(329 rows)
 </programlisting></para>
  </refsect1>


В списке pgsql-hackers по дате отправления:

Предыдущее
От: Masahiro Ikeda
Дата:
Сообщение: Re: New statistics for tuning WAL buffer size
Следующее
От: Craig Ringer
Дата:
Сообщение: Re: Add primary keys to system catalogs