From f3b88e6b755f048f79ccb5a54264b8b7e07c24ae Mon Sep 17 00:00:00 2001
From: David Sterba <dsterba@suse.com>
Date: Wed, 27 Oct 2021 00:45:24 +0200
Subject: [PATCH] btrfs-progs: docs: convert btrfs-send to rst

Signed-off-by: David Sterba <dsterba@suse.com>
---
 Documentation/btrfs-send.rst | 95 ++++++++++++++++++++++++++++++++++++
 Documentation/conf.py        |  1 +
 Documentation/man-index.rst  |  1 +
 3 files changed, 97 insertions(+)
 create mode 100644 Documentation/btrfs-send.rst

diff --git a/Documentation/btrfs-send.rst b/Documentation/btrfs-send.rst
new file mode 100644
index 00000000..4526532e
--- /dev/null
+++ b/Documentation/btrfs-send.rst
@@ -0,0 +1,95 @@
+btrfs-send(8)
+=============
+
+SYNOPSIS
+--------
+
+**btrfs send** [-ve] [-p <parent>] [-c <clone-src>] [-f <outfile>] <subvol> [<subvol>...]
+
+DESCRIPTION
+-----------
+
+This command will generate a stream of instructions that describe changes
+between two subvolume snapshots. The stream can be consumed by the **btrfs
+receive** command to replicate the sent snapshot on a different filesystem.
+The command operates in two modes: full and incremental.
+
+All snapshots involved in one send command must be read-only, and this status
+cannot be changed as long as there's a running send operation that uses the
+snapshot.
+
+In the full mode, the entire snapshot data and metadata will end up in the
+stream.
+
+In the incremental mode (options *-p* and *-c*), previously sent snapshots that
+are available on both the sending and receiving side can be used to reduce the
+amount of information that has to be sent to reconstruct the sent snapshot on a
+different filesystem.
+
+The *-p <parent>* option can be omitted when *-c <clone-src>* options are
+given, in which case **btrfs send** will determine a suitable parent from among
+the clone sources.
+
+You must not specify clone sources unless you guarantee that these snapshots
+are exactly in the same state on both sides--both for the sender and the
+receiver. For implications of changed read-write status of a received snapshot
+please see section *SUBVOLUME FLAGS* in ``btrfs-subvolume(8)``.
+
+``Options``
+
+-e
+        if sending multiple subvolumes at once, use the new format and omit the
+        'end cmd' marker in the stream separating the subvolumes
+
+-p <parent>
+        send an incremental stream from *parent* to *subvol*
+
+-c <clone-src>
+        use this snapshot as a clone source for an incremental send (multiple
+        allowed)
+
+-f <outfile>
+        output is normally written to standard output so it can be, for
+        example, piped to btrfs receive. Use this option to write it to a file
+        instead.
+
+--no-data::
+        send in *NO_FILE_DATA* mode
+
+        The output stream does not contain any file data and thus cannot be
+        used to transfer changes. This mode is faster and is useful to show the
+        differences in metadata.
+
+-q|--quiet
+        (deprecated) alias for global *-q* option
+
+-v|--verbose
+        (deprecated) alias for global *-v* option
+
+``Global options``
+
+-q|--quiet
+        suppress all messages except errors
+
+-v|--verbose
+        increase output verbosity, print generated commands in a readable form
+
+EXIT STATUS
+-----------
+
+**btrfs send** returns a zero exit 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-receive(8)``,
+``btrfs-subvolume(8)``
diff --git a/Documentation/conf.py b/Documentation/conf.py
index b405864e..e8210676 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -43,4 +43,5 @@ man_pages = [
     ('btrfs-select-super', 'btrfs-select-super', 'overwrite primary superblock with a backup copy', '', '8'),
     ('btrfstune', 'btrfstune', 'tune various filesystem parameters', '', 8),
     ('fsck.btrfs', 'fsck.btrfs', 'do nothing, successfully', '', 8),
+    ('btrfs-send', 'btrfs-send', 'generate a stream of changes between two subvolume snapshots', '', 8),
 ]
diff --git a/Documentation/man-index.rst b/Documentation/man-index.rst
index 13e81951..596ec2f9 100644
--- a/Documentation/man-index.rst
+++ b/Documentation/man-index.rst
@@ -7,6 +7,7 @@ Manual pages
    :maxdepth: 1
 
    btrfs-select-super
+   btrfs-send
    btrfstune
    fsck.btrfs