From 621476b027bfd22d183794218ff91b75ae6c2500 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 11 Mar 2019 00:08:25 +0100 Subject: [PATCH 1/4] release date --- docs/changes.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/changes.rst b/docs/changes.rst index 2dd6a77b3..7bab53b56 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -171,8 +171,8 @@ The best check that everything is ok is to run a dry-run extraction:: Changelog ========= -Version 1.2.0a4 (not released yet) ----------------------------------- +Version 1.2.0a4 (2019-03-11) +---------------------------- Please note: From 9507856049086988b3e74876c92cfcf525642e39 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 11 Mar 2019 00:11:16 +0100 Subject: [PATCH 2/4] build_usage --- docs/usage/check.rst.inc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index cc61a76ea..aca5d4960 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -29,6 +29,8 @@ borg check +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--save-space`` | work slower, but using less space | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--max-duration SECONDS`` | do only a partial repo check for max. SECONDS seconds (Default: unlimited) | + +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | .. class:: borg-common-opt-ref | | | | :ref:`common_options` | @@ -66,6 +68,7 @@ borg check --verify-data perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) --repair attempt to repair any inconsistencies found --save-space work slower, but using less space + --max-duration SECONDS do only a partial repo check for max. SECONDS seconds (Default: unlimited) :ref:`common_options` From 1386c67513fff2d7d54e79fb0d8a314045590ca5 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 11 Mar 2019 00:11:50 +0100 Subject: [PATCH 3/4] build_man --- docs/man/borg-benchmark-crud.1 | 2 +- docs/man/borg-benchmark.1 | 2 +- docs/man/borg-break-lock.1 | 2 +- docs/man/borg-check.1 | 5 ++++- docs/man/borg-common.1 | 2 +- docs/man/borg-compact.1 | 2 +- docs/man/borg-compression.1 | 2 +- docs/man/borg-config.1 | 2 +- docs/man/borg-create.1 | 2 +- docs/man/borg-delete.1 | 2 +- docs/man/borg-diff.1 | 2 +- docs/man/borg-export-tar.1 | 2 +- docs/man/borg-extract.1 | 2 +- docs/man/borg-info.1 | 2 +- docs/man/borg-init.1 | 2 +- docs/man/borg-key-change-passphrase.1 | 2 +- docs/man/borg-key-export.1 | 2 +- docs/man/borg-key-import.1 | 2 +- docs/man/borg-key-migrate-to-repokey.1 | 2 +- docs/man/borg-key.1 | 2 +- docs/man/borg-list.1 | 2 +- docs/man/borg-mount.1 | 2 +- docs/man/borg-patterns.1 | 2 +- docs/man/borg-placeholders.1 | 2 +- docs/man/borg-prune.1 | 2 +- docs/man/borg-recreate.1 | 2 +- docs/man/borg-rename.1 | 2 +- docs/man/borg-serve.1 | 4 ++-- docs/man/borg-umount.1 | 2 +- docs/man/borg-upgrade.1 | 2 +- docs/man/borg-with-lock.1 | 2 +- docs/man/borgfs.1 | 2 +- 32 files changed, 36 insertions(+), 33 deletions(-) diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 58f4ab91b..5ab9169b5 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK-CRUD 1 "2019-02-24" "" "borg backup tool" +.TH BORG-BENCHMARK-CRUD 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. . diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1 index a0fb657dc..e555444c2 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK 1 "2019-02-24" "" "borg backup tool" +.TH BORG-BENCHMARK 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-benchmark \- benchmark command . diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index 64fffe06d..8b8134584 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BREAK-LOCK 1 "2019-02-24" "" "borg backup tool" +.TH BORG-BREAK-LOCK 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. . diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index 176b6c176..4955e8607 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CHECK 1 "2019-02-24" "" "borg backup tool" +.TH BORG-CHECK 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency . @@ -120,6 +120,9 @@ attempt to repair any inconsistencies found .TP .B \-\-save\-space work slower, but using less space +.TP +.BI \-\-max\-duration \ SECONDS +do only a partial repo check for max. SECONDS seconds (Default: unlimited) .UNINDENT .SS Archive filters .INDENT 0.0 diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index 4b8a22cc3..76d01312e 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMMON 1 "2019-02-24" "" "borg backup tool" +.TH BORG-COMMON 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands . diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index 46dde4d06..ddd9138df 100644 --- a/docs/man/borg-compact.1 +++ b/docs/man/borg-compact.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPACT 1 "2019-02-24" "" "borg backup tool" +.TH BORG-COMPACT 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-compact \- compact segment files in the repository . diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index eb71d3734..8aefd87e3 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPRESSION 1 "2019-02-24" "" "borg backup tool" +.TH BORG-COMPRESSION 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression . diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index b1e9b73d6..1be313df2 100644 --- a/docs/man/borg-config.1 +++ b/docs/man/borg-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CONFIG 1 "2019-02-24" "" "borg backup tool" +.TH BORG-CONFIG 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-config \- get, set, and delete values in a repository or cache config file . diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index b90a7d6f3..b4ad65086 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CREATE 1 "2019-02-24" "" "borg backup tool" +.TH BORG-CREATE 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-create \- Create new archive . diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index 13f7fc3d9..0c11a2963 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DELETE 1 "2019-02-24" "" "borg backup tool" +.TH BORG-DELETE 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives . diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index 3e61c5584..5afcdadac 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DIFF 1 "2019-02-24" "" "borg backup tool" +.TH BORG-DIFF 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives . diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 291b12f8c..2e6759727 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXPORT-TAR 1 "2019-02-24" "" "borg backup tool" +.TH BORG-EXPORT-TAR 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball . diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 5ac5fe251..275baca42 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXTRACT 1 "2019-02-24" "" "borg backup tool" +.TH BORG-EXTRACT 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents . diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index e2f098721..d9a4800fb 100644 --- a/docs/man/borg-info.1 +++ b/docs/man/borg-info.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-INFO 1 "2019-02-24" "" "borg backup tool" +.TH BORG-INFO 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used . diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1 index f31e43a72..2f47a7ccb 100644 --- a/docs/man/borg-init.1 +++ b/docs/man/borg-init.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-INIT 1 "2019-02-24" "" "borg backup tool" +.TH BORG-INIT 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-init \- Initialize an empty repository . diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index 7fb9f05be..87a5d29d0 100644 --- a/docs/man/borg-key-change-passphrase.1 +++ b/docs/man/borg-key-change-passphrase.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2019-02-24" "" "borg backup tool" +.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase . diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index ea3df6c7c..ad1d490b4 100644 --- a/docs/man/borg-key-export.1 +++ b/docs/man/borg-key-export.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-EXPORT 1 "2019-02-24" "" "borg backup tool" +.TH BORG-KEY-EXPORT 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-key-export \- Export the repository key for backup . diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1 index 755b87fe1..f0cf594d0 100644 --- a/docs/man/borg-key-import.1 +++ b/docs/man/borg-key-import.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-IMPORT 1 "2019-02-24" "" "borg backup tool" +.TH BORG-KEY-IMPORT 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-key-import \- Import the repository key from backup . diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1 index b38e13f4d..e4cec3a1b 100644 --- a/docs/man/borg-key-migrate-to-repokey.1 +++ b/docs/man/borg-key-migrate-to-repokey.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2019-02-24" "" "borg backup tool" +.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-key-migrate-to-repokey \- Migrate passphrase -> repokey . diff --git a/docs/man/borg-key.1 b/docs/man/borg-key.1 index 96abba861..63ab13a34 100644 --- a/docs/man/borg-key.1 +++ b/docs/man/borg-key.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY 1 "2019-02-24" "" "borg backup tool" +.TH BORG-KEY 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-key \- Manage a keyfile or repokey of a repository . diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index 2ba06194b..daff93383 100644 --- a/docs/man/borg-list.1 +++ b/docs/man/borg-list.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-LIST 1 "2019-02-24" "" "borg backup tool" +.TH BORG-LIST 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents . diff --git a/docs/man/borg-mount.1 b/docs/man/borg-mount.1 index cc36bed0d..f7f94ebdb 100644 --- a/docs/man/borg-mount.1 +++ b/docs/man/borg-mount.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-MOUNT 1 "2019-02-24" "" "borg backup tool" +.TH BORG-MOUNT 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-mount \- Mount archive or an entire repository as a FUSE filesystem . diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1 index 02502516e..1f7b77993 100644 --- a/docs/man/borg-patterns.1 +++ b/docs/man/borg-patterns.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PATTERNS 1 "2019-02-24" "" "borg backup tool" +.TH BORG-PATTERNS 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-patterns \- Details regarding patterns . diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1 index 9dd8f1d6c..980f23609 100644 --- a/docs/man/borg-placeholders.1 +++ b/docs/man/borg-placeholders.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PLACEHOLDERS 1 "2019-02-24" "" "borg backup tool" +.TH BORG-PLACEHOLDERS 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-placeholders \- Details regarding placeholders . diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index 6737ed8f8..055d34b87 100644 --- a/docs/man/borg-prune.1 +++ b/docs/man/borg-prune.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PRUNE 1 "2019-02-24" "" "borg backup tool" +.TH BORG-PRUNE 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-prune \- Prune repository archives according to specified rules . diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index e729a431a..b839eb738 100644 --- a/docs/man/borg-recreate.1 +++ b/docs/man/borg-recreate.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-RECREATE 1 "2019-02-24" "" "borg backup tool" +.TH BORG-RECREATE 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-recreate \- Re-create archives . diff --git a/docs/man/borg-rename.1 b/docs/man/borg-rename.1 index a4c5d2ffc..6aa6bb9b7 100644 --- a/docs/man/borg-rename.1 +++ b/docs/man/borg-rename.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-RENAME 1 "2019-02-24" "" "borg backup tool" +.TH BORG-RENAME 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-rename \- Rename an existing archive . diff --git a/docs/man/borg-serve.1 b/docs/man/borg-serve.1 index c24b868eb..7b9e1c5d2 100644 --- a/docs/man/borg-serve.1 +++ b/docs/man/borg-serve.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-SERVE 1 "2019-02-24" "" "borg backup tool" +.TH BORG-SERVE 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-serve \- Start in server mode. This command is usually not used manually. . @@ -65,7 +65,7 @@ that it is also \fBborg serve\fP and enforce path restriction(s) as given by the forced command. That way, other options given by the client (like \fB\-\-info\fP or \fB\-\-umask\fP) are preserved (and are not fixed by the forced command). .sp -Environment variables (such as BORG_HOSTNAME_IS_UNIQUE) contained in the original +Environment variables (such as BORG_XXX) contained in the original command sent by the client are \fInot\fP interpreted, but ignored. If BORG_XXX environment variables should be set on the \fBborg serve\fP side, then these must be set in system\-specific locations like \fB/etc/environment\fP or in the forced command itself (example below). diff --git a/docs/man/borg-umount.1 b/docs/man/borg-umount.1 index 7867c8c0e..4c5c5abb4 100644 --- a/docs/man/borg-umount.1 +++ b/docs/man/borg-umount.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-UMOUNT 1 "2019-02-24" "" "borg backup tool" +.TH BORG-UMOUNT 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-umount \- un-mount the FUSE filesystem . diff --git a/docs/man/borg-upgrade.1 b/docs/man/borg-upgrade.1 index 2c3c0fe2b..3324fac6f 100644 --- a/docs/man/borg-upgrade.1 +++ b/docs/man/borg-upgrade.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-UPGRADE 1 "2019-02-24" "" "borg backup tool" +.TH BORG-UPGRADE 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-upgrade \- upgrade a repository from a previous version . diff --git a/docs/man/borg-with-lock.1 b/docs/man/borg-with-lock.1 index bd5e5e412..07a50c91f 100644 --- a/docs/man/borg-with-lock.1 +++ b/docs/man/borg-with-lock.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-WITH-LOCK 1 "2019-02-24" "" "borg backup tool" +.TH BORG-WITH-LOCK 1 "2019-03-10" "" "borg backup tool" .SH NAME borg-with-lock \- run a user specified command with the repository lock held . diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1 index e70976393..86f44e832 100644 --- a/docs/man/borgfs.1 +++ b/docs/man/borgfs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORGFS 1 "2019-02-24" "" "borg backup tool" +.TH BORGFS 1 "2019-03-10" "" "borg backup tool" .SH NAME borgfs \- Mount archive or an entire repository as a FUSE filesystem . From 39300d1fd0912f66e75f37e17e55ef93bb1b2f4b Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 11 Mar 2019 00:15:00 +0100 Subject: [PATCH 4/4] docs: fix markup --- docs/man/borg.1 | 2 -- docs/usage_general.rst.inc | 1 + 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/man/borg.1 b/docs/man/borg.1 index 674e2f46f..147b3be2f 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -605,8 +605,6 @@ server to get the approximate resource usage. .IP \(bu 2 \fBborg delete repo:\fP done on the server .UNINDENT -.IP "System Message: WARNING/2 (docs/usage_general.rst.inc:, line 354)" -Bullet list ends without a blank line; unexpected unindent. .sp It won\(aqt go beyond 100% of 1 core as the code is currently single\-threaded. Especially higher zlib and lzma compression levels use significant amounts diff --git a/docs/usage_general.rst.inc b/docs/usage_general.rst.inc index 5918cd55c..e895a5bd2 100644 --- a/docs/usage_general.rst.inc +++ b/docs/usage_general.rst.inc @@ -351,6 +351,7 @@ CPU client: - **borg check:** similar to extract, but depends on options given. - **borg prune / borg delete archive:** low to medium CPU usage - **borg delete repo:** done on the server + It won't go beyond 100% of 1 core as the code is currently single-threaded. Especially higher zlib and lzma compression levels use significant amounts of CPU cycles. Crypto might be cheap on the CPU (if hardware accelerated) or