Skip to content

Commit 9198e63

Browse files
committed
doc: Standardize capitalization of term "hot standby"/"Hot Standby"
"Hot Standby" was capitalized in a couple of places in the docs, as the style primarily used when it was introduced, but this has not been much respected across the years. Per discussion, it is more natural for the reader to use "hot standby" (aka lower-case only) when in the middle of a sentence, and "Hot standby" (aka capitalized) in a title. This commit adjusts all the places in the docs to be consistent with this choice, rather than applying one style or the other midway. Author: Daniel Westermann Reviewed-by: Kyotaro Horiguchi, Aleksander Alekseev, Robert Treat Discussion: https://postgr.es/m/GVAP278MB093160025A779A1A5788D0EAD2039@GVAP278MB0931.CHEP278.PROD.OUTLOOK.COM
1 parent e953732 commit 9198e63

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

doc/src/sgml/amcheck.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ ORDER BY c.relpages DESC LIMIT 10;
174174
hypothetically, undiscovered bugs in the underlying B-Tree index
175175
access method code. Note that
176176
<function>bt_index_parent_check</function> cannot be used when
177-
Hot Standby mode is enabled (i.e., on read-only physical
177+
hot standby mode is enabled (i.e., on read-only physical
178178
replicas), unlike <function>bt_index_check</function>.
179179
</para>
180180
</listitem>

doc/src/sgml/config.sgml

+3-3
Original file line numberDiff line numberDiff line change
@@ -4553,7 +4553,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
45534553
</term>
45544554
<listitem>
45554555
<para>
4556-
When Hot Standby is active, this parameter determines how long the
4556+
When hot standby is active, this parameter determines how long the
45574557
standby server should wait before canceling standby queries that
45584558
conflict with about-to-be-applied WAL entries, as described in
45594559
<xref linkend="hot-standby-conflict"/>.
@@ -4585,7 +4585,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
45854585
</term>
45864586
<listitem>
45874587
<para>
4588-
When Hot Standby is active, this parameter determines how long the
4588+
When hot standby is active, this parameter determines how long the
45894589
standby server should wait before canceling standby queries that
45904590
conflict with about-to-be-applied WAL entries, as described in
45914591
<xref linkend="hot-standby-conflict"/>.
@@ -10890,7 +10890,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
1089010890
Enables logging of recovery-related debugging output that otherwise
1089110891
would not be logged. This parameter allows the user to override the
1089210892
normal setting of <xref linkend="guc-log-min-messages"/>, but only for
10893-
specific messages. This is intended for use in debugging Hot Standby.
10893+
specific messages. This is intended for use in debugging hot standby.
1089410894
Valid values are <literal>DEBUG5</literal>, <literal>DEBUG4</literal>,
1089510895
<literal>DEBUG3</literal>, <literal>DEBUG2</literal>, <literal>DEBUG1</literal>, and
1089610896
<literal>LOG</literal>. The default, <literal>LOG</literal>, does not affect

doc/src/sgml/high-availability.sgml

+13-13
Original file line numberDiff line numberDiff line change
@@ -548,8 +548,8 @@ protocol to make nodes agree on a serializable transactional order.
548548
rollforward will take considerably longer, so that technique only
549549
offers a solution for disaster recovery, not high availability.
550550
A standby server can also be used for read-only queries, in which case
551-
it is called a Hot Standby server. See <xref linkend="hot-standby"/> for
552-
more information.
551+
it is called a <firstterm>hot standby</firstterm> server. See
552+
<xref linkend="hot-standby"/> for more information.
553553
</para>
554554

555555
<indexterm zone="high-availability">
@@ -1032,7 +1032,7 @@ primary_slot_name = 'node_a_slot'
10321032
</para>
10331033

10341034
<para>
1035-
Hot Standby feedback propagates upstream, whatever the cascaded arrangement.
1035+
Hot standby feedback propagates upstream, whatever the cascaded arrangement.
10361036
</para>
10371037

10381038
<para>
@@ -1499,16 +1499,16 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
14991499
<title>Hot Standby</title>
15001500

15011501
<indexterm zone="high-availability">
1502-
<primary>Hot Standby</primary>
1502+
<primary>hot standby</primary>
15031503
</indexterm>
15041504

15051505
<para>
1506-
Hot Standby is the term used to describe the ability to connect to
1506+
Hot standby is the term used to describe the ability to connect to
15071507
the server and run read-only queries while the server is in archive
15081508
recovery or standby mode. This
15091509
is useful both for replication purposes and for restoring a backup
15101510
to a desired state with great precision.
1511-
The term Hot Standby also refers to the ability of the server to move
1511+
The term hot standby also refers to the ability of the server to move
15121512
from recovery through to normal operation while users continue running
15131513
queries and/or keep their connections open.
15141514
</para>
@@ -1623,7 +1623,7 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
16231623
being executed during recovery. This restriction applies even to
16241624
temporary tables, because table rows cannot be read or written without
16251625
assigning a transaction ID, which is currently not possible in a
1626-
Hot Standby environment.
1626+
hot standby environment.
16271627
</para>
16281628
</listitem>
16291629
<listitem>
@@ -1703,7 +1703,7 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
17031703
<para>
17041704
In normal operation, <quote>read-only</quote> transactions are allowed to
17051705
use <command>LISTEN</command> and <command>NOTIFY</command>,
1706-
so Hot Standby sessions operate under slightly tighter
1706+
so hot standby sessions operate under slightly tighter
17071707
restrictions than ordinary read-only sessions. It is possible that some
17081708
of these restrictions might be loosened in a future release.
17091709
</para>
@@ -1746,7 +1746,7 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
17461746
</para>
17471747

17481748
<para>
1749-
There are also additional types of conflict that can occur with Hot Standby.
1749+
There are also additional types of conflict that can occur with hot standby.
17501750
These conflicts are <emphasis>hard conflicts</emphasis> in the sense that queries
17511751
might need to be canceled and, in some cases, sessions disconnected to resolve them.
17521752
The user is provided with several ways to handle these
@@ -1947,8 +1947,8 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
19471947
If <varname>hot_standby</varname> is <literal>on</literal> in <filename>postgresql.conf</filename>
19481948
(the default value) and there is a
19491949
<link linkend="file-standby-signal"><filename>standby.signal</filename></link><indexterm><primary>standby.signal</primary><secondary>for hot standby</secondary></indexterm>
1950-
file present, the server will run in Hot Standby mode.
1951-
However, it may take some time for Hot Standby connections to be allowed,
1950+
file present, the server will run in hot standby mode.
1951+
However, it may take some time for hot standby connections to be allowed,
19521952
because the server will not accept connections until it has completed
19531953
sufficient recovery to provide a consistent state against which queries
19541954
can run. During this period,
@@ -2282,7 +2282,7 @@ HINT: You can then restart the server after making the necessary configuration
22822282
<title>Caveats</title>
22832283

22842284
<para>
2285-
There are several limitations of Hot Standby.
2285+
There are several limitations of hot standby.
22862286
These can and probably will be fixed in future releases:
22872287

22882288
<itemizedlist>
@@ -2299,7 +2299,7 @@ HINT: You can then restart the server after making the necessary configuration
22992299
<para>
23002300
Valid starting points for standby queries are generated at each
23012301
checkpoint on the primary. If the standby is shut down while the primary
2302-
is in a shutdown state, it might not be possible to re-enter Hot Standby
2302+
is in a shutdown state, it might not be possible to re-enter hot standby
23032303
until the primary is started up, so that it generates further starting
23042304
points in the WAL logs. This situation isn't a problem in the most
23052305
common situations where it might happen. Generally, if the primary is

doc/src/sgml/mvcc.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1741,7 +1741,7 @@ SELECT pg_advisory_lock(q.id) FROM
17411741

17421742
<para>
17431743
Support for the Serializable transaction isolation level has not yet
1744-
been added to Hot Standby replication targets (described in
1744+
been added to hot standby replication targets (described in
17451745
<xref linkend="hot-standby"/>). The strictest isolation level currently
17461746
supported in hot standby mode is Repeatable Read. While performing all
17471747
permanent database writes within Serializable transactions on the

doc/src/sgml/protocol.sgml

+3-3
Original file line numberDiff line numberDiff line change
@@ -2417,7 +2417,7 @@ The commands accepted in replication mode are:
24172417
<variablelist>
24182418
<varlistentry id="protocol-replication-hot-standby-feedback-message">
24192419
<term>
2420-
Hot Standby feedback message (F)
2420+
Hot standby feedback message (F)
24212421
</term>
24222422
<listitem>
24232423
<para>
@@ -2428,7 +2428,7 @@ The commands accepted in replication mode are:
24282428
</term>
24292429
<listitem>
24302430
<para>
2431-
Identifies the message as a Hot Standby feedback message.
2431+
Identifies the message as a hot standby feedback message.
24322432
</para>
24332433
</listitem>
24342434
</varlistentry>
@@ -2451,7 +2451,7 @@ The commands accepted in replication mode are:
24512451
<para>
24522452
The standby's current global xmin, excluding the catalog_xmin from any
24532453
replication slots. If both this value and the following
2454-
catalog_xmin are 0 this is treated as a notification that Hot Standby
2454+
catalog_xmin are 0 this is treated as a notification that hot standby
24552455
feedback will no longer be sent on this connection. Later non-zero
24562456
messages may reinitiate the feedback mechanism.
24572457
</para>

0 commit comments

Comments
 (0)