fix grammar and typos

Author: ThomasWaldmann

README.md

@@ -2,37 +2,37 @@
 
 [![Build Status](https://github.com/borgbackup/borgbackup.github.io/workflows/Update%20pages/badge.svg)](https://github.com/borgbackup/borgbackup.github.io/actions)
 
-This is the project web site of BorgBackup.
+This is the project website of BorgBackup.
 
-All pages are meant to load very quickly with few/no external resources. All pages are generated from rST.
+All pages are meant to load very quickly with few or no external resources. All pages are generated from reStructuredText (reST).
 
-HTML files are **never** committed to this ("source") branch. Github Actions automatically updates
+HTML files are **never** committed to this ("source") branch. GitHub Actions automatically updates
 the published ("master") branch. **Therefore pull requests should be submitted only to the "source" branch.**
 
-To locally preview changes, update the HTML after editing a rST file, run `make`. To clean all rendered HTML and remake, run `make clean all`. 
-This requires a relatively recent docutils release, since it uses rst2html5. To install rst2html5 `python3 -m pip install rst2html5`
+To locally preview changes and update the HTML after editing an .rst file, run `make`. To clean all rendered HTML and remake, run `make clean all`. 
+This requires a relatively recent Docutils release, since it uses rst2html5. To install rst2html5, run: `python3 -m pip install rst2html5`.
 
 ## Release docs
 
 Release documentation is published on RTD and released as part of the official tarballs,
-as well as distributed in most distribution packages. They are only valid for their release.
+as well as distributed in most distribution packages. These are only valid for their respective releases.
 
 The *release* docs are managed on https://readthedocs.org/projects/borgbackup and available at https://borgbackup.readthedocs.io/en/latest/ (RTD).
 
 The *borgweb* manual is on RTD as well: https://borgweb.readthedocs.io/
 
-Previously documentation was hosted directly here, before the move to RTD.
-There are still redirections (borgbackup/, borgweb/) to the RTD site here
-to keep old URLs working for a while, although that doesn't work with sub-pages.
+Previously, the documentation was hosted directly here before the move to RTD.
+There are still redirects (borgbackup/, borgweb/) to the RTD site here
+to keep old URLs working for a while; however, that does not work with subpages.
 
 To manage the documentation and releases, see the development guide at:
 https://borgbackup.readthedocs.io/en/latest/development.html#building-the-docs-with-sphinx
 
 ## Setup
 
-Github Actions builds the "source" branch, generates HTML, commits it and
+GitHub Actions builds the "source" branch, generates HTML, commits it, and
 pushes it to the "master" branch with a GitHub deploy key.
 
-GitHub Pages is used as the host, TLS cert comes from LetsEncrypt (via GitHub).
+GitHub Pages is used as the host, and the TLS certificate comes from Let's Encrypt (via GitHub).
 
 More details: https://github.com/borgbackup/borgbackup.github.io/issues/45

demo.rst

@@ -11,22 +11,22 @@ Demo — BorgBackup
 
     <h1 id="tagline">Borg demos</h1>
 
-    <p>All text in the following screencasts can be highlighted and copied!</p>
+    <p>All text in the screencasts below can be highlighted and copied!</p>
 
     <div id="demo">
-        <h2>BorgBackup 1.1 - basic usage</h2>
+        <h2>BorgBackup 1.1 — basic usage</h2>
         <asciinema-player src="_assets/asciicast-133292.json" speed="1.0"></asciinema-player>
         6m 11s
         <hr>
-        <h2>BorgBackup 1.1 - installation</h2>
+        <h2>BorgBackup 1.1 — installation</h2>
         <asciinema-player src="_assets/asciicast-133291.json" speed="1.0"></asciinema-player>
         1m 40s
         <hr>
-        <h2>BorgBackup 1.1 - advanced usage</h2>
+        <h2>BorgBackup 1.1 — advanced usage</h2>
         <asciinema-player src="_assets/asciicast-133293.json" speed="1.0"></asciinema-player>
         7m 9s
         <hr>
-        <h2>BorgBackup 1.0 - installation and basic usage</h2>
+        <h2>BorgBackup 1.0 — installation and basic usage</h2>
         <asciinema-player src="_assets/asciinema-28691.json"  speed="1.5"></asciinema-player>
         5m 30s
     </div>

index.rst

@@ -8,16 +8,16 @@ BorgBackup – Deduplicating archiver with compression and authenticated encrypt
 
     <h1 id="tagline">Deduplicating archiver with compression and encryption</h1>
 
-    BorgBackup (short: Borg) gives you:
+    BorgBackup (Borg for short) provides:
 
     <ul>
-        <li>Space efficient storage of backups.
+        <li>Space-efficient storage of backups.
         <li>Secure, authenticated encryption.
-        <li>Compression: lz4, zstd, zlib, lzma or none.
+        <li>Compression: lz4, zstd, zlib, lzma, or none.
         <li>Mountable backups with FUSE.
         <li>Easy installation on multiple platforms: Linux, macOS, BSD, ...
         <li>Free software (BSD license).
-        <li>Backed by a large and active open source community.
+        <li>Backed by a large and active open-source community.
     </ul>
 
     <em>... and always check your backups!</em>

releases/borg-1.1.rst

@@ -24,38 +24,38 @@ to see all changes.
 Major new features in the 1.1 release series are:
 
 - borg recreate: remove files from existing archives and re-chunk or re-compress them.
-  This finally allows deduplication between legacy Attic / Borg 0.xx archives and Borg 1.x archives.
+  This finally allows deduplication between legacy Attic/Borg 0.xx archives and Borg 1.x archives.
   This is an experimental feature.
 - borg diff: show differences between two archives.
 - borg mount: show all recorded versions of files with the "versions view".
 - borg list: more formatting options, including generation of hashes and per-file chunk statistics.
 - borg create: automatic compression mode (-C auto,zlib/lz4/...), faster handling of many files,
   experimental support for inclusion patterns (--patterns, --patterns-from), files cache mode control (mtime/ctime)
-- borg export-tar: streaming export of GNU tar compatible archives.
+- borg export-tar: streaming export of GNU tar-compatible archives.
 - Archive comments
 - BLAKE2b256-based encryption modes, and "authenticated" modes that provide data integrity without encryption.
   These provide better performance than the existing SHA-256-based modes on most hardware, except where
   the x86 SHA extensions are available (e.g. AMD Ryzen).
-- Repository indices and the Borg cache now use checksums to detect bitrot and other corruption.
-- A documented JSON API has been added to the most vital commands (borg list, borg info and borg create).
+- Repository indices and the Borg cache now use checksums to detect bit rot and other corruption.
+- A documented JSON API has been added to the most vital commands (borg list, borg info, and borg create).
 - Structured JSON logging is available for all commands.
 - ``--prefix`` has been supplemented with ``--glob-archives`` (``-a``), ``--sort-by``, ``--last`` and ``--first`` options.
   These can be used for ``borg list``, ``borg info``, ``borg mount``, ``borg check``, ``borg delete`` and ``borg prune``.
 
 Quality of life improvements:
 
-- options that imply output (--show-rc, --show-version, --list, --stats, --progress) don't need -v/--info to have that output displayed any more.
+- options that imply output (--show-rc, --show-version, --list, --stats, --progress) no longer need -v/--info to display that output.
 - borg check is silent by default (finally!).
 - borg can now checkpoint within (big) files, not only between files.
 - borg delete can delete multiple archives by giving their names.
 - Automatic removal of stale locks, which should make "borg break-lock" essentially superfluous.
   This is enabled by default, see BORG_HOSTNAME_IS_UNIQUE.
 - Answers to prompts like "Accessing previously unknown repository" are now saved immediately.
 - Cache synchronization and "borg info" are now faster.
-- Reduced space usage of chunks.archive.d in the cache by 30-40 %. Existing caches are migrated during a cache sync.
-- The cache used for remote cache syncs and mounting remote repositories does not grow indefinitely any more,
+- Reduced space usage of chunks.archive.d in the cache by 30-40%. Existing caches are migrated during a cache sync.
+- The cache used for remote cache syncs and mounting remote repositories does not grow indefinitely anymore,
   but adapts to the available space. Good riddance, TMP=/var/tmp!
-- BORG_PASSCOMMAND makes using key rings and hardware keys much easier.
+- BORG_PASSCOMMAND makes using keyrings and hardware keys much easier.
 
 Documentation improvements:
 
@@ -66,13 +66,13 @@ Documentation improvements:
 - New deployment guides
 - The internals docs saw many corrections and extensions.
 - man pages are now provided in source releases.
-- ``--help`` uses ANSI sequence on terminals for basic markup
+- ``--help`` uses ANSI sequences in terminals for basic markup
 - New asciinema screencasts.
 
 Compatibility notes for upgrading from Borg 1.0 to Borg 1.1:
 
 - **No explicit "borg upgrade" is required.**
-- Borg 1.1 uses some new data structures which are backwards-compatible with Borg 1.0.4 and newer.
+- Borg 1.1 uses some new data structures that are backward-compatible with Borg 1.0.4 and newer.
 - Borg 1.0 can't make use of Borg 1.1's "compact cache" and will silently ignore it.
 - The default compression has been changed from "none" to "lz4".
 - Repositories in the "repokey" and "repokey-blake2" modes with an empty passphrase are now treated as
@@ -81,9 +81,9 @@ Compatibility notes for upgrading from Borg 1.0 to Borg 1.1:
 
   - -e/--encryption is now a mandatory option with no default value.
     Previously the default value was "repokey".
-  - the short form of --append-only (-a) has been removed.
-  - running "borg init" via a "borg serve --append-only" server will *not* create
-    an append-only repository any more. Use "borg init --append-only" to initialize an append-only repository.
+  - The short form of --append-only (-a) has been removed.
+  - Running "borg init" via a "borg serve --append-only" server will *not* create
+    an append-only repository anymore. Use "borg init --append-only" to initialize an append-only repository.
 
 - borg create:
 
@@ -94,20 +94,20 @@ Compatibility notes for upgrading from Borg 1.0 to Borg 1.1:
     Passing explicitly --files-cache with the old default: "mtime,size,inode" would avoid the slowdown,
     but is not advisable as "ctime" is better as it reflects both file contents and metadata changes,
     while "mtime" reflects only file contents changes.
-  - the --exclude-if-present option now supports tagging a folder with any file system
+  - The --exclude-if-present option now supports tagging a folder with any file system
     object type (file, folder, etc.), instead of accepting only files as tags.
 
-- borg upgrade: the short form of --inplace (-i) has been removed.
-- borg delete: the short form of --cache-only (-c) has been removed.
+- borg upgrade: The short form of --inplace (-i) has been removed.
+- borg delete: The short form of --cache-only (-c) has been removed.
 - "borg migrate-to-repokey" has been renamed to "borg key migrate-to-repokey" with no deprecation notice,
   since it is rarely and only manually used.
 
 Deprecated options and commands in Borg 1.1, which will be removed in Borg 1.2:
 
-- "borg change-passphrase" is deprecated, use "borg key change-passphrase" instead.
+- "borg change-passphrase" is deprecated; use "borg key change-passphrase" instead.
   "borg change-passphrase" will be removed in Borg 1.2.
 - borg create: the --keep-tag-files option has been deprecated in favour of the new --keep-exclude-tags option.
-  Both options have the same effect. --keep-tag-files will be removed in Borg 1.2.
+  Both options have the same effect. "--keep-tag-files" will be removed in Borg 1.2.
 - borg create: the --ignore-inode option has been deprecated in favour of --files-cache=... modes without "inode".
   --ignore-inode will be removed in Borg 1.2.
 - borg create: the --no-files-cache option has been deprecated in favour of --files-cache=disabled.
@@ -124,7 +124,7 @@ Contributors to the main repository for this release were:
 
 .. git log 1.0.0..1.1.0  --format=format:%an | sort | uniq
 
-.. The .contributor spans avoid word-wrapping names, since that's a rude thing to do.
+.. The .contributor spans avoid word wrapping names, since that's a rude thing to do.
 
 .. container:: contributors
 
@@ -215,14 +215,14 @@ Contributors to the main repository for this release were:
 Special thanks also go to everyone and every organization donating funds
 to support development and maintainers:
 
-.. Manually gathered from BountySource, https://www.bountysource.com/teams/borgbackup/backers
+.. Manually gathered from Bountysource, https://www.bountysource.com/teams/borgbackup/backers
 
 .. container:: contributors
 
   .. raw:: html
 
     <span class='contributor'>storcium ·</span>
-    <span class='contributor'>IT Service Group of the Department of Computer Science, ETH Zürch ·</span>
+    <span class='contributor'>IT Service Group of the Department of Computer Science, ETH Zürich ·</span>
     <span class='contributor'>TheVillux ·</span>
     <span class='contributor'>Daniel Parks ·</span>
     <span class='contributor'>Dave Barker ·</span>

releases/borg-1.2.rst

@@ -8,7 +8,7 @@ This marks the first stable release in the Borg 1.2 series. Many improvements an
 were incorporated into Borg 1.2 since the 1.1 release of Borg in early 2017. Even more changes
 were made "under the hood": cleanups and refactors.
 
-Many people contributed to this release — see the AUTHORS file in the git repo and the
+Many people contributed to this release — see the AUTHORS file in the Git repo and the
 git history for details. Even more people contributed otherwise, e.g. by giving feedback
 or helping with testing.
 
@@ -31,52 +31,52 @@ Major new features in the 1.2 release series are:
 - create: Internally use file descriptors rather than file names (as much as
   possible) to avoid race conditions on active file systems.
 - create: Externalize file discovery via --paths-from-stdin and --paths-from-command.
-  Using this, you can just feed a list of full path/filenames into borg and borg
+  Using this, you can feed a list of full path/file names into Borg, and Borg
   will create a backup archive with the corresponding files (no more, no less).
-- create: --content-from-command: Create archive using stdout of given command.
-- create: --compression: New 'obfuscate' pseudo compressor obfuscates compressed
+- create: --content-from-command: Create an archive using the stdout of the given command.
+- create: --compression: New 'obfuscate' pseudo-compressor obfuscates compressed
   chunk sizes in the repository. You can use this to make chunk size fingerprinting
   attacks against your repo much harder. It will use more storage space for
   better privacy (and you can decide how much it is worth to you).
 - create: --chunker-params: New, very fast 'fixed' block size chunker (also
   puts less load on the CPU compared to the buzhash chunker). Recommended for
   everything with a fixed block size, like disk devices, raw disk images,
-  files with fixed record sizes (header record can be of different size).
+  files with fixed record sizes (the header record can be of a different size).
 - create: Improve sparse file support, much faster, especially when used
   together with the 'fixed' chunker.
 - compact: Separate "borg compact" needs to be used to free repository space.
   Borg < 1.2 always compacted at the end of repo-writing commands, so these
-  will be faster now. Also, you get kind of a "temporary append-only" behaviour
+  will be faster now. Also, you get kind of a "temporary append-only" behavior
   until you invoke borg compact. For some users, less stuff moving around in
-  the repo directory also might make rclones or rsyncs of their borg repo faster.
+  the repo directory also might make rclone or rsync operations of their Borg repo faster.
   "borg compact" can be invoked from the repo server, borg hosting providers can
   offer to use off-peak-hours for compaction.
 - repository: Other optimizations for better speed and less stuff moving around.
-- check: --max-duration: Incremental, time-limited repo check (crc32 check only).
+- check: --max-duration: Incremental, time-limited repo check (CRC32 check only).
   Users with huge repositories can use this to distribute their repo checks
   over multiple free time slots (for example, do a partial check each Sunday,
   resulting in a full check after multiple weeks).
-- mount: Support new/maintained pyfuse3 as an alternative to the old llfuse lib.
+- mount: Support new, maintained pyfuse3 as an alternative to the old llfuse library.
 - import-tar: New complement to export-tar. Import existing tar files or
-  (together with export-tar) move archives from one borg repo to another.
+  (together with export-tar) move archives from one Borg repo to another.
   Please note that currently export-tar + import-tar is a lossy conversion as
-  it does not support all metadata that borg create/extract supports (like
+  it does not support all metadata that Borg create/extract supports (like
   ACLs, xattrs, flags).
-- Minimal native Windows support, see Windows readme (WIP).
+- Minimal native Windows support; see the Windows README (WIP).
 
 Other changes:
 
 - create/recreate: Showing the current file name **before** starting to back it
   up makes life easier, especially for very big files which take a while...
-- create: First ctrl-c (SIGINT) triggers checkpoint creation and then aborts.
+- create: First Ctrl-C (SIGINT) triggers checkpoint creation and then aborts.
 - create: --remote-buffer: Use an upload buffer for remote repos.
-- prune: Show which rule was applied to keep archive (kind of self-explanatory).
+- prune: Show which rule was applied to keep an archive (kind of self-explanatory).
 - check: Much faster when recovering data from corrupted segment files.
 - New BORG_WORKAROUNDS mechanism.
 - Works with recent Python, msgpack, PyInstaller, etc. versions.
-- Major setup code refactoring (especially library handling), needs pypi "pkgconfig".
-- Other major internal refactors / cleanups.
-- Internal AEAD-style crypto API (not all you see in there is used already).
+- Major setup code refactoring (especially library handling), requires PyPI "pkgconfig".
+- Other major internal refactors/cleanups.
+- Internal AEAD-style crypto API (not everything you see there is used yet).
 - Internal msgpack-wrapper to avoid current and future compatibility issues.
-- Improved C code portability / basic MSC compatibility.
+- Improved C code portability/basic MSC compatibility.
 - Improved documentation (a lot of this was also backported to 1.1.x though).