From da587f646fd164bf54c058ce94f226c8c83ea810 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Bartkowiak?= Date: Sun, 19 Jan 2025 13:52:19 +0100 Subject: [PATCH] Fix typos --- docs/configuration/overview.rst | 4 ++-- docs/quickstart.rst | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/configuration/overview.rst b/docs/configuration/overview.rst index 4b9de34..1b5ae88 100644 --- a/docs/configuration/overview.rst +++ b/docs/configuration/overview.rst @@ -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 `, to support multi-host replication.* .. 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: @@ -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. To ensure resumability, zrepl copies ``#bm`` to step bookmark ``#zrepl_STEP_G__J_``. 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 `_ is not yet widely available . +Note that zrepl does not yet support creating step bookmarks because the `corresponding ZFS feature for copying bookmarks `_ is not yet widely available. Subscribe to zrepl :issue:`326` for details. The ``zrepl zfs-abstraction list`` command provides a listing of all bookmarks and holds managed by zrepl. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 9739262..a23b4cd 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -49,7 +49,7 @@ Apply Configuration Changes =========================== 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``. .. 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. -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). +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). -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: :: pkg install gnu-watch tmux