btrfs-progs/Documentation/btrfs-receive.txt
Filipe David Borba Manana 909131939f Btrfs-progs: receive, allow to continue after errors happen
Due to either bugs in send (kernel) that generate a command against
a wrong path for example, or transient errors on the receiving side,
we stopped processing the send stream immediately and exited with
an error.

It's often desirable to continue processing the send stream even if an
error happens while processing a single command from the send stream.

This change just adds a --max-errors <N> parameter, whose default value
is 1 (preserving current behaviour), that allows to tolerate N errors
before stopping. A value of 0 means to never stop no matter how many
errors we get into while processing the send stream. Regardless of its
value, errors are always printed to stderr when they happen, just like
before this change.

Signed-off-by: Filipe David Borba Manana <fdmanana@gmail.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
2014-08-22 14:39:32 +02:00

60 lines
1.5 KiB
Plaintext

btrfs-receive(8)
================
NAME
----
btrfs-receive - receive subvolumes from stdin/file.
SYNOPSIS
--------
*btrfs receive* [-ve] [-f <infile>] <mount>
DESCRIPTION
-----------
Receives one or more subvolumes that were previously
sent with *btrfs send*. The received subvolumes are stored
into <mount>.
*btrfs receive* will fail with the following case:
1. a receiving subvolume already exists.
2. a previously received subvolume was changed after it was received.
3. default subvolume is changed or you don't mount btrfs filesystem with
fs tree.
After receiving a subvolume, it is immediately set to read only.
`Options`
-v::
Enable verbose debug output. Each occurrence of this option increases the
verbose level more.
-f <infile>::
By default, btrfs receive uses stdin to receive the subvolumes.
Use this option to specify a file to use instead.
-e::
Terminate after receiving an <end cmd> in the data stream.
Without this option, the receiver terminates only if an error is recognized
or on EOF.
--max-errors <N>::
Terminate as soon as N errors happened while processing commands from the send
stream. Default value is 1. A value of 0 means no limit.
EXIT STATUS
-----------
*btrfs receive* returns a zero exist status if it succeeds. Non zero is
returned in case of failure.
AVAILABILITY
------------
*btrfs* is part of btrfs-progs.
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
further details.
SEE ALSO
--------
`mkfs.btrfs`(8),
`btrfs-send`(8)