Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 3886530

Browse files
committed
pg_combinebackup: Put newer options in consistent order in --help and man page
1 parent d80f2ce commit 3886530

File tree

2 files changed

+47
-47
lines changed

2 files changed

+47
-47
lines changed

doc/src/sgml/ref/pg_combinebackup.sgml

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,51 @@ PostgreSQL documentation
137137
</listitem>
138138
</varlistentry>
139139

140+
<varlistentry>
141+
<term><option>--clone</option></term>
142+
<listitem>
143+
<para>
144+
Use efficient file cloning (also known as <quote>reflinks</quote> on
145+
some systems) instead of copying files to the new data directory,
146+
which can result in near-instantaneous copying of the data files.
147+
</para>
148+
149+
<para>
150+
If a backup manifest is not available or does not contain checksum of
151+
the right type, file cloning will be used to copy the file, but the
152+
file will be also read block-by-block for the checksum calculation.
153+
</para>
154+
155+
<para>
156+
File cloning is only supported on some operating systems and file
157+
systems. If it is selected but not supported, the
158+
<application>pg_combinebackup</application> run will error. At present,
159+
it is supported on Linux (kernel 4.5 or later) with Btrfs and XFS (on
160+
file systems created with reflink support), and on macOS with APFS.
161+
</para>
162+
</listitem>
163+
</varlistentry>
164+
165+
<varlistentry>
166+
<term><option>--copy-file-range</option></term>
167+
<listitem>
168+
<para>
169+
Use the <function>copy_file_range</function> system call for efficient
170+
copying. On some file systems this gives results similar to
171+
<option>--clone</option>, sharing physical disk blocks, while on others
172+
it may still copy blocks, but do so via an optimized path. At present,
173+
it is supported on Linux and FreeBSD.
174+
</para>
175+
176+
<para>
177+
If a backup manifest is not available or does not contain checksum of
178+
the right type, <function>copy_file_range</function> will be used to
179+
copy the file, but the file will be also read block-by-block for the
180+
checksum calculation.
181+
</para>
182+
</listitem>
183+
</varlistentry>
184+
140185
<varlistentry>
141186
<term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term>
142187
<listitem>
@@ -189,51 +234,6 @@ PostgreSQL documentation
189234
</listitem>
190235
</varlistentry>
191236

192-
<varlistentry>
193-
<term><option>--clone</option></term>
194-
<listitem>
195-
<para>
196-
Use efficient file cloning (also known as <quote>reflinks</quote> on
197-
some systems) instead of copying files to the new data directory,
198-
which can result in near-instantaneous copying of the data files.
199-
</para>
200-
201-
<para>
202-
If a backup manifest is not available or does not contain checksum of
203-
the right type, file cloning will be used to copy the file, but the
204-
file will be also read block-by-block for the checksum calculation.
205-
</para>
206-
207-
<para>
208-
File cloning is only supported on some operating systems and file
209-
systems. If it is selected but not supported, the
210-
<application>pg_combinebackup</application> run will error. At present,
211-
it is supported on Linux (kernel 4.5 or later) with Btrfs and XFS (on
212-
file systems created with reflink support), and on macOS with APFS.
213-
</para>
214-
</listitem>
215-
</varlistentry>
216-
217-
<varlistentry>
218-
<term><option>--copy-file-range</option></term>
219-
<listitem>
220-
<para>
221-
Use the <function>copy_file_range</function> system call for efficient
222-
copying. On some file systems this gives results similar to
223-
<option>--clone</option>, sharing physical disk blocks, while on others
224-
it may still copy blocks, but do so via an optimized path. At present,
225-
it is supported on Linux and FreeBSD.
226-
</para>
227-
228-
<para>
229-
If a backup manifest is not available or does not contain checksum of
230-
the right type, <function>copy_file_range</function> will be used to
231-
copy the file, but the file will be also read block-by-block for the
232-
checksum calculation.
233-
</para>
234-
</listitem>
235-
</varlistentry>
236-
237237
<varlistentry>
238238
<term><option>-V</option></term>
239239
<term><option>--version</option></term>

src/bin/pg_combinebackup/pg_combinebackup.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -732,12 +732,12 @@ help(const char *progname)
732732
printf(_(" -o, --output output directory\n"));
733733
printf(_(" -T, --tablespace-mapping=OLDDIR=NEWDIR\n"
734734
" relocate tablespace in OLDDIR to NEWDIR\n"));
735+
printf(_(" --clone clone (reflink) instead of copying files\n"));
736+
printf(_(" --copy-file-range copy using copy_file_range() syscall\n"));
735737
printf(_(" --manifest-checksums=SHA{224,256,384,512}|CRC32C|NONE\n"
736738
" use algorithm for manifest checksums\n"));
737739
printf(_(" --no-manifest suppress generation of backup manifest\n"));
738740
printf(_(" --sync-method=METHOD set method for syncing files to disk\n"));
739-
printf(_(" --clone clone (reflink) instead of copying files\n"));
740-
printf(_(" --copy-file-range copy using copy_file_range() syscall\n"));
741741
printf(_(" -?, --help show this help, then exit\n"));
742742

743743
printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);

0 commit comments

Comments
 (0)