Added deprecated note to the recover command in the user guide.

Signed-off-by: Dj Walker-Morgan <dj.walker-morgan@enterprisedb.com>
EnterpriseDB · Dec 20, 2024 · e3038b3 · e3038b3
1 parent ebffcd3
commit e3038b3
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/user_guide/commands.rst b/docs/user_guide/commands.rst
@@ -73,6 +73,7 @@ quickly navigate to it.
 .. include:: commands/barman/lock_directory_cleanup.inc.rst
 .. include:: commands/barman/put_wal.inc.rst
 .. include:: commands/barman/rebuild_xlogdb.inc.rst
+.. include:: commands/barman/recover.inc.rst
 .. include:: commands/barman/receive_wal.inc.rst
 .. include:: commands/barman/restore.inc.rst
 .. include:: commands/barman/replication_status.inc.rst

diff --git a/docs/user_guide/commands/barman/recover.inc.rst b/docs/user_guide/commands/barman/recover.inc.rst
@@ -0,0 +1,24 @@
+.. _commands-barman-recover:
+
+``barman recover``
+""""""""""""""""""
+
+Synopsis
+^^^^^^^^
+
+This command is deprecated. Use the :ref:`commands-barman-restore` command instead.
+
+Description
+^^^^^^^^^^^
+
+Execute a PostreSQL server restore operation. See the :ref:`commands-barman-restore` command for details.
+
+Parameters
+^^^^^^^^^^
+
+See the :ref:`commands-barman-restore` command for details.
+
+.. note::
+
+    This command is deprecated. Use the :ref:`commands-barman-restore` command instead.
+