mirror of
https://github.com/restic/restic.git
synced 2024-12-21 23:33:03 +00:00
doc: Fix some links, focus less on implementation details
The godoc for filepath.Match has the syntax, which is what is important for writing patterns. Use pkg.go.dev instead of golang.org/pkg. For #4245. Not all links fixed yet.
This commit is contained in:
parent
a7786c67f1
commit
a7ac9a4769
6 changed files with 14 additions and 14 deletions
|
@ -40,7 +40,7 @@ package from the official community repos, e.g. using ``apk``:
|
||||||
Arch Linux
|
Arch Linux
|
||||||
==========
|
==========
|
||||||
|
|
||||||
On `Arch Linux <https://www.archlinux.org/>`__, there is a package called ``restic``
|
On `Arch Linux <https://archlinux.org/>`__, there is a package called ``restic``
|
||||||
installed from the official community repos, e.g. with ``pacman -S``:
|
installed from the official community repos, e.g. with ``pacman -S``:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
@ -271,7 +271,7 @@ From Source
|
||||||
restic is written in the Go programming language and you need at least
|
restic is written in the Go programming language and you need at least
|
||||||
Go version 1.18. Building restic may also work with older versions of Go,
|
Go version 1.18. Building restic may also work with older versions of Go,
|
||||||
but that's not supported. See the `Getting
|
but that's not supported. See the `Getting
|
||||||
started <https://golang.org/doc/install>`__ guide of the Go project for
|
started <https://go.dev/doc/install>`__ guide of the Go project for
|
||||||
instructions how to install Go.
|
instructions how to install Go.
|
||||||
|
|
||||||
In order to build restic from source, execute the following steps:
|
In order to build restic from source, execute the following steps:
|
||||||
|
|
|
@ -290,7 +290,7 @@ like this: ``s3:http://server:port/bucket_name``.
|
||||||
Minio Server
|
Minio Server
|
||||||
************
|
************
|
||||||
|
|
||||||
`Minio <https://www.minio.io>`__ is an Open Source Object Storage,
|
`Minio <https://www.min.io>`__ is an Open Source Object Storage,
|
||||||
written in Go and compatible with Amazon S3 API.
|
written in Go and compatible with Amazon S3 API.
|
||||||
|
|
||||||
- Download and Install `Minio
|
- Download and Install `Minio
|
||||||
|
@ -350,7 +350,7 @@ this command.
|
||||||
Alibaba Cloud (Aliyun) Object Storage System (OSS)
|
Alibaba Cloud (Aliyun) Object Storage System (OSS)
|
||||||
**************************************************
|
**************************************************
|
||||||
|
|
||||||
`Alibaba OSS <https://www.alibabacloud.com/product/oss/>`__ is an
|
`Alibaba OSS <https://www.alibabacloud.com/product/object-storage-service>`__ is an
|
||||||
encrypted, secure, cost-effective, and easy-to-use object storage
|
encrypted, secure, cost-effective, and easy-to-use object storage
|
||||||
service that enables you to store, back up, and archive large amounts
|
service that enables you to store, back up, and archive large amounts
|
||||||
of data in the cloud.
|
of data in the cloud.
|
||||||
|
@ -616,7 +616,7 @@ established.
|
||||||
|
|
||||||
.. _service account: https://cloud.google.com/iam/docs/service-accounts
|
.. _service account: https://cloud.google.com/iam/docs/service-accounts
|
||||||
.. _create a service account key: https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console
|
.. _create a service account key: https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console
|
||||||
.. _default authentication material: https://cloud.google.com/docs/authentication/production
|
.. _default authentication material: https://cloud.google.com/docs/authentication#service-accounts
|
||||||
|
|
||||||
.. _other-services:
|
.. _other-services:
|
||||||
|
|
||||||
|
|
|
@ -253,14 +253,14 @@ This instructs restic to exclude files matching the following criteria:
|
||||||
* All files matching ``*.go`` (second line in ``excludes.txt``)
|
* All files matching ``*.go`` (second line in ``excludes.txt``)
|
||||||
* All files and sub-directories named ``bar`` which reside somewhere below a directory called ``foo`` (fourth line in ``excludes.txt``)
|
* All files and sub-directories named ``bar`` which reside somewhere below a directory called ``foo`` (fourth line in ``excludes.txt``)
|
||||||
|
|
||||||
Patterns use `filepath.Glob <https://golang.org/pkg/path/filepath/#Glob>`__ internally,
|
Patterns use the syntax of the Go function
|
||||||
see `filepath.Match <https://golang.org/pkg/path/filepath/#Match>`__ for
|
`filepath.Match <https://pkg.go.dev/path/filepath#Match>`__
|
||||||
syntax. Patterns are tested against the full path of a file/dir to be saved,
|
and are tested against the full path of a file/dir to be saved,
|
||||||
even if restic is passed a relative path to save. Empty lines and lines
|
even if restic is passed a relative path to save. Empty lines and lines
|
||||||
starting with a ``#`` are ignored.
|
starting with a ``#`` are ignored.
|
||||||
|
|
||||||
Environment variables in exclude files are expanded with `os.ExpandEnv
|
Environment variables in exclude files are expanded with `os.ExpandEnv
|
||||||
<https://golang.org/pkg/os/#ExpandEnv>`__, so ``/home/$USER/foo`` will be
|
<https://pkg.go.dev/os#ExpandEnv>`__, so ``/home/$USER/foo`` will be
|
||||||
expanded to ``/home/bob/foo`` for the user ``bob``. To get a literal dollar
|
expanded to ``/home/bob/foo`` for the user ``bob``. To get a literal dollar
|
||||||
sign, write ``$$`` to the file - this has to be done even when there's no
|
sign, write ``$$`` to the file - this has to be done even when there's no
|
||||||
matching environment variable for the word following a single ``$``. Note
|
matching environment variable for the word following a single ``$``. Note
|
||||||
|
@ -380,7 +380,7 @@ contains one *pattern* per line. The file must be encoded as UTF-8, or UTF-16
|
||||||
with a byte-order mark. Leading and trailing whitespace is removed from the
|
with a byte-order mark. Leading and trailing whitespace is removed from the
|
||||||
patterns. Empty lines and lines starting with a ``#`` are ignored and each
|
patterns. Empty lines and lines starting with a ``#`` are ignored and each
|
||||||
pattern is expanded when read, such that special characters in it are expanded
|
pattern is expanded when read, such that special characters in it are expanded
|
||||||
using the Go function `filepath.Glob <https://golang.org/pkg/path/filepath/#Glob>`__
|
using the Go function `filepath.Glob <https://pkg.go.dev/path/filepath#Glob>`__
|
||||||
- please see its documentation for the syntax you can use in the patterns.
|
- please see its documentation for the syntax you can use in the patterns.
|
||||||
|
|
||||||
The argument passed to ``--files-from-verbatim`` must be the name of a text file
|
The argument passed to ``--files-from-verbatim`` must be the name of a text file
|
||||||
|
|
|
@ -19,7 +19,7 @@ Encryption
|
||||||
the implementation looks sane and I guess the deduplication trade-off is worth
|
the implementation looks sane and I guess the deduplication trade-off is worth
|
||||||
it. So… I’m going to use restic for my personal backups.*" `Filippo Valsorda`_
|
it. So… I’m going to use restic for my personal backups.*" `Filippo Valsorda`_
|
||||||
|
|
||||||
.. _Filippo Valsorda: https://blog.filippo.io/restic-cryptography/
|
.. _Filippo Valsorda: https://words.filippo.io/restic-cryptography/
|
||||||
|
|
||||||
**********************
|
**********************
|
||||||
Manage repository keys
|
Manage repository keys
|
||||||
|
|
|
@ -33,8 +33,8 @@ The debug log will always contain all log messages restic generates. You
|
||||||
can also instruct restic to print some or all debug messages to stderr.
|
can also instruct restic to print some or all debug messages to stderr.
|
||||||
These can also be limited to e.g. a list of source files or a list of
|
These can also be limited to e.g. a list of source files or a list of
|
||||||
patterns for function names. The patterns are globbing patterns (see the
|
patterns for function names. The patterns are globbing patterns (see the
|
||||||
documentation for `path.Glob <https://golang.org/pkg/path/#Glob>`__), multiple
|
documentation for `filepath.Match <https://pkg.go.dev/path/filepath#Match>`__).
|
||||||
patterns are separated by commas. Patterns are case sensitive.
|
Multiple patterns are separated by commas. Patterns are case sensitive.
|
||||||
|
|
||||||
Printing all log messages to the console can be achieved by setting the
|
Printing all log messages to the console can be achieved by setting the
|
||||||
file filter to ``*``:
|
file filter to ``*``:
|
||||||
|
|
|
@ -10,7 +10,7 @@ refer to the documentation for the respective version. The binary produced
|
||||||
depends on the following things:
|
depends on the following things:
|
||||||
|
|
||||||
* The source code for the release
|
* The source code for the release
|
||||||
* The exact version of the official `Go compiler <https://golang.org>`__ used to produce the binaries (running ``restic version`` will print this)
|
* The exact version of the official `Go compiler <https://go.dev>`__ used to produce the binaries (running ``restic version`` will print this)
|
||||||
* The architecture and operating system the Go compiler runs on (Linux, ``amd64``)
|
* The architecture and operating system the Go compiler runs on (Linux, ``amd64``)
|
||||||
* The build tags (for official binaries, it's the tag ``selfupdate``)
|
* The build tags (for official binaries, it's the tag ``selfupdate``)
|
||||||
* The path where the source code is extracted to (``/restic``)
|
* The path where the source code is extracted to (``/restic``)
|
||||||
|
|
Loading…
Reference in a new issue