diff --git a/docs/changes.rst b/docs/changes.rst index e56274b11..c5e382331 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -1493,7 +1493,7 @@ Bug fixes: - borg delete: - make it possible to delete a repo without manifest - - borg delete --forced allows to delete corrupted archives, #1139 + - borg delete --forced allows one to delete corrupted archives, #1139 - borg check: - make borg check work for empty repo diff --git a/docs/internals/data-structures.rst b/docs/internals/data-structures.rst index 7d7e06f03..c5928fda4 100644 --- a/docs/internals/data-structures.rst +++ b/docs/internals/data-structures.rst @@ -374,7 +374,7 @@ needs to be handled. Lastly, cache_ invalidation is handled by noting which feature flags were and which were not understood while manipulating a cache. -This allows to detect whether the cache needs to be invalidated, +This allows borg to detect whether the cache needs to be invalidated, i.e. rebuilt from scratch. See `Cache feature flags`_ below. The *config* key stores the feature flags enabled on a repository: @@ -1022,7 +1022,7 @@ Before feeding the checksum algorithm any data, the file name (i.e. without any is mixed into the checksum, since the name encodes the context of the data for Borg. The various indices used by Borg have separate header and main data parts. -IntegrityCheckedFile allows to checksum them independently, which avoids +IntegrityCheckedFile allows borg to checksum them independently, which avoids even reading the data when the header is corrupted. When a part is signalled, the length of the part name is mixed into the checksum state first (encoded as an ASCII string via `%10d` printf format), then the name of the part diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index f4ee1bf8e..c942a71a8 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -54,14 +54,14 @@ Use lz4 compression. High speed, low compression. (default) .TP .B zlib[,L] Use zlib ("gz") compression. Medium speed, medium compression. -If you do not explicitely give the compression level L (ranging from 0 +If you do not explicitly give the compression level L (ranging from 0 to 9), it will use level 6. Giving level 0 (means "no compression", but still has zlib protocol overhead) is usually pointless, you better use "none" compression. .TP .B lzma[,L] Use lzma ("xz") compression. Low speed, high compression. -If you do not explicitely give the compression level L (ranging from 0 +If you do not explicitly give the compression level L (ranging from 0 to 9), it will use level 6. Giving levels above 6 is pointless and counterproductive because it does not compress better due to the buffer size used by borg \- but it wastes diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index 9d59a08da..0f5ec78a2 100644 --- a/docs/man/borg-key-export.1 +++ b/docs/man/borg-key-export.1 @@ -36,7 +36,7 @@ borg [common options] key export [options] [REPOSITORY] [PATH] .SH DESCRIPTION .sp If repository encryption is used, the repository is inaccessible -without the key. This command allows to backup this essential key. +without the key. This command allows one to backup this essential key. Note that the backup produced does not include the passphrase itself (i.e. the exported key stays encrypted). In order to regain access to a repository, one needs both the exported key and the original passphrase. diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1 index 34b6b486b..1bd11cf40 100644 --- a/docs/man/borg-key-import.1 +++ b/docs/man/borg-key-import.1 @@ -35,8 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] borg [common options] key import [options] [REPOSITORY] [PATH] .SH DESCRIPTION .sp -This command allows to restore a key previously backed up with the -export command. +This command restores a key previously backed up with the export command. .sp If the \fB\-\-paper\fP option is given, the import will be an interactive process in which each line is checked for plausibility before diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index 8c478ceb1..91e99c9eb 100644 --- a/docs/man/borg-recreate.1 +++ b/docs/man/borg-recreate.1 @@ -46,7 +46,7 @@ resulting archive will only contain files from these PATHs. Note that all paths in an archive are relative, therefore absolute patterns/paths will \fInot\fP match (\fB\-\-exclude\fP, \fB\-\-exclude\-from\fP, PATHs). .sp -\fB\-\-recompress\fP allows to change the compression of existing data in archives. +\fB\-\-recompress\fP allows one to change the compression of existing data in archives. Due to how Borg stores compressed size information this might display incorrect information for archives that were not recreated at the same time. There is no risk of data loss by this. diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc index 3201dab4f..02691d58c 100644 --- a/docs/usage/help.rst.inc +++ b/docs/usage/help.rst.inc @@ -245,14 +245,14 @@ lz4 zlib[,L] Use zlib ("gz") compression. Medium speed, medium compression. - If you do not explicitely give the compression level L (ranging from 0 + If you do not explicitly give the compression level L (ranging from 0 to 9), it will use level 6. Giving level 0 (means "no compression", but still has zlib protocol overhead) is usually pointless, you better use "none" compression. lzma[,L] Use lzma ("xz") compression. Low speed, high compression. - If you do not explicitely give the compression level L (ranging from 0 + If you do not explicitly give the compression level L (ranging from 0 to 9), it will use level 6. Giving levels above 6 is pointless and counterproductive because it does not compress better due to the buffer size used by borg - but it wastes diff --git a/docs/usage/key_export.rst.inc b/docs/usage/key_export.rst.inc index 55b3e46d6..a65d32df9 100644 --- a/docs/usage/key_export.rst.inc +++ b/docs/usage/key_export.rst.inc @@ -58,7 +58,7 @@ Description ~~~~~~~~~~~ If repository encryption is used, the repository is inaccessible -without the key. This command allows to backup this essential key. +without the key. This command allows one to backup this essential key. Note that the backup produced does not include the passphrase itself (i.e. the exported key stays encrypted). In order to regain access to a repository, one needs both the exported key and the original passphrase. diff --git a/docs/usage/key_import.rst.inc b/docs/usage/key_import.rst.inc index 4f3961ab6..691de2847 100644 --- a/docs/usage/key_import.rst.inc +++ b/docs/usage/key_import.rst.inc @@ -54,9 +54,8 @@ borg key import Description ~~~~~~~~~~~ -This command allows to restore a key previously backed up with the -export command. +This command restores a key previously backed up with the export command. If the ``--paper`` option is given, the import will be an interactive process in which each line is checked for plausibility before -proceeding to the next line. For this format PATH must not be given. \ No newline at end of file +proceeding to the next line. For this format PATH must not be given. diff --git a/docs/usage/recreate.rst.inc b/docs/usage/recreate.rst.inc index b3071ab3d..49da60d8f 100644 --- a/docs/usage/recreate.rst.inc +++ b/docs/usage/recreate.rst.inc @@ -126,7 +126,7 @@ resulting archive will only contain files from these PATHs. Note that all paths in an archive are relative, therefore absolute patterns/paths will *not* match (``--exclude``, ``--exclude-from``, PATHs). -``--recompress`` allows to change the compression of existing data in archives. +``--recompress`` allows one to change the compression of existing data in archives. Due to how Borg stores compressed size information this might display incorrect information for archives that were not recreated at the same time. There is no risk of data loss by this. diff --git a/scripts/borg.exe.spec b/scripts/borg.exe.spec index ea86a91d4..3d0217f2d 100644 --- a/scripts/borg.exe.spec +++ b/scripts/borg.exe.spec @@ -43,7 +43,7 @@ exe = EXE(pyz, if False: # Enable this block to build a directory-based binary instead of - # a packed single file. This allows to easily look at all included + # a packed single file. This allows one to easily look at all included # files (e.g. without having to strace or halt the built binary # and introspect /tmp). coll = COLLECT(exe, diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 877f6f7b7..8a3acbdc4 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -1973,20 +1973,20 @@ class Archiver: zstd[,L] Use zstd ("zstandard") compression, a modern wide-range algorithm. - If you do not explicitely give the compression level L (ranging from 1 + If you do not explicitly give the compression level L (ranging from 1 to 22), it will use level 3. Archives compressed with zstd are not compatible with borg < 1.1.4. zlib[,L] Use zlib ("gz") compression. Medium speed, medium compression. - If you do not explicitely give the compression level L (ranging from 0 + If you do not explicitly give the compression level L (ranging from 0 to 9), it will use level 6. Giving level 0 (means "no compression", but still has zlib protocol overhead) is usually pointless, you better use "none" compression. lzma[,L] Use lzma ("xz") compression. Low speed, high compression. - If you do not explicitely give the compression level L (ranging from 0 + If you do not explicitly give the compression level L (ranging from 0 to 9), it will use level 6. Giving levels above 6 is pointless and counterproductive because it does not compress better due to the buffer size used by borg - but it wastes @@ -2070,7 +2070,7 @@ class Archiver: then, after parsing the command line, multiple definitions are resolved. Defaults are handled by only setting them on the top-level parser and setting - a sentinel object in all sub-parsers, which then allows to discern which parser + a sentinel object in all sub-parsers, which then allows one to discern which parser supplied the option. """ @@ -2613,7 +2613,7 @@ class Archiver: key_export_epilog = process_epilog(""" If repository encryption is used, the repository is inaccessible - without the key. This command allows to backup this essential key. + without the key. This command allows one to backup this essential key. Note that the backup produced does not include the passphrase itself (i.e. the exported key stays encrypted). In order to regain access to a repository, one needs both the exported key and the original passphrase. @@ -2650,8 +2650,7 @@ class Archiver: help='Create an html file suitable for printing and later type-in or qr scan') key_import_epilog = process_epilog(""" - This command allows to restore a key previously backed up with the - export command. + This command restores a key previously backed up with the export command. If the ``--paper`` option is given, the import will be an interactive process in which each line is checked for plausibility before @@ -3425,7 +3424,7 @@ class Archiver: Note that all paths in an archive are relative, therefore absolute patterns/paths will *not* match (``--exclude``, ``--exclude-from``, PATHs). - ``--recompress`` allows to change the compression of existing data in archives. + ``--recompress`` allows one to change the compression of existing data in archives. Due to how Borg stores compressed size information this might display incorrect information for archives that were not recreated at the same time. There is no risk of data loss by this.