|
@@ -53,7 +53,7 @@ requests (if you don't have GitHub or don't want to use it you can
|
|
|
send smaller patches via the borgbackup mailing list to the maintainers).
|
|
|
|
|
|
Stable releases are maintained on maintenance branches named ``x.y-maint``, eg.
|
|
|
-the maintenance branch of the 1.0.x series is ``1.0-maint``.
|
|
|
+the maintenance branch of the 1.4.x series is ``1.4-maint``.
|
|
|
|
|
|
Most PRs should be filed against the ``master`` branch. Only if an
|
|
|
issue affects **only** a particular maintenance branch a PR should be
|
|
@@ -167,7 +167,6 @@ will have to be installed separately. Run this command to install the pre-commit
|
|
|
|
|
|
pre-commit install
|
|
|
|
|
|
-
|
|
|
Running the tests
|
|
|
-----------------
|
|
|
|
|
@@ -175,7 +174,7 @@ The tests are in the borg/testsuite package.
|
|
|
|
|
|
To run all the tests, you need to have fakeroot installed. If you do not have
|
|
|
fakeroot, you still will be able to run most tests, just leave away the
|
|
|
-`fakeroot -u` from the given command lines.
|
|
|
+``fakeroot -u`` from the given command lines.
|
|
|
|
|
|
To run the test suite use the following command::
|
|
|
|
|
@@ -198,13 +197,13 @@ Important notes:
|
|
|
|
|
|
- When using ``--`` to give options to py.test, you MUST also give ``borg.testsuite[.module]``.
|
|
|
|
|
|
-
|
|
|
Running the tests (using the pypi package)
|
|
|
------------------------------------------
|
|
|
|
|
|
Since borg 1.4, it is also possible to run the tests without a development
|
|
|
environment, using the borgbackup dist package (downloaded from pypi.org or
|
|
|
-github releases page)::
|
|
|
+github releases page):
|
|
|
+::
|
|
|
|
|
|
# optional: create and use a virtual env:
|
|
|
python3 -m venv env
|
|
@@ -229,7 +228,6 @@ github releases page)::
|
|
|
|
|
|
pytest -rs --benchmark-skip -o 'python_files=testsuite/*.py' -o 'markers=allow_cache_wipe' --pyargs borg.testsuite
|
|
|
|
|
|
-
|
|
|
Adding a compression algorithm
|
|
|
------------------------------
|
|
|
|
|
@@ -306,7 +304,6 @@ Usage::
|
|
|
# To copy files from the VM (in this case, the generated binary):
|
|
|
vagrant scp OS:/vagrant/borg/borg.exe .
|
|
|
|
|
|
-
|
|
|
Creating standalone binaries
|
|
|
----------------------------
|
|
|
|
|
@@ -325,7 +322,6 @@ If you encounter issues, see also our `Vagrantfile` for details.
|
|
|
work on same OS, same architecture (x86 32bit, amd64 64bit)
|
|
|
without external dependencies.
|
|
|
|
|
|
-
|
|
|
.. _releasing:
|
|
|
|
|
|
Creating a new release
|
|
@@ -382,16 +378,16 @@ Checklist:
|
|
|
new version number and release date.
|
|
|
- Announce on:
|
|
|
|
|
|
- - Mailing list.
|
|
|
- - Twitter.
|
|
|
- - IRC channel (change ``/topic``).
|
|
|
+ - Mailing list.
|
|
|
+ - Mastodon / BlueSky / X (aka Twitter).
|
|
|
+ - IRC channel (change ``/topic``).
|
|
|
|
|
|
- Create a GitHub release, include:
|
|
|
|
|
|
- * pypi dist package and signature
|
|
|
- * Standalone binaries (see above for how to create them).
|
|
|
+ - pypi dist package and signature
|
|
|
+ - Standalone binaries (see above for how to create them).
|
|
|
|
|
|
- + For macOS, document the macFUSE version in the README of the binaries.
|
|
|
+ - For macOS, document the macFUSE version in the README of the binaries.
|
|
|
macFUSE uses a kernel extension that needs to be compatible with the
|
|
|
code contained in the binary.
|
|
|
- * A link to ``CHANGES.rst``.
|
|
|
+ - A link to ``CHANGES.rst``.
|