Skip to content

Commit

Permalink
Merge pull request borgbackup#7890 from ThomasWaldmann/doc-updates-1.2
Browse files Browse the repository at this point in the history
doc updates (1.2-maint)
  • Loading branch information
ThomasWaldmann authored Oct 27, 2023
2 parents 75bc62e + 05cec8b commit fa7a6d7
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 13 deletions.
15 changes: 8 additions & 7 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,9 @@ you run the tests.
Continuous Integration
----------------------

All pull requests go through `GitHub Actions`_, which runs the tests on Linux
and Mac OS X as well as the flake8 style checker. Windows builds run on AppVeyor_,
while additional Unix-like platforms are tested on Golem_.
All pull requests go through `GitHub Actions`_, which runs the tests on misc.
Python versions and on misc. platforms as well as some additional checks.

.. _AppVeyor: https://ci.appveyor.com/project/borgbackup/borg/
.. _Golem: https://golem.enkore.de/view/Borg/
.. _GitHub Actions: https://github.com/borgbackup/borg/actions

Output and Logging
Expand Down Expand Up @@ -336,6 +333,9 @@ Checklist:
scripts/sdist-sign X.Y.Z
scripts/upload-pypi X.Y.Z test
scripts/upload-pypi X.Y.Z

Note: the signature is not uploaded to PyPi any more, but we upload it to
github releases.
- Put binaries into dist/borg-OSNAME and sign them:

::
Expand All @@ -353,9 +353,10 @@ Checklist:

- Create a GitHub release, include:

* pypi dist package and signature
* Standalone binaries (see above for how to create them).

+ For OS X, document the OS X Fuse version in the README of the binaries.
OS X FUSE uses a kernel extension that needs to be compatible with the
+ 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``.
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ the installed ``openssl`` formula, point pkg-config to the correct path::

PKG_CONFIG_PATH="/usr/local/opt/openssl@1.1/lib/pkgconfig" pip install borgbackup[llfuse]

For OS X Catalina and later, be aware that you must authorize full disk access.
Be aware that for all recent macOS releases you must authorize full disk access.
It is no longer sufficient to run borg backups as root. If you have not yet
granted full disk access, and you run Borg backup from cron, you will see
messages such as::
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/general/file-metadata.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ On some platforms additional features are supported:
+=========================+==========+===========+============+
| Linux | Yes | Yes | Yes [1]_ |
+-------------------------+----------+-----------+------------+
| Mac OS X | Yes | Yes | Yes (all) |
| macOS | Yes | Yes | Yes (all) |
+-------------------------+----------+-----------+------------+
| FreeBSD | Yes | Yes | Yes (all) |
+-------------------------+----------+-----------+------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/general/file-systems.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ and readable after one of the failures mentioned above occurred, run
- At least three directory levels with short names
- Typically, file sizes up to a few hundred MB.
Large repositories may require large files (>2 GB).
- Up to 1000 files per directory (10000 for repositories initialized with Borg 1.0)
- Up to 1000 files per directory.
- rename(2) / MoveFile(Ex) should work as specified, i.e. on the same file system
it should be a move (not a copy) operation, and in case of a directory
it should fail if the destination exists and is not an empty directory,
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ with file 6::

That's all to do in the repository.

If you want to access this rollbacked repository from a client that already has
If you want to access this rolled back repository from a client that already has
a cache for this repository, the cache will reflect a newer repository state
than what you actually have in the repository now, after the rollback.

Expand Down
2 changes: 1 addition & 1 deletion src/borg/testsuite/platform.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ def test_utils(self):
self.assert_equal(acl_use_local_uid_gid(b'group:root:rw-:0'), b'group:0:rw-')


@unittest.skipUnless(sys.platform.startswith('darwin'), 'OS X only test')
@unittest.skipUnless(sys.platform.startswith('darwin'), 'macOS only test')
@unittest.skipIf(fakeroot_detected(), 'not compatible with fakeroot')
class PlatformDarwinTestCase(BaseTestCase):

Expand Down
2 changes: 1 addition & 1 deletion src/borg/xattr.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""A basic extended attributes (xattr) implementation for Linux, FreeBSD and MacOS X."""
"""A basic extended attributes (xattr) implementation for Linux, FreeBSD and macOS."""

import errno
import os
Expand Down

0 comments on commit fa7a6d7

Please sign in to comment.