upstream/postgresql
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2026-03-22 18:33:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Add description of "filename" for pg_walsummary

Browse source 
This command requires an input file (WAL summary file), that has to be
specified without an option name.  The shape of the command and how to
use this parameter is implied in its synopsis.  However, this page
lacked a description of the parameter.  Listing parameters that do
not require an option is a common practice across the docs.  See for
example pg_dump, pg_restore, etc.

Author: Peter Smith <smithpb2250@gmail.com>
Discussion: https://postgr.es/m/CAHut+PtbQi8Dw_0upS9dd=Oh9OqfOdAo=0_DOKG=YSRT_a+0Fw@mail.gmail.com
This commit is contained in:
Michael Paquier 2026-02-22 15:12:58 +09:00
parent 0eeffd31bf
commit 4476106c65
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/src/sgml/ref/pg_walsummary.sgml
View file

@ -23,7 +23,7 @@ PostgreSQL documentation
<cmdsynopsis>
<command>pg_walsummary</command>
<arg rep="repeat" choice="opt"><replaceable>option</replaceable></arg>
<arg rep="repeat"><replaceable>file</replaceable></arg>
<arg rep="repeat"><replaceable>filename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -56,6 +56,16 @@ PostgreSQL documentation
<para>
<variablelist>
<varlistentry>
<term><replaceable class="parameter">filename</replaceable></term>
<listitem>
<para>
Specifies the name of a WAL summary file, found in the
<literal>pg_wal/summaries</literal> subdirectory of the data directory.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option></term>
<term><option>--individual</option></term>