From: Aaron Lauterer <a.lauterer@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 1/2] docs: fix references to changed refs
Date: Fri, 5 Feb 2021 16:10:29 +0100 [thread overview]
Message-ID: <20210205151030.28946-1-a.lauterer@proxmox.com> (raw)
With commit ec1ae7e63180768c9ad8fa52d437a1cee6ef1c50 some refs were
changed by getting prefixes and such. We need to adapt the places that
reference them as well
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
---
docs/backup-client.rst | 2 +-
docs/gui.rst | 2 +-
docs/introduction.rst | 2 +-
docs/maintenance.rst | 6 +++---
docs/managing-remotes.rst | 2 +-
docs/pxar/description.rst | 2 +-
docs/storage.rst | 4 ++--
docs/technical-overview.rst | 4 ++--
8 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index 800ee43f..415e5bf0 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -657,7 +657,7 @@ shows the list of existing snapshots and what actions prune would take.
.. note:: Neither the ``prune`` command nor the ``forget`` command free space
in the chunk-store. The chunk-store still contains the data blocks. To free
- space you need to perform :ref:`garbage-collection`.
+ space you need to perform :ref:`client_garbage-collection`.
.. _client_garbage-collection:
diff --git a/docs/gui.rst b/docs/gui.rst
index b2b1fb73..719675e9 100644
--- a/docs/gui.rst
+++ b/docs/gui.rst
@@ -129,7 +129,7 @@ top panel to view:
* **Content**: Information on the datastore's backup groups and their respective
contents
* **Prune & GC**: Schedule :ref:`pruning <backup-pruning>` and :ref:`garbage
- collection <garbage-collection>` operations, and run garbage collection
+ collection <client_garbage-collection>` operations, and run garbage collection
manually
* **Sync Jobs**: Create, manage and run :ref:`syncjobs` from remote servers
* **Verify Jobs**: Create, manage and run :ref:`maintenance_verification` jobs on the
diff --git a/docs/introduction.rst b/docs/introduction.rst
index 8545bf2c..5e754477 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -15,7 +15,7 @@ encryption (AE_). Using :term:`Rust` as the implementation language guarantees h
performance, low resource usage, and a safe, high-quality codebase.
Proxmox Backup uses state of the art cryptography for both client-server
-communication and backup content :ref:`encryption <encryption>`. All
+communication and backup content :ref:`encryption <client_encryption>`. All
client-server communication uses `TLS
<https://en.wikipedia.org/wiki/Transport_Layer_Security>`_, and backup data can
be encrypted on the client-side before sending, making it safer to back up data
diff --git a/docs/maintenance.rst b/docs/maintenance.rst
index 561b4fe4..c2771e36 100644
--- a/docs/maintenance.rst
+++ b/docs/maintenance.rst
@@ -118,11 +118,11 @@ high, but you cannot recreate backup snapshots from the past.
Garbage Collection
------------------
-You can monitor and run :ref:`garbage collection <garbage-collection>` on the
+You can monitor and run :ref:`garbage collection <client_garbage-collection>` on the
Proxmox Backup Server using the ``garbage-collection`` subcommand of
``proxmox-backup-manager``. You can use the ``start`` subcommand to manually
start garbage collection on an entire datastore and the ``status`` subcommand to
-see attributes relating to the :ref:`garbage collection <garbage-collection>`.
+see attributes relating to the :ref:`garbage collection <client_garbage-collection>`.
This functionality can also be accessed in the GUI, by navigating to **Prune &
GC** from the top panel. From here, you can edit the schedule at which garbage
@@ -142,7 +142,7 @@ Verification
Proxmox Backup offers various verification options to ensure that backup data is
intact. Verification is generally carried out through the creation of verify
jobs. These are scheduled tasks that run verification at a given interval (see
-:ref:`calendar-events`). With these, you can set whether already verified
+:ref:`calendar-event-scheduling`). With these, you can set whether already verified
snapshots are ignored, as well as set a time period, after which verified jobs
are checked again. The interface for creating verify jobs can be found under the
**Verify Jobs** tab of the datastore.
diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst
index e29ae37f..88ab3ba2 100644
--- a/docs/managing-remotes.rst
+++ b/docs/managing-remotes.rst
@@ -65,7 +65,7 @@ the ``proxmox-backup-manager sync-job`` command. The configuration information
for sync jobs is stored at ``/etc/proxmox-backup/sync.cfg``. To create a new
sync job, click the add button in the GUI, or use the ``create`` subcommand.
After creating a sync job, you can either start it manually from the GUI or
-provide it with a schedule (see :ref:`calendar-events`) to run regularly.
+provide it with a schedule (see :ref:`calendar-event-scheduling`) to run regularly.
.. code-block:: console
diff --git a/docs/pxar/description.rst b/docs/pxar/description.rst
index 18be7687..be78623d 100644
--- a/docs/pxar/description.rst
+++ b/docs/pxar/description.rst
@@ -80,7 +80,7 @@ These files must contain one pattern per line, again later patterns win over
previous ones.
The patterns control file exclusions of files present within the given directory
or further below it in the tree.
-The behavior is the same as described in :ref:`creating-backups`.
+The behavior is the same as described in :ref:`client_creating_backups`.
Extracting an Archive
^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/storage.rst b/docs/storage.rst
index 45807b21..de3f0f46 100644
--- a/docs/storage.rst
+++ b/docs/storage.rst
@@ -119,8 +119,8 @@ directory on the filesystem. Each datastore also has associated retention
settings of how many backup snapshots for each interval of ``hourly``,
``daily``, ``weekly``, ``monthly``, ``yearly`` as well as a time-independent
number of backups to keep in that store. :ref:`backup-pruning` and
-:ref:`garbage collection <garbage-collection>` can also be configured to run
-periodically based on a configured schedule (see :ref:`calendar-events`) per datastore.
+:ref:`garbage collection <client_garbage-collection>` can also be configured to run
+periodically based on a configured schedule (see :ref:`calendar-event-scheduling`) per datastore.
.. _storage_datastore_create:
diff --git a/docs/technical-overview.rst b/docs/technical-overview.rst
index 9dba2557..1bf59e23 100644
--- a/docs/technical-overview.rst
+++ b/docs/technical-overview.rst
@@ -7,8 +7,8 @@ Datastores
----------
A Datastore is the logical place where :ref:`Backup Snapshots
-<backup_snapshot>` and their chunks are stored. Snapshots consist of a
-manifest, blobs, dynamic- and fixed-indexes (see :ref:`terminology`), and are
+<term_backup_snapshot>` and their chunks are stored. Snapshots consist of a
+manifest, blobs, dynamic- and fixed-indexes (see :ref:`terms`), and are
stored in the following directory structure:
<datastore-root>/<type>/<id>/<time>/
--
2.20.1
next reply other threads:[~2021-02-05 15:11 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-05 15:10 Aaron Lauterer [this message]
2021-02-05 15:10 ` [pbs-devel] [PATCH proxmox-backup 2/2] docs/scanrefs: fix handling if ref is same as headline Aaron Lauterer
2021-02-06 8:22 ` Thomas Lamprecht
2021-02-08 16:06 ` Aaron Lauterer
2021-02-06 7:49 ` [pbs-devel] applied: [PATCH proxmox-backup 1/2] docs: fix references to changed refs Dietmar Maurer
2021-02-06 8:12 ` [pbs-devel] " Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210205151030.28946-1-a.lauterer@proxmox.com \
--to=a.lauterer@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox