Skip to content

Commit dc46b1d

Browse files
author
Vladimir I
committed
Fix gh-869 Сonfusing wording in box.backup page
Changed description as intended. Consider review.
1 parent c410404 commit dc46b1d

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

doc/1.10/book/admin/backups.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,9 @@ backup.start() and backup.stop()
2222
Two functions are helpful for backups in certain situations.
2323

2424
``box.backup.start()`` informs the server that some activities
25-
that might interfer with backup should be suspended -- suspend checkpointing,
26-
suspend Tarantool garbage collection, and effectively enter read-only mode.
27-
28-
Later ``box.backup.stop()`` informs the server that
29-
normal operations may resume. Starting with Tarantool 1.10.1 there is a new
30-
optional argument, ``box.backup.start(n)``, where ``n`` indicates the checkpoint
31-
to use relative to the latest checkpoint -- for example ``n = 0`` means
32-
"backup will be based on the latest checkpoint", ``n = 1`` means "backup will
33-
be based on the first checkpoint before the latest checkpoint
34-
(counting backwards)", and so on,
35-
and the default value for ``n`` is zero.
36-
37-
``box.backup.start()`` returns a table with the names of snapshot
38-
and vinyl files that should be copied. Example:
25+
that might interfere with backup should be suspended (suspend checkpointing,
26+
Tarantool garbage collection etc) and returns a table with the names of
27+
snapshot and vinyl files that should be copied. Example:
3928

4029
.. code-block:: tarantoolsession
4130
@@ -47,6 +36,20 @@ and vinyl files that should be copied. Example:
4736
- ./513/0/00000000000000000002.run
4837
...
4938
39+
.. NOTE::
40+
41+
To guarantee an opportunity to copy this files Tarantool will not delete them.
42+
But there will be no read-only mode nor checkpoints postponed in this state.
43+
44+
Later ``box.backup.stop()`` informs the server that
45+
normal operations may resume. Starting with Tarantool 1.10.1 there is a new
46+
optional argument, ``box.backup.start(n)``, where ``n`` indicates the checkpoint
47+
to use relative to the latest checkpoint -- for example ``n = 0`` means
48+
"backup will be based on the latest checkpoint", ``n = 1`` means "backup will
49+
be based on the first checkpoint before the latest checkpoint
50+
(counting backwards)", and so on,
51+
and the default value for ``n`` is zero.
52+
5053
.. _admin-backups-hot_backup_memtx:
5154

5255
--------------------------------------------------------------------------------

0 commit comments

Comments
 (0)