extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2025-06-25 20:21:30 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix typos

Browse Source
This commit is contained in:
Michał Bartkowiak 2025-01-19 13:52:19 +01:00
parent b5d853885b
commit da587f646f
2 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/configuration/overview.rst
View File

@ -93,7 +93,7 @@ The passive side job uses this *client identity* as follows:
* *In the future, ``source`` might embed the client identity in :ref:`zrepl's ZFS abstraction names <zrepl-zfs-abstractions>`, to support multi-host replication.* * *In the future, ``source`` might embed the client identity in :ref:`zrepl's ZFS abstraction names <zrepl-zfs-abstractions>`, to support multi-host replication.*
.. TIP:: .. TIP::
The use of the client identity in the ``sink`` job implies that it must be usable as a ZFS ZFS filesystem name component. The use of the client identity in the ``sink`` job implies that it must be usable as a ZFS filesystem name component.
.. _overview-how-replication-works: .. _overview-how-replication-works:
@ -222,7 +222,7 @@ Thus, there are never more than two step holds for a given pair of ``(job,filesy
They are intended for a situation where a replication step uses a bookmark ``#bm`` as incremental ``from`` where ``#bm`` is not managed by zrepl. They are intended for a situation where a replication step uses a bookmark ``#bm`` as incremental ``from`` where ``#bm`` is not managed by zrepl.
To ensure resumability, zrepl copies ``#bm`` to step bookmark ``#zrepl_STEP_G_<GUID>_J_<JOBNAME>``. To ensure resumability, zrepl copies ``#bm`` to step bookmark ``#zrepl_STEP_G_<GUID>_J_<JOBNAME>``.
If the replication is interrupted and ``#bm`` is deleted by the user, the step bookmark remains as an incremental source for the resumable send. If the replication is interrupted and ``#bm`` is deleted by the user, the step bookmark remains as an incremental source for the resumable send.
Note that zrepl does not yet support creating step bookmarks because the `corresponding ZFS feature for copying bookmarks <https://github.com/openzfs/zfs/pull/9571>`_ is not yet widely available . Note that zrepl does not yet support creating step bookmarks because the `corresponding ZFS feature for copying bookmarks <https://github.com/openzfs/zfs/pull/9571>`_ is not yet widely available.
Subscribe to zrepl :issue:`326` for details. Subscribe to zrepl :issue:`326` for details.
The ``zrepl zfs-abstraction list`` command provides a listing of all bookmarks and holds managed by zrepl. The ``zrepl zfs-abstraction list`` command provides a listing of all bookmarks and holds managed by zrepl.

7
docs/quickstart.rst
View File

@ -49,7 +49,7 @@ Apply Configuration Changes
=========================== ===========================
We hope that you have found a configuration that fits your use case. We hope that you have found a configuration that fits your use case.
Use ``zrepl configcheck`` once again to make sure the config is correct (output indicates that everything is fine). Use ``zrepl configcheck`` once again to make sure the config is correct (no output indicates that everything is fine).
Then restart the zrepl daemon on all systems involved in the replication, likely using ``service zrepl restart`` or ``systemctl restart zrepl``. Then restart the zrepl daemon on all systems involved in the replication, likely using ``service zrepl restart`` or ``systemctl restart zrepl``.
.. WARNING:: .. WARNING::
@ -69,10 +69,9 @@ Watch it Work
============= =============
Run ``zrepl status`` on the active side of the replication setup to monitor snaphotting, replication and pruning activity. Run ``zrepl status`` on the active side of the replication setup to monitor snaphotting, replication and pruning activity.
To re-trigger replication (snapshots are separate!), use ``zrepl signal wakeup JOBNAME``. To re-trigger replication (snapshots are separate!), use ``zrepl signal wakeup JOBNAME`` (refer to the example use case document if you are uncertain which job you want to wake up).
(refer to the example use case document if you are uncertain which job you want to wake up).
You can also use basic UNIX tools to inspect see what's going on. You can also use basic UNIX tools to inspect and see what's going on.
If you like tmux, here is a handy script that works on FreeBSD: :: If you like tmux, here is a handy script that works on FreeBSD: ::
pkg install gnu-watch tmux pkg install gnu-watch tmux