borgbackup 2.0.0b7__tar.gz → 2.0.0b9__tar.gz

{borgbackup-2.0.0b7 → borgbackup-2.0.0b9}/.readthedocs.yaml

@@ -28,3 +28,6 @@ python:
 
 sphinx:
     configuration: docs/conf.py
+
+formats:
+    - htmlzip

borgbackup-2.0.0b9/Brewfile

@@ -0,0 +1,12 @@
+brew 'pkg-config'
+brew 'zstd'
+brew 'lz4'
+brew 'xxhash'
+brew 'openssl@3.0'
+
+# osxfuse (aka macFUSE) is only required for "borg mount",
+# but won't work on github actions' workers.
+# it requires installing a kernel extension, so some users
+# may want it and some won't.
+
+#cask 'osxfuse'

{borgbackup-2.0.0b7 → borgbackup-2.0.0b9}/CHANGES.rst

@@ -120,7 +120,7 @@ Compatibility notes:
 Change Log 2.x
 ==============
 
-Version 2.0.0b7 (2023-09-14)
+Version 2.0.0b9 (2024-07-20)
 ----------------------------
 
 Please note:
@@ -132,6 +132,124 @@ above.
 
 New features:
 
+- add BORG_CACHE_IMPL, default is "adhocwithfiles" to test the new cache
+  implementation, featuring an adhoc non-persistent chunks cache and a
+  persistent files cache. See the docs for other values.
+
+  Requires to run "borg check --repair --archives-only" to delete orphaned
+  chunks before running "borg compact" to free space! These orphans are
+  expected due to the simplified refcounting with the AdHocFilesCache.
+- make BORG_EXIT_CODES="modern" the default, #8110
+- add BORG_USE_CHUNKS_ARCHIVE env var, #8280
+- automatically rebuild cache on exception, #5213
+
+Bug fixes:
+
+- fix Ctrl-C / SIGINT behaviour for pyinstaller-made binaries, #8155
+- delete: fix error handling with Ctrl-C
+- rcompress: fix error handling with Ctrl-C
+- delete: fix error handling when no archive is specified, #8256
+- setup.py: fix import error reporting for cythonize import, see #8208
+- create: deal with EBUSY, #8123
+- benchmark: inherit options --rsh --remote-path, #8099
+- benchmark: fix return value, #8113
+- key export: fix crash when no path is given, fix exception handling
+
+Other changes:
+
+- setup.py: detect noexec build fs issue, see #8208
+- improve acl_get / acl_set error handling (forward port from 1.4-maint)
+- allow msgpack 1.1.0
+- vagrant: use pyinstaller 6.7.0
+- use Python 3.11.9 for binary builds
+- require Cython 3.0.3 at least, #8133
+- docs: add non-root deployment strategy
+
+
+Version 2.0.0b8 (2024-02-20)
+----------------------------
+
+New features:
+
+- create: add the slashdot hack, update docs, #4685
+- BORG_EXIT_CODES=modern: optional more specific return codes (for errors and warnings).
+
+  The default value of this new environment variable is "legacy", which should result in
+  a behaviour similar to borg 1.2 and older (only using rc 0, 1 and 2).
+  "modern" exit codes are much more specific (see the internals/frontends docs).
+- implement "borg version" (shows client and server version), #7829
+
+Fixes:
+
+- docs: CVE-2023-36811 upgrade steps: consider checkpoint archives, #7802
+- check/compact: fix spurious reappearance of orphan chunks since borg 1.2, #6687 -
+  this consists of 2 fixes:
+
+  - for existing chunks: check --repair: recreate shadow index, #7897 #6687
+  - for newly created chunks: update shadow index when doing a double-put, #7896 #5661
+
+  If you have experienced issue #6687, you may want to run borg check --repair
+  after upgrading to borg 1.2.7 to recreate the shadow index and get rid of the
+  issue for existing chunks.
+- check: fix return code for index entry value discrepancies
+- LockRoster.modify: no KeyError if element was already gone, #7937
+- create --X-from-command: run subcommands with a clean environment, #7916
+- list --sort-by: support "archive" as alias of "name", #7873
+- fix rc and msg if arg parsing throws an exception, #7885
+- PATH: do not accept empty strings, #4221
+- fix invalid pattern argument error msg
+- zlib legacy decompress fixes, #7883
+
+Other changes:
+
+- replace archive/manifest TAMs by typed repo objects (ro_type), docs, #7670
+- crypto: use a one-step kdf for session keys, #7953
+- remove recreate --recompress option, use the more efficient repo-wide "rcompress".
+- include unistd.h in _chunker.c (fix for Python 3.13)
+- allow msgpack 1.0.7
+- allow platformdirs 4, #7950
+- use and require cython3
+- move conftest.py to src/borg/testsuite, #6386
+- use less setup.py, use pip and build
+- linux: use pkgconfig to find libacl
+- borg.logger: use same method params as python logging
+- create and use Brewfile, document "brew bundle" install (macOS)
+- blacken master branch
+- prevent CLI argument issues in scripts/glibc_check.py
+- pyproject.toml: exclude source files which have been compiled, #7828
+- sdist: dynamically compute readme (long_description)
+- init: better borg key export instructions
+- scripts/make.py: move clean, build_man, build_usage to there,
+  so we do not need to invoke setup.py directly, update docs
+- vagrant:
+
+  - use openssl 3.0 on macOS
+  - add script for fetching borg binaries from VMs, #7989
+  - use generic/openbsd7 box
+  - netbsd: test on py311 only
+  - remove debian 9 "stretch" box
+  - use freebsd 14, #6871
+  - use python 3.9.4 for tests, latest python 3.11.7 for binary builds
+  - use pyinstaller 6.3.0
+- docs:
+
+  - add typical PR workflow to development docs, #7495
+  - improve docs for borg with-lock, add example #8024
+  - create disk/partition sector backup by disk serial number
+  - Add "check.rebuild_refcounts" message
+  - not only attack/unsafe, can also be a fs issue, #7853
+  - use virtualenv on Cygwin
+  - readthedocs: also build offline docs, #7835
+  - do not refer to setup.py installation method
+  - how to run the testsuite using the dist package
+  - requirements are defined in pyproject.toml
+
+
+Version 2.0.0b7 (2023-09-14)
+----------------------------
+
+New features:
+
 - BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos
   without having the borg key, #7700
 
@@ -248,7 +366,7 @@ Other changes:
   - improve mount options rendering, #7359
   - make timestamps in manual pages reproducible.
   - describe performing pull-backups via ssh remote forwarding
-  - suggest to use forced command when using remote-fowarding via ssh
+  - suggest to use forced command when using remote-forwarding via ssh
   - fix some -a / --match-archives docs issues
   - incl./excl. options header, clarify --path-from-stdin exclusive control
   - add note about MAX_DATA_SIZE

{borgbackup-2.0.0b7 → borgbackup-2.0.0b9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: borgbackup
-Version: 2.0.0b7
+Version: 2.0.0b9
 Summary: Deduplicated, encrypted, authenticated and compressed backups
 Author: The Borg Collective (see AUTHORS file)
 Maintainer-email: Thomas Waldmann <tw@waldmann-edv.de>
@@ -29,27 +29,18 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Security :: Cryptography
 Classifier: Topic :: System :: Archiving :: Backup
 Requires-Python: >=3.9
-Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: msgpack<=1.1.0,>=1.0.3
+Requires-Dist: packaging
+Requires-Dist: platformdirs<5.0.0,>=3.0.0; sys_platform == "darwin"
+Requires-Dist: platformdirs<5.0.0,>=2.6.0; sys_platform != "darwin"
+Requires-Dist: argon2-cffi
 Provides-Extra: llfuse
+Requires-Dist: llfuse>=1.3.8; extra == "llfuse"
 Provides-Extra: pyfuse3
+Requires-Dist: pyfuse3>=3.1.1; extra == "pyfuse3"
 Provides-Extra: nofuse
-License-File: LICENSE
-License-File: AUTHORS
-
-This is borg2!
---------------
-
-Please note that this is the README for borg2 / master branch.
-
-borg2 is currently in beta testing.
-
-For the stable version's docs, please see there:
-
-https://borgbackup.readthedocs.io/en/stable/
-
-TODO: the screencasts need a remake using borg2, see there:
-
-https://github.com/borgbackup/borg/issues/6303
 
 
 What is BorgBackup?
@@ -216,37 +207,4 @@ THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.
 Security issues should be reported to the `Security contact`_ (or
 see ``docs/support.rst`` in the source distribution).
 
-.. start-badges
-
-|doc| |build| |coverage| |bestpractices| |bounties|
-
-.. |bounties| image:: https://api.bountysource.com/badge/team?team_id=78284&style=bounties_posted
-        :alt: Bounty Source
-        :target: https://www.bountysource.com/teams/borgbackup
-
-.. |doc| image:: https://readthedocs.org/projects/borgbackup/badge/?version=stable
-        :alt: Documentation
-        :target: https://borgbackup.readthedocs.org/en/stable/
-
-.. |build| image:: https://github.com/borgbackup/borg/workflows/CI/badge.svg?branch=master
-        :alt: Build Status (master)
-        :target: https://github.com/borgbackup/borg/actions
-
-.. |coverage| image:: https://codecov.io/github/borgbackup/borg/coverage.svg?branch=master
-        :alt: Test Coverage
-        :target: https://codecov.io/github/borgbackup/borg?branch=master
-
-.. |screencast_basic| image:: https://asciinema.org/a/133292.png
-        :alt: BorgBackup Basic Usage
-        :target: https://asciinema.org/a/133292?autoplay=1&speed=1
-        :width: 100%
-
-.. _installation: https://asciinema.org/a/133291?autoplay=1&speed=1
-
-.. _advanced usage: https://asciinema.org/a/133293?autoplay=1&speed=1
-
-.. |bestpractices| image:: https://bestpractices.coreinfrastructure.org/projects/271/badge
-        :alt: Best Practices Score
-        :target: https://bestpractices.coreinfrastructure.org/projects/271
 
-.. end-badges

{borgbackup-2.0.0b7 → borgbackup-2.0.0b9}/README.rst

@@ -3,12 +3,17 @@ This is borg2!
 
 Please note that this is the README for borg2 / master branch.
 
-borg2 is currently in beta testing.
-
 For the stable version's docs, please see there:
 
 https://borgbackup.readthedocs.io/en/stable/
 
+Borg2 is currently in beta testing and might get major and/or
+breaking changes between beta releases (and there is no beta to
+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:
 
 https://github.com/borgbackup/borg/issues/6303
@@ -180,11 +185,7 @@ see ``docs/support.rst`` in the source distribution).
 
 .. start-badges
 
-|doc| |build| |coverage| |bestpractices| |bounties|
-
-.. |bounties| image:: https://api.bountysource.com/badge/team?team_id=78284&style=bounties_posted
-        :alt: Bounty Source
-        :target: https://www.bountysource.com/teams/borgbackup
+|doc| |build| |coverage| |bestpractices|
 
 .. |doc| image:: https://readthedocs.org/projects/borgbackup/badge/?version=stable
         :alt: Documentation

borgbackup-2.0.0b9/docs/binaries/00_README.txt

@@ -0,0 +1,78 @@
+Binary BorgBackup builds
+========================
+
+The binaries are supposed to work on the specified platform without installing
+any dependencies.
+
+
+Download the correct files
+--------------------------
+
+amd64 / x86_64 architecture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+borg-linux-glibc236 Linux (built on Debian 12 "Bookworm" with glibc 2.36)
+borg-linux-glibc231 Linux (built on Debian 11 "Bullseye" with glibc 2.31)
+                    Note: you can also try them on other Linuxes with other glibc
+                    versions - as long as the glibc is compatible, they will work.
+                    If it doesn't work, try a borg 1.4.x or 1.2.x binary.
+
+borg-macos1012      macOS (built on macOS Sierra 10.12 with latest macFUSE from brew)
+                    To avoid signing issues download the file via command line OR
+                    remove the "quarantine" attribute after downloading:
+                    $ xattr -dr com.apple.quarantine borg-macos.tgz
+
+borg-freebsd14      FreeBSD (built on FreeBSD 14)
+
+*.tgz               similar to above, but built as a directory with files,
+                    not as a single self-extracting binary.
+*.asc               GnuPG signatures for *
+
+
+Verifying your download
+-----------------------
+
+Please check the GPG signature to make sure you received the binary as I have
+built it.
+
+To check the GPG signature, download both the binary and the corresponding
+*.asc file and then (on the shell) type, e.g.:
+
+    gpg --recv-keys 9F88FB52FAF7B393
+    gpg --verify borg-freebsd14.asc borg-freebsd14
+
+The files are signed by:
+
+Thomas Waldmann <tw@waldmann-edv.de>
+GPG key fingerprint: 6D5B EF9A DD20 7580 5747 B70F 9F88 FB52 FAF7 B393
+
+My fingerprint is also in the footer of all my borgbackup mailing list posts.
+
+
+Installing
+----------
+
+It is suggested that you rename or symlink the binary to just "borg".
+
+On UNIX-like platforms, /usr/local/bin/ or ~/bin/ is a nice place for it,
+but you can invoke it from every place by giving a full path to it.
+
+Make sure the file is readable and executable (chmod +rx borg on UNIX-like
+platforms).
+
+
+Reporting issues
+----------------
+If you find issues, please open a ticket on our issue tracker:
+
+https://github.com/borgbackup/borg/issues/
+
+There, please give:
+- the version number (it is displayed if you invoke borg -V)
+- the sha256sum of the binary
+- a good description of what the issue is
+- a good description of how to reproduce your issue
+- a traceback with system info (if you have one)
+- your precise platform (CPU, 32/64bit?), OS, distribution, release
+- your python and (g)libc version
+

{borgbackup-2.0.0b7 → borgbackup-2.0.0b9}/docs/borg_theme/css/borg.css

@@ -52,8 +52,7 @@ h1 {
 }
 
 .container.experimental,
-#debugging-facilities,
-#borg-recreate {
+#debugging-facilities {
     /* don't change text dimensions */
     margin: 0 -30px; /* padding below + border width */
     padding: 0 10px; /* 10 px visual margin between edge of text and the border */

{borgbackup-2.0.0b7 → borgbackup-2.0.0b9}/docs/changes.rst

@@ -120,7 +120,7 @@ Compatibility notes:
 Change Log 2.x
 ==============
 
-Version 2.0.0b7 (2023-09-14)
+Version 2.0.0b9 (2024-07-20)
 ----------------------------
 
 Please note:
@@ -132,6 +132,124 @@ above.
 
 New features:
 
+- add BORG_CACHE_IMPL, default is "adhocwithfiles" to test the new cache
+  implementation, featuring an adhoc non-persistent chunks cache and a
+  persistent files cache. See the docs for other values.
+
+  Requires to run "borg check --repair --archives-only" to delete orphaned
+  chunks before running "borg compact" to free space! These orphans are
+  expected due to the simplified refcounting with the AdHocFilesCache.
+- make BORG_EXIT_CODES="modern" the default, #8110
+- add BORG_USE_CHUNKS_ARCHIVE env var, #8280
+- automatically rebuild cache on exception, #5213
+
+Bug fixes:
+
+- fix Ctrl-C / SIGINT behaviour for pyinstaller-made binaries, #8155
+- delete: fix error handling with Ctrl-C
+- rcompress: fix error handling with Ctrl-C
+- delete: fix error handling when no archive is specified, #8256
+- setup.py: fix import error reporting for cythonize import, see #8208
+- create: deal with EBUSY, #8123
+- benchmark: inherit options --rsh --remote-path, #8099
+- benchmark: fix return value, #8113
+- key export: fix crash when no path is given, fix exception handling
+
+Other changes:
+
+- setup.py: detect noexec build fs issue, see #8208
+- improve acl_get / acl_set error handling (forward port from 1.4-maint)
+- allow msgpack 1.1.0
+- vagrant: use pyinstaller 6.7.0
+- use Python 3.11.9 for binary builds
+- require Cython 3.0.3 at least, #8133
+- docs: add non-root deployment strategy
+
+
+Version 2.0.0b8 (2024-02-20)
+----------------------------
+
+New features:
+
+- create: add the slashdot hack, update docs, #4685
+- BORG_EXIT_CODES=modern: optional more specific return codes (for errors and warnings).
+
+  The default value of this new environment variable is "legacy", which should result in
+  a behaviour similar to borg 1.2 and older (only using rc 0, 1 and 2).
+  "modern" exit codes are much more specific (see the internals/frontends docs).
+- implement "borg version" (shows client and server version), #7829
+
+Fixes:
+
+- docs: CVE-2023-36811 upgrade steps: consider checkpoint archives, #7802
+- check/compact: fix spurious reappearance of orphan chunks since borg 1.2, #6687 -
+  this consists of 2 fixes:
+
+  - for existing chunks: check --repair: recreate shadow index, #7897 #6687
+  - for newly created chunks: update shadow index when doing a double-put, #7896 #5661
+
+  If you have experienced issue #6687, you may want to run borg check --repair
+  after upgrading to borg 1.2.7 to recreate the shadow index and get rid of the
+  issue for existing chunks.
+- check: fix return code for index entry value discrepancies
+- LockRoster.modify: no KeyError if element was already gone, #7937
+- create --X-from-command: run subcommands with a clean environment, #7916
+- list --sort-by: support "archive" as alias of "name", #7873
+- fix rc and msg if arg parsing throws an exception, #7885
+- PATH: do not accept empty strings, #4221
+- fix invalid pattern argument error msg
+- zlib legacy decompress fixes, #7883
+
+Other changes:
+
+- replace archive/manifest TAMs by typed repo objects (ro_type), docs, #7670
+- crypto: use a one-step kdf for session keys, #7953
+- remove recreate --recompress option, use the more efficient repo-wide "rcompress".
+- include unistd.h in _chunker.c (fix for Python 3.13)
+- allow msgpack 1.0.7
+- allow platformdirs 4, #7950
+- use and require cython3
+- move conftest.py to src/borg/testsuite, #6386
+- use less setup.py, use pip and build
+- linux: use pkgconfig to find libacl
+- borg.logger: use same method params as python logging
+- create and use Brewfile, document "brew bundle" install (macOS)
+- blacken master branch
+- prevent CLI argument issues in scripts/glibc_check.py
+- pyproject.toml: exclude source files which have been compiled, #7828
+- sdist: dynamically compute readme (long_description)
+- init: better borg key export instructions
+- scripts/make.py: move clean, build_man, build_usage to there,
+  so we do not need to invoke setup.py directly, update docs
+- vagrant:
+
+  - use openssl 3.0 on macOS
+  - add script for fetching borg binaries from VMs, #7989
+  - use generic/openbsd7 box
+  - netbsd: test on py311 only
+  - remove debian 9 "stretch" box
+  - use freebsd 14, #6871
+  - use python 3.9.4 for tests, latest python 3.11.7 for binary builds
+  - use pyinstaller 6.3.0
+- docs:
+
+  - add typical PR workflow to development docs, #7495
+  - improve docs for borg with-lock, add example #8024
+  - create disk/partition sector backup by disk serial number
+  - Add "check.rebuild_refcounts" message
+  - not only attack/unsafe, can also be a fs issue, #7853
+  - use virtualenv on Cygwin
+  - readthedocs: also build offline docs, #7835
+  - do not refer to setup.py installation method
+  - how to run the testsuite using the dist package
+  - requirements are defined in pyproject.toml
+
+
+Version 2.0.0b7 (2023-09-14)
+----------------------------
+
+New features:
+
 - BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos
   without having the borg key, #7700
 
@@ -248,7 +366,7 @@ Other changes:
   - improve mount options rendering, #7359
   - make timestamps in manual pages reproducible.
   - describe performing pull-backups via ssh remote forwarding
-  - suggest to use forced command when using remote-fowarding via ssh
+  - suggest to use forced command when using remote-forwarding via ssh
   - fix some -a / --match-archives docs issues
   - incl./excl. options header, clarify --path-from-stdin exclusive control
   - add note about MAX_DATA_SIZE