From 3b68acf853bcb4746606d0d55722b88d2ec2f6a7 Mon Sep 17 00:00:00 2001 From: Andreas Olsson Date: Sat, 29 Dec 2018 15:55:25 +0100 Subject: [PATCH] Prefer https:// links in the documentation All the changed urls are available by way of https://. Most of them already redirect. --- doc/020_installation.rst | 2 +- doc/090_participating.rst | 6 +++--- doc/cache.rst | 2 +- doc/design.rst | 2 +- doc/manual_rest.rst | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/020_installation.rst b/doc/020_installation.rst index 6b9d69b32..e84e848d6 100644 --- a/doc/020_installation.rst +++ b/doc/020_installation.rst @@ -72,7 +72,7 @@ macOS ===== If you are using macOS, you can install restic using the -`homebrew `__ package manager: +`homebrew `__ package manager: .. code-block:: console diff --git a/doc/090_participating.rst b/doc/090_participating.rst index 001211c8a..c909dd4a3 100644 --- a/doc/090_participating.rst +++ b/doc/090_participating.rst @@ -85,7 +85,7 @@ back end is contained in `Design `__ +project `__ A few issues have been tagged with the label ``help wanted``, you can start looking at those: https://github.com/restic/restic/labels/help%20wanted @@ -113,7 +113,7 @@ Compatibility Backward compatibility for backups is important so that our users are always able to restore saved data. Therefore restic follows `Semantic -Versioning `__ to clearly define which versions are +Versioning `__ to clearly define which versions are compatible. The repository and data structures contained therein are considered the "Public API" in the sense of Semantic Versioning. This goes for all released versions of restic, this may not be the case for @@ -128,7 +128,7 @@ prior versions. Building documentation ********************** -The restic documentation is built with `Sphinx `__, +The restic documentation is built with `Sphinx `__, therefore building it locally requires a recent Python version and requirements listed in ``doc/requirements.txt``. This example will guide you through the process using `virtualenv `__: diff --git a/doc/cache.rst b/doc/cache.rst index 971132c7e..4c8009795 100644 --- a/doc/cache.rst +++ b/doc/cache.rst @@ -9,7 +9,7 @@ Versions ======== The cache directory is selected according to the `XDG base dir specification -`__. +`__. Each repository has its own cache sub-directory, consisting of the repository ID which is chosen at ``init``. All cache directories for different repos are independent of each other. diff --git a/doc/design.rst b/doc/design.rst index 890645649..dd209c2fc 100644 --- a/doc/design.rst +++ b/doc/design.rst @@ -276,7 +276,7 @@ the IV for counter mode and the nonce for Poly1305. This operation needs three keys: A 32 byte for AES-256 for encryption, a 16 byte AES key and a 16 byte key for Poly1305. For details see the original paper `The Poly1305-AES message-authentication -code `__ by Dan Bernstein. +code `__ by Dan Bernstein. The data is then encrypted with AES-256 and afterwards a message authentication code (MAC) is computed over the ciphertext, everything is then stored as IV \|\| CIPHERTEXT \|\| MAC. diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index f00f72c45..e904ad581 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -181,7 +181,7 @@ locks with the following command: d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c The ``find`` command searches for a given -`pattern `__ in the +`pattern `__ in the repository. .. code-block:: console