pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedMinor doc fixes
7+ messages / 4 participants
[nested] [flat]
* Minor doc fixes
@ 2021-07-13 13:13 Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
0 siblings, 1 reply; 7+ messages in thread
From: Ekaterina Kiryanova @ 2021-07-13 13:13 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org
Hi!
I've noticed some minor doc inconsistencies.
Please review the attached patch.
--
Ekaterina Kiryanova
Technical Writer
Postgres Professional
Attachments:
[text/x-patch] minor-fixes.patch (2.9K, ../../c050ecbc-80b2-b360-3c1d-9fe6a6a11bb5@postgrespro.ru/2-minor-fixes.patch)
download | inline diff:
diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml
index a2571d33ae6..c570690b59c 100644
--- a/doc/src/sgml/amcheck.sgml
+++ b/doc/src/sgml/amcheck.sgml
@@ -279,7 +279,7 @@ SET client_min_messages = DEBUG1;
<para>
If specified, corruption checking begins at the specified block,
skipping all previous blocks. It is an error to specify a
- <literal>startblock</literal> outside the range of blocks in the
+ <parameter>startblock</parameter> outside the range of blocks in the
target table.
</para>
<para>
@@ -293,7 +293,7 @@ SET client_min_messages = DEBUG1;
<para>
If specified, corruption checking ends at the specified block,
skipping all remaining blocks. It is an error to specify an
- <literal>endblock</literal> outside the range of blocks in the target
+ <parameter>endblock</parameter> outside the range of blocks in the target
table.
</para>
<para>
diff --git a/doc/src/sgml/brin.sgml b/doc/src/sgml/brin.sgml
index 39c01dc6808..940563c83f9 100644
--- a/doc/src/sgml/brin.sgml
+++ b/doc/src/sgml/brin.sgml
@@ -716,7 +716,7 @@ LOG: request for BRIN range summarization for index "brin_wi_idx" page 128 was
</para>
<para>
- <acronym>bloom</acronym> operator classes accept these parameters:
+ <literal>bloom</literal> operator classes accept these parameters:
</para>
<variablelist>
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index f517a7d4aff..71ff9b8cc9f 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -7403,8 +7403,8 @@ SCRAM-SHA-256$<replaceable><iteration count></replaceable>:<replaceable>&l
An array containing codes for the enabled statistics kinds;
valid values are:
<literal>d</literal> for n-distinct statistics,
- <literal>f</literal> for functional dependency statistics, and
- <literal>m</literal> for most common values (MCV) list statistics
+ <literal>f</literal> for functional dependency statistics,
+ <literal>m</literal> for most common values (MCV) list statistics, and
<literal>e</literal> for expression statistics
</para></entry>
</row>
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 381d8636ab4..d64494186a7 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -7017,7 +7017,7 @@ local0.* /var/log/postgresql
</row>
<row>
<entry><literal>%Q</literal></entry>
- <entry>query identifier of the current query. Query
+ <entry>Query identifier of the current query. Query
identifiers are not computed by default, so this field
will be zero unless <xref linkend="guc-compute-query-id"/>
parameter is enabled or a third-party module that computes
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Minor doc fixes
@ 2021-07-13 21:32 Daniel Gustafsson <daniel@yesql.se>
parent: Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
0 siblings, 2 replies; 7+ messages in thread
From: Daniel Gustafsson @ 2021-07-13 21:32 UTC (permalink / raw)
To: Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>; +Cc: pgsql-docs@lists.postgresql.org
> On 13 Jul 2021, at 15:13, Ekaterina Kiryanova <e.kiryanova@postgrespro.ru> wrote:
> I've noticed some minor doc inconsistencies.
> Please review the attached patch.
Thanks for your patch, reviewing it I agree with your proposed changes. Unless
there are objections I'll apply this within a few days.
--
Daniel Gustafsson https://vmware.com/
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Minor doc fixes
@ 2021-07-14 05:28 Laurenz Albe <laurenz.albe@cybertec.at>
parent: Daniel Gustafsson <daniel@yesql.se>
1 sibling, 0 replies; 7+ messages in thread
From: Laurenz Albe @ 2021-07-14 05:28 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>; +Cc: pgsql-docs@lists.postgresql.org
On Tue, 2021-07-13 at 23:32 +0200, Daniel Gustafsson wrote:
> > On 13 Jul 2021, at 15:13, Ekaterina Kiryanova <e.kiryanova@postgrespro.ru> wrote:
> > I've noticed some minor doc inconsistencies.
> > Please review the attached patch.
>
> Thanks for your patch, reviewing it I agree with your proposed changes. Unless
> there are objections I'll apply this within a few days.
The changes look good to me as well.
Yours,
Laurenz Albe
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Minor doc fixes
@ 2021-07-15 21:31 Daniel Gustafsson <daniel@yesql.se>
parent: Daniel Gustafsson <daniel@yesql.se>
1 sibling, 0 replies; 7+ messages in thread
From: Daniel Gustafsson @ 2021-07-15 21:31 UTC (permalink / raw)
To: Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>; +Cc: pgsql-docs@lists.postgresql.org
> On 13 Jul 2021, at 23:32, Daniel Gustafsson <daniel@yesql.se> wrote:
>
>> On 13 Jul 2021, at 15:13, Ekaterina Kiryanova <e.kiryanova@postgrespro.ru> wrote:
>
>> I've noticed some minor doc inconsistencies.
>> Please review the attached patch.
>
> Thanks for your patch, reviewing it I agree with your proposed changes. Unless
> there are objections I'll apply this within a few days.
Applied to with a small edit to make the bloom operator class mention the same
as the minmax-multi, which previously also had an acronym tag (fixed in
fb72a7b8c3). I’ve backpatched it to v14 to match fb72a7b8c3. Thanks!
--
Daniel Gustafsson https://vmware.com/
^ permalink raw reply [nested|flat] 7+ messages in thread
* Minor doc fixes
@ 2021-09-27 08:42 Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
0 siblings, 1 reply; 7+ messages in thread
From: Ekaterina Kiryanova @ 2021-09-27 08:42 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org
Hi!
I've come across some minor inconsistencies in PostgreSQL 14 docs.
Please review the attached patch.
--
Ekaterina Kiryanova
Technical Writer
Postgres Professional
file:///home/ladyune/patches/minor_doc_fixes.patch
Attachments:
[text/x-patch] minor_doc_fixes.patch (6.9K, ../../8a14e78f-6991-7a6e-4711-fe376635f2ad@postgrespro.ru/2-minor_doc_fixes.patch)
download | inline diff:
diff --git a/doc/src/sgml/btree.sgml b/doc/src/sgml/btree.sgml
index f569f93f352..a9200ee52e6 100644
--- a/doc/src/sgml/btree.sgml
+++ b/doc/src/sgml/btree.sgml
@@ -664,7 +664,7 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
certain implementation-level heuristics will fail to identify and
delete even one garbage index tuple (in which case a page split or
deduplication pass resolves the issue of an incoming new tuple not
- fitting on a leaf page). The worst case number of versions that
+ fitting on a leaf page). The worst-case number of versions that
any index scan must traverse (for any single logical row) is an
important contributor to overall system responsiveness and
throughput. A bottom-up index deletion pass targets suspected
@@ -706,7 +706,7 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
This is expected with any B-Tree index that is subject to
significant version churn from <command>UPDATE</command>s that
rarely or never logically modify the columns that the index covers.
- The average and worst case number of versions per logical row can
+ The average and worst-case number of versions per logical row can
be kept low purely through targeted incremental deletion passes.
It's quite possible that the on-disk size of certain indexes will
never increase by even one single page/block despite
@@ -811,7 +811,7 @@ options(<replaceable>relopts</replaceable> <type>local_relopts *</type>) returns
constraints) to use deduplication. This allows leaf pages to
temporarily <quote>absorb</quote> extra version churn duplicates.
Deduplication in unique indexes augments bottom-up index deletion,
- especially in cases where a long-running transactions holds a
+ especially in cases where a long-running transaction holds a
snapshot that blocks garbage collection. The goal is to buy time
for the bottom-up index deletion strategy to become effective
again. Delaying page splits until a single long-running
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index 2f0def9b19a..0e590059e89 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -13116,7 +13116,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<structname>pg_stats_ext_exprs</structname> is also designed to present
the information in a more readable format than the underlying catalogs
— at the cost that its schema must be extended whenever the structure
- of statistics in <link linkend="catalog-pg-statistic"><structname>pg_statistic</structname></link> changes.
+ of statistics in <link linkend="catalog-pg-statistic-ext"><structname>pg_statistic_ext</structname></link> changes.
</para>
<table>
diff --git a/doc/src/sgml/ref/alter_subscription.sgml b/doc/src/sgml/ref/alter_subscription.sgml
index bec5e9c483f..db9713e6667 100644
--- a/doc/src/sgml/ref/alter_subscription.sgml
+++ b/doc/src/sgml/ref/alter_subscription.sgml
@@ -65,8 +65,8 @@ ALTER SUBSCRIPTION <replaceable class="parameter">name</replaceable> RENAME TO <
<para>
Commands <command>ALTER SUBSCRIPTION ... REFRESH PUBLICATION</command> and
- <command>ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ...</command> with refresh
- option as true cannot be executed inside a transaction block.
+ <command>ALTER SUBSCRIPTION ... {SET|ADD|DROP} PUBLICATION ...</command> with <literal>refresh</literal>
+ option as <literal>true</literal> cannot be executed inside a transaction block.
These commands also cannot be executed when the subscription has
<literal>two_phase</literal> commit enabled,
diff --git a/doc/src/sgml/ref/commit.sgml b/doc/src/sgml/ref/commit.sgml
index 5f244cdd3c1..43f9e984bcc 100644
--- a/doc/src/sgml/ref/commit.sgml
+++ b/doc/src/sgml/ref/commit.sgml
@@ -97,7 +97,7 @@ COMMIT;
<para>
The command <command>COMMIT</command> conforms to the SQL standard. The
- form <literal>COMMIT TRANSACTION</literal> is a PostgreSQL extension.
+ form <literal>COMMIT TRANSACTION</literal> is a <productname>PostgreSQL</productname> extension.
</para>
</refsect1>
diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml
index 3d888387126..9d47cacbe0b 100644
--- a/doc/src/sgml/ref/initdb.sgml
+++ b/doc/src/sgml/ref/initdb.sgml
@@ -283,7 +283,7 @@ PostgreSQL documentation
By default, <command>initdb</command> will write instructions for how
to start the cluster at the end of its output. This option causes
those instructions to be left out. This is primarily intended for use
- by tools that wrap <command>initdb</command> in platform specific
+ by tools that wrap <command>initdb</command> in platform-specific
behavior, where those instructions are likely to be incorrect.
</para>
</listitem>
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index fcab5c0d51a..5ef401916f2 100644
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -1936,9 +1936,9 @@ testdb=>
<para>
The status of each kind of extended statistics is shown in a column
named after its statistic kind (e.g. Ndistinct).
- "defined" means that it was requested when creating the statistics,
+ <literal>defined</literal> means that it was requested when creating the statistics,
and NULL means it wasn't requested.
- You can use pg_stats_ext if you'd like to know whether <link linkend="sql-analyze">
+ You can use <structname>pg_stats_ext</structname> if you'd like to know whether <link linkend="sql-analyze">
<command>ANALYZE</command></link> was run and statistics are available to the
planner.
</para>
diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml
index 18f1f3cdbd8..b8b6d6b8e7d 100644
--- a/doc/src/sgml/spgist.sgml
+++ b/doc/src/sgml/spgist.sgml
@@ -875,7 +875,7 @@ typedef struct spgLeafConsistentOut
<para>
Note: the <function>compress</function> method is only applied to
- values to be stored. The consistent methods receive query scankeys
+ values to be stored. The consistent methods receive query <structfield>scankeys</structfield>
unchanged, without transformation using <function>compress</function>.
</para>
</listitem>
diff --git a/doc/src/sgml/test-decoding.sgml b/doc/src/sgml/test-decoding.sgml
index fe7c9783fac..cf736bd41af 100644
--- a/doc/src/sgml/test-decoding.sgml
+++ b/doc/src/sgml/test-decoding.sgml
@@ -40,8 +40,8 @@ postgres=# SELECT * FROM pg_logical_slot_get_changes('test_slot', NULL, NULL, 'i
</para>
<para>
- We can also get the changes of the in-progress transaction and the typical
- output, might be:
+ We can also get the changes of the in-progress transaction, and the typical
+ output might be:
<programlisting>
postgres[33712]=#* SELECT * FROM pg_logical_slot_get_changes('test_slot', NULL, NULL, 'stream-changes', '1');
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Minor doc fixes
@ 2021-09-27 09:07 Michael Paquier <michael@paquier.xyz>
parent: Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
0 siblings, 1 reply; 7+ messages in thread
From: Michael Paquier @ 2021-09-27 09:07 UTC (permalink / raw)
To: Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>; +Cc: pgsql-docs@lists.postgresql.org
On Mon, Sep 27, 2021 at 11:42:40AM +0300, Ekaterina Kiryanova wrote:
> I've come across some minor inconsistencies in PostgreSQL 14 docs.
> Please review the attached patch.
Thanks. These are good catches.
--
Michael
Attachments:
[application/pgp-signature] signature.asc (832B, ../../YVGJ7WcMR0ylzE6R@paquier.xyz/2-signature.asc)
download
^ permalink raw reply [nested|flat] 7+ messages in thread
* Re: Minor doc fixes
@ 2021-09-29 02:57 Michael Paquier <michael@paquier.xyz>
parent: Michael Paquier <michael@paquier.xyz>
0 siblings, 0 replies; 7+ messages in thread
From: Michael Paquier @ 2021-09-29 02:57 UTC (permalink / raw)
To: Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>; +Cc: pgsql-docs@lists.postgresql.org
On Mon, Sep 27, 2021 at 06:07:57PM +0900, Michael Paquier wrote:
> Thanks. These are good catches.
Now that 14.0 has been tagged, applied.
--
Michael
Attachments:
[application/pgp-signature] signature.asc (832B, ../../YVPWNj1QF2Hv0cXS@paquier.xyz/2-signature.asc)
download
^ permalink raw reply [nested|flat] 7+ messages in thread
end of thread, other threads:[~2021-09-29 02:57 UTC | newest]
Thread overview: 7+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2021-07-13 13:13 Minor doc fixes Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
2021-07-13 21:32 ` Daniel Gustafsson <daniel@yesql.se>
2021-07-14 05:28 ` Laurenz Albe <laurenz.albe@cybertec.at>
2021-07-15 21:31 ` Daniel Gustafsson <daniel@yesql.se>
2021-09-27 08:42 Minor doc fixes Ekaterina Kiryanova <e.kiryanova@postgrespro.ru>
2021-09-27 09:07 ` Michael Paquier <michael@paquier.xyz>
2021-09-29 02:57 ` Michael Paquier <michael@paquier.xyz>
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