From adbad124782a17db42449e5ccb164e855d231b98 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 11 Aug 2025 22:21:49 +0200 Subject: [PATCH 1/8] github templates: fix typos and grammar --- .github/ISSUE_TEMPLATE.md | 36 +++++++++++++++++------------------ .github/PULL_REQUEST_TEMPLATE | 10 +++++----- 2 files changed, 22 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 455c8535bc..1e55fc065f 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,56 +1,54 @@ -## Have you checked borgbackup docs, FAQ, and open GitHub issues? +## Have you checked the BorgBackup docs, FAQ, and open GitHub issues? No -## Is this a BUG / ISSUE report or a QUESTION? +## Is this a bug/issue report or a question? -Invalid +Bug/Issue/Question -## System information. For client/server mode post info for both machines. +## System information. For client/server mode, post info for both machines. -#### Your borg version (borg -V). +#### Your Borg version (borg -V). #### Operating system (distribution) and version. -#### Hardware / network configuration, and filesystems used. +#### Hardware/network configuration and filesystems used. -#### How much data is handled by borg? +#### How much data is handled by Borg? -#### Full borg commandline that lead to the problem (leave away excludes and passwords) +#### Full Borg command line that led to the problem (leave out excludes and passwords). ## Describe the problem you're observing. #### Can you reproduce the problem? If so, describe how. If not, describe troubleshooting steps you took before opening the issue. -#### Include any warning/errors/backtraces from the system logs +#### Include any warnings/errors/backtraces from the system logs diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index f01ff53c61..d940a67be2 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,8 +1,8 @@ -Thank you for contributing code to Borg, your help is appreciated! +Thank you for contributing code to Borg; your help is appreciated! -Please, before you submit a pull request, make sure it complies with the -guidelines given in our documentation: +Before you submit a pull request, please make sure it complies with the +guidelines in our documentation: -https://borgbackup.readthedocs.io/en/latest/development.html#contributions +https://borgbackup.readthedocs.io/en/stable/development.html#contributions -**Please remove all above text before submitting your pull request.** +**Please remove the text above before submitting your pull request.** From f9ec04ddf6414c1c5de242d029b418a134c3083a Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Tue, 12 Aug 2025 11:15:11 +0200 Subject: [PATCH 2/8] github workflows: fix typos and grammar --- .github/workflows/black.yaml | 2 +- .github/workflows/ci.yml | 24 ++++++++++++------------ .github/workflows/codeql-analysis.yml | 2 +- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/black.yaml b/.github/workflows/black.yaml index 6d473e0af3..da37981fef 100644 --- a/.github/workflows/black.yaml +++ b/.github/workflows/black.yaml @@ -1,5 +1,5 @@ # https://black.readthedocs.io/en/stable/integrations/github_actions.html#usage -# see also what we use locally, requirements.d/codestyle.txt - should be the same version here. +# See also what we use locally in requirements.d/codestyle.txt — this should be the same version here. name: Lint diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9fd6680e7d..869daa0e78 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -# badge: https://github.com/borgbackup/borg/workflows/CI/badge.svg?branch=master +# badge: https://github.com/borgbackup/borg/workflows/CI/badge.svg?branch=1.4-maint name: CI @@ -97,7 +97,7 @@ jobs: steps: - uses: actions/checkout@v4 with: - # just fetching 1 commit is not enough for setuptools-scm, so we fetch all + # Just fetching one commit is not enough for setuptools-scm, so we fetch all. fetch-depth: 0 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 @@ -206,7 +206,7 @@ jobs: include: - os: macos-14 python-version: '3.11' - toxenv: py311-none # note: no fuse testing, due to #6099, see also #6196. + toxenv: py311-none # Note: no FUSE testing due to #6099; see also #6196. env: # Configure pkg-config to use OpenSSL from Homebrew @@ -219,7 +219,7 @@ jobs: steps: - uses: actions/checkout@v4 with: - # just fetching 1 commit is not enough for setuptools-scm, so we fetch all + # Just fetching one commit is not enough for setuptools-scm, so we fetch all fetch-depth: 0 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 @@ -243,21 +243,21 @@ jobs: run: | python -m pip install --upgrade pip setuptools wheel pip install -r requirements.d/development.txt - - name: Install borgbackup + - name: Install BorgBackup env: - # we already have that in the global env, but something is broken and overwrites that. - # so, set it here, again. + # We already have this in the global environment, but something overrides it. + # So set it here again. PKG_CONFIG_PATH: "/opt/homebrew/opt/openssl@3.0/lib/pkgconfig:$PKG_CONFIG_PATH" run: | pip install -ve . - - name: run tox env + - name: Run pytest via tox env: - # we already have that in the global env, but something is broken and overwrites that. - # so, set it here, again. + # We already have this in the global environment, but something overrides it. + # So set it here again. PKG_CONFIG_PATH: "/opt/homebrew/opt/openssl@3.0/lib/pkgconfig:$PKG_CONFIG_PATH" XDISTN: "6" run: | - # do not use fakeroot, but run as root. avoids the dreaded EISDIR sporadic failures. see #2482. + # Do not use fakeroot; run as root. Avoids the dreaded sporadic EISDIR failures; see #2482. #sudo -E bash -c "tox -e py" tox --skip-missing-interpreters - name: Upload coverage to Codecov @@ -271,7 +271,7 @@ jobs: windows: - if: false # can be used to temporary disable build + if: false # can be used to temporarily disable the build runs-on: windows-latest timeout-minutes: 120 needs: linux diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 2a7745259c..b760d85fd7 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -31,7 +31,7 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 with: - # just fetching 1 commit is not enough for setuptools-scm, so we fetch all + # Just fetching one commit is not enough for setuptools-scm, so we fetch all. fetch-depth: 0 - name: Set up Python uses: actions/setup-python@v5 From ed73aa19d257cd60a5550c50ad294da91c461d71 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Tue, 12 Aug 2025 11:21:50 +0200 Subject: [PATCH 3/8] README: fix typos and grammar --- README.rst | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/README.rst b/README.rst index a100c1c587..ee3859aa50 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ This is borg2! Please note that this is the README for borg2 / master branch. -For the stable version's docs, please see there: +For the stable version's docs, please see here: https://borgbackup.readthedocs.io/en/stable/ @@ -14,7 +14,7 @@ next-beta upgrade code, so you will have to delete and re-create repos). Thus, **DO NOT USE BORG2 FOR YOUR PRODUCTION BACKUPS!** Please help with testing it, but set it up *additionally* to your production backups. -TODO: the screencasts need a remake using borg2, see there: +TODO: the screencasts need a remake using borg2, see here: https://github.com/borgbackup/borg/issues/6303 @@ -35,7 +35,7 @@ See the `installation manual`_ or, if you have already downloaded Borg, ``docs/installation.rst`` to get started with Borg. There is also an `offline documentation`_ available, in multiple formats. -.. _installation manual: https://borgbackup.readthedocs.org/en/stable/installation.html +.. _installation manual: https://borgbackup.readthedocs.io/en/master/installation.html .. _offline documentation: https://readthedocs.org/projects/borgbackup/downloads Main features @@ -78,7 +78,7 @@ Main features authenticity. **Obfuscation** - Optionally, borg can actively obfuscate e.g. the size of files / chunks to + Optionally, Borg can actively obfuscate, e.g., the size of files/chunks to make fingerprinting attacks more difficult. **Compression** @@ -91,13 +91,13 @@ Main features * lzma (low speed, high compression) **Off-site backups** - Borg can store data on any remote host accessible over SSH. If Borg is - installed on the remote host, big performance gains can be achieved - compared to using a network filesystem (sshfs, nfs, ...). + Borg can store data on any remote host accessible over SSH. If Borg is + installed on the remote host, significant performance gains can be achieved + compared to using a network file system (sshfs, NFS, ...). -**Backups mountable as filesystems** - Backup archives are mountable as userspace filesystems for easy interactive - backup examination and restores (e.g. by using a regular file manager). +**Backups mountable as file systems** + Backup archives are mountable as user-space file systems for easy interactive + backup examination and restores (e.g., by using a regular file manager). **Easy installation on multiple platforms** We offer single-file binaries that do not require installing anything - @@ -108,7 +108,7 @@ Main features * FreeBSD * OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet) * Cygwin (experimental, no binaries yet) - * Linux Subsystem of Windows 10 (experimental) + * Windows Subsystem for Linux (WSL) on Windows 10/11 (experimental) **Free and Open Source Software** * security and functionality can be audited independently @@ -130,7 +130,7 @@ Create a new backup archive:: $ borg create Monday1 ~/Documents -Now doing another backup, just to show off the great deduplication:: +Now do another backup, just to show off the great deduplication:: $ borg create -v --stats Monday2 ~/Documents Repository: /path/to/repo @@ -144,31 +144,31 @@ Now doing another backup, just to show off the great deduplication:: Deduplicated size: 520 B -Helping, Donations and Bounties, becoming a Patron +Helping, donations and bounties, becoming a Patron -------------------------------------------------- Your help is always welcome! Spread the word, give feedback, help with documentation, testing or development. -You can also give monetary support to the project, see there for details: +You can also give monetary support to the project, see here for details: https://www.borgbackup.org/support/fund.html Links ----- -* `Main Web Site `_ +* `Main website `_ * `Releases `_, `PyPI packages `_ and - `ChangeLog `_ -* `Offline Documentation `_ + `Changelog `_ +* `Offline documentation `_ * `GitHub `_ and - `Issue Tracker `_. -* `Web-Chat (IRC) `_ and - `Mailing List `_ -* `License `_ -* `Security contact `_ + `Issue tracker `_. +* `Web chat (IRC) `_ and + `Mailing list `_ +* `License `_ +* `Security contact `_ Compatibility notes ------------------- @@ -178,7 +178,7 @@ CHANGES (like when going from 0.x.y to 1.0.0 or from 1.x.y to 2.0.0). NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES. -THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS. +THIS IS SOFTWARE IN DEVELOPMENT, DECIDE FOR YOURSELF WHETHER IT FITS YOUR NEEDS. Security issues should be reported to the `Security contact`_ (or see ``docs/support.rst`` in the source distribution). @@ -187,9 +187,9 @@ see ``docs/support.rst`` in the source distribution). |doc| |build| |coverage| |bestpractices| -.. |doc| image:: https://readthedocs.org/projects/borgbackup/badge/?version=stable +.. |doc| image:: https://readthedocs.org/projects/borgbackup/badge/?version=master :alt: Documentation - :target: https://borgbackup.readthedocs.org/en/stable/ + :target: https://borgbackup.readthedocs.io/en/master/ .. |build| image:: https://github.com/borgbackup/borg/workflows/CI/badge.svg?branch=master :alt: Build Status (master) From dd06c0778926d9c140592317cf61a04e25a2bc51 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Tue, 12 Aug 2025 16:56:00 +0200 Subject: [PATCH 4/8] paperkey.html: fix typos, grammar, html structure MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The original markup included a paragraph element wrapping a block-level pre element, which is invalid per HTML’s content model (a p can only contain phrasing content; pre is flow content). The fix separated text and pre blocks into valid sibling elements, ensuring no pre is nested inside a p. --- src/borg/paperkey.html | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/src/borg/paperkey.html b/src/borg/paperkey.html index 8dd818cbd0..4143bc7cd7 100644 --- a/src/borg/paperkey.html +++ b/src/borg/paperkey.html @@ -2,21 +2,21 @@ BorgBackup Printable Key Template - +