PGDOCS - Integer configuration parameters should say "(integer)"

Started by Peter Smithover 3 years ago2 messages
#1Peter Smith
smithpb2250@gmail.com
1 attachment(s)

FYI, I happened to notice in the PG docs there are a few integer
configuration parameters that describe themselves as type "(int)"
instead of "(integer)".

It looked like a small mistake to me; there are only 3 of (int),
versus 148 of (integer).

~~~

doc\src\sgml\auth-delay.sgml:
29 <term>
30: <varname>auth_delay.milliseconds</varname> (<type>int</type>)
31 <indexterm>

doc\src\sgml\config.sgml:
4918 <varlistentry id="guc-max-logical-replication-workers"
xreflabel="max_logical_replication_workers">
4919: <term><varname>max_logical_replication_workers</varname>
(<type>int</type>)
4920 <indexterm>

doc\src\sgml\pgprewarm.sgml:
109 <term>
110: <varname>pg_prewarm.autoprewarm_interval</varname>
(<type>int</type>)
111 <indexterm>

~~~

PSA a small patch to correct those.

------
Kind Regards,
Peter Smith.
Fujitsu Australia

Attachments:

v1-0001-Use-type-integer-instead-of-type-int.patchapplication/octet-stream; name=v1-0001-Use-type-integer-instead-of-type-int.patchDownload
From 57c252ea7b3cb47a962e464556961d17737f40cf Mon Sep 17 00:00:00 2001
From: Peter Smith <peter.b.smith@fujitsu.com>
Date: Thu, 16 Jun 2022 19:14:42 +1000
Subject: [PATCH v1] Use type integer instead of type int

---
 doc/src/sgml/auth-delay.sgml | 2 +-
 doc/src/sgml/config.sgml     | 2 +-
 doc/src/sgml/pgprewarm.sgml  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/src/sgml/auth-delay.sgml b/doc/src/sgml/auth-delay.sgml
index bd3ef71..3bc9cfb 100644
--- a/doc/src/sgml/auth-delay.sgml
+++ b/doc/src/sgml/auth-delay.sgml
@@ -27,7 +27,7 @@
   <variablelist>
    <varlistentry>
     <term>
-     <varname>auth_delay.milliseconds</varname> (<type>int</type>)
+     <varname>auth_delay.milliseconds</varname> (<type>integer</type>)
      <indexterm>
       <primary><varname>auth_delay.milliseconds</varname> configuration parameter</primary>
      </indexterm>
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index ce7f682..6e74ffb 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4922,7 +4922,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
      <variablelist>
 
      <varlistentry id="guc-max-logical-replication-workers" xreflabel="max_logical_replication_workers">
-      <term><varname>max_logical_replication_workers</varname> (<type>int</type>)
+      <term><varname>max_logical_replication_workers</varname> (<type>integer</type>)
       <indexterm>
        <primary><varname>max_logical_replication_workers</varname> configuration parameter</primary>
       </indexterm>
diff --git a/doc/src/sgml/pgprewarm.sgml b/doc/src/sgml/pgprewarm.sgml
index 51afc5d..4e68812 100644
--- a/doc/src/sgml/pgprewarm.sgml
+++ b/doc/src/sgml/pgprewarm.sgml
@@ -107,7 +107,7 @@ autoprewarm_dump_now() RETURNS int8
   <variablelist>
    <varlistentry>
    <term>
-     <varname>pg_prewarm.autoprewarm_interval</varname> (<type>int</type>)
+     <varname>pg_prewarm.autoprewarm_interval</varname> (<type>integer</type>)
      <indexterm>
       <primary><varname>pg_prewarm.autoprewarm_interval</varname> configuration parameter</primary>
      </indexterm>
-- 
1.8.3.1

#2Michael Paquier
michael@paquier.xyz
In reply to: Peter Smith (#1)
Re: PGDOCS - Integer configuration parameters should say "(integer)"

On Thu, Jun 16, 2022 at 07:22:15PM +1000, Peter Smith wrote:

It looked like a small mistake to me; there are only 3 of (int),
versus 148 of (integer).

Grepping around, that's correct. Will fix.
--
Michael