Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit31e121d

Browse files
committed
doc: Improve some markups and some wording around archiving modules
This commit adds or fixes markups used in a couple of places in the docs(for <command>, <systemitem> and <literal>). While on it, thisclarifies some of the documentation added recently for archiving moduleswith archive_command, that would still be used as default choice if noexternal module is defined (though an archive module could as well usean archive_command).Author: Maxim YablokovDiscussion:https://postgr.es/m/b47ec4e8-6f6a-2aba-038e-d5db150b245e@postgrespro.ruBackpatch-through: 15
1 parent662ba72 commit31e121d

File tree

7 files changed

+31
-29
lines changed

7 files changed

+31
-29
lines changed

‎doc/src/sgml/adminpack.sgml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@
2222
functions in <xref linkend="functions-admin-genfile-table"/>, which
2323
provide read-only access.)
2424
Only files within the database cluster directory can be accessed, unless the
25-
user is a superuser or given privileges of one of the pg_read_server_files,
26-
or pg_write_server_files roles, as appropriate for the function, but either a
27-
relative or absolute path is allowable.
25+
user is a superuser or given privileges of one of the
26+
<literal>pg_read_server_files</literal> or
27+
<literal>pg_write_server_files</literal> roles, as appropriate for the
28+
function, but either a relative or absolute path is allowable.
2829
</para>
2930

3031
<table id="functions-adminpack-table">

‎doc/src/sgml/archive-modules.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ typedef bool (*ArchiveFileCB) (const char *file, const char *path);
112112
was successfully archived, which may include recycling or removing the
113113
original WAL file. If <literal>false</literal> is returned, the server will
114114
keep the original WAL file and retry archiving later.
115-
<literal>file</literal> will contain just the file name of the WAL file to
116-
archive, while <literal>path</literal> contains the full path of the WAL
117-
file (including the file name).
115+
<replaceable>file</replaceable> will contain just the file name of the WAL
116+
file toarchive, while <replaceable>path</replaceable> contains the full
117+
path of the WALfile (including the file name).
118118
</para>
119119
</sect2>
120120

‎doc/src/sgml/backup.sgml

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -668,9 +668,10 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 &amp;&amp; cp pg_wal/0
668668
<para>
669669
If the archive function emits an <literal>ERROR</literal> or
670670
<literal>FATAL</literal>, the archiver process aborts and gets restarted by
671-
the postmaster. If you are archiving via shell command, FATAL is emitted if
672-
the command is terminated by a signal (other than
673-
<systemitem>SIGTERM</systemitem> that is used as part of a server shutdown)
671+
the postmaster. If you are archiving via shell command,
672+
<literal>FATAL</literal> is emitted if the command is terminated by a signal
673+
(other than <systemitem>SIGTERM</systemitem>
674+
that is used as part of a server shutdown)
674675
or an error by the shell with an exit status greater than 125 (such as
675676
command not found). In such cases, the failure is not reported in
676677
<xref linkend="pg-stat-archiver-view"/>.
@@ -885,8 +886,9 @@ test ! -f /mnt/server/archivedir/00000001000000A900000065 &amp;&amp; cp pg_wal/0
885886
<listitem>
886887
<para>
887888
Connect to the server (it does not matter which database) as a user with
888-
rights to run pg_backup_start (superuser, or a user who has been granted
889-
EXECUTE on the function) and issue the command:
889+
rights to run <function>pg_backup_start</function> (superuser,
890+
or a user who has been granted <literal>EXECUTE</literal> on the
891+
function) and issue the command:
890892
<programlisting>
891893
SELECT pg_backup_start(label => 'label', fast => false);
892894
</programlisting>
@@ -958,11 +960,12 @@ SELECT * FROM pg_backup_stop(wait_for_archive => true);
958960
On a standby, <varname>archive_mode</varname> must be <literal>always</literal> in order
959961
for <function>pg_backup_stop</function> to wait.
960962
Archiving of these files happens automatically since you have
961-
already configured <varname>archive_library</varname>. In most cases this
962-
happens quickly, but you are advised to monitor your archive
963-
system to ensure there are no delays.
964-
If the archive process has fallen behind
965-
because of failures of the archive library, it will keep retrying
963+
already configured <varname>archive_library</varname> or
964+
<varname>archive_command</varname>.
965+
In most cases this happens quickly, but you are advised to monitor your
966+
archive system to ensure there are no delays.
967+
If the archive process has fallen behind because of failures of the
968+
archive library or archive command, it will keep retrying
966969
until the archive succeeds and the backup is complete.
967970
If you wish to place a time limit on the execution of
968971
<function>pg_backup_stop</function>, set an appropriate

‎doc/src/sgml/basebackup-to-shell.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
<para>
1111
<filename>basebackup_to_shell</filename> adds a custom basebackup target
1212
called <literal>shell</literal>. This makes it possible to run
13-
<literal>pg_basebackup --target=shell</literal> or, depending on how this
13+
<command>pg_basebackup --target=shell</command> or, depending on how this
1414
module is configured,
15-
<literal>pg_basebackup --target=shell:DETAIL_STRING</literal>, and cause
16-
a server command chosen by the server administrator to be executed for
17-
each tar archive generated by the backup process. The command will receive
15+
<command>pg_basebackup --target=shell:<replaceable>DETAIL_STRING</replaceable></command>,
16+
and causea server command chosen by the server administrator to be executed
17+
foreach tar archive generated by the backup process. The command will receive
1818
the contents of the archive via standard input.
1919
</para>
2020

‎doc/src/sgml/ref/alter_publication.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ ALTER PUBLICATION <replaceable class="parameter">name</replaceable> RENAME TO <r
121121
with different column lists is not supported. So, changing the column
122122
lists of the tables being subscribed could cause inconsistency of column
123123
lists among publications, in which case <command>ALTER PUBLICATION</command>
124-
will be successful but later theWalSender on the publisher or the
124+
will be successful but later thewalsender on the publisher or the
125125
subscriber may throw an error. In this scenario, the user needs to
126126
recreate the subscription after adjusting the column list or drop the
127127
problematic publication using

‎doc/src/sgml/ref/pg_basebackup.sgml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,7 @@ PostgreSQL documentation
101101
<listitem>
102102
<para>
103103
All WAL records required for the backup must contain sufficient full-page writes,
104-
which requires you to enable <varname>full_page_writes</varname> on the primary and
105-
not to use a tool in your <varname>archive_library</varname> to remove
106-
full-page writes from WAL files.
104+
which requires you to enable <varname>full_page_writes</varname> on the primary.
107105
</para>
108106
</listitem>
109107
</itemizedlist>

‎doc/src/sgml/ref/psql-ref.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4658,10 +4658,10 @@ testdb=&gt; \set PROMPT1 '%[%033[1;33;40m%]%n@%/%R%[%033[0m%]%# '
46584658
and SQL object names in many (by no means all) contexts. For example,
46594659
at the start of a command, typing <literal>ins</literal> and pressing
46604660
TAB will fill in <literal>insert into </literal>. Then, typing a few
4661-
characters of a table or schema name and pressing TAB will fill in the
4662-
unfinished name, or offer a menu of possible completions when there's
4663-
more than one. (Depending on the library in use, you may need to
4664-
press TAB more than once to get a menu.)
4661+
characters of a table or schema name and pressing<literal>TAB</literal>
4662+
will fill in theunfinished name, or offer a menu of possible completions
4663+
when there'smore than one. (Depending on the library in use, you may need to
4664+
press<literal>TAB</literal> more than once to get a menu.)
46654665
</para>
46664666

46674667
<para>
@@ -4690,7 +4690,7 @@ $endif
46904690
of <application>psql</application>. This prevents tab completion,
46914691
use or recording of command line history, and editing of multi-line
46924692
commands. It is particularly useful when you need to copy-and-paste
4693-
text that contains TAB characters.
4693+
text that contains<literal>TAB</literal> characters.
46944694
</para>
46954695
</refsect3>
46964696
</refsect2>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp