Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue 8550: Documentation update: ::REPO references replacement #8680

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

vancheese
Copy link

REPO::ARCHIVE formatting has been replaced in the documentation with --repo

All modified commands have been tested

Andy Cheesman and others added 20 commits February 13, 2025 03:33
It needs to be possible to iterate over all items in an archive,
do some output (e.g. if an item is included / excluded) and then
only preload content data chunks for the included items.
…#8575)

borg extract --dry-run now displays +/- flags (included/excluded) left to the path.
the python package pkgconfig does not need to be "preinstalled"
anymore, because our pyproject.toml cares for that. otoh, the cli tool
pkg-config must be preinstalled so that libs and headers can be found
automagically.

Also be a bit more clear about the FUSE stuff.
if retry is True, it will just retry to get a valid answer.
if retry is False, it will return the default.

the code can be tested by entering "error" (without the quotes).
/Users/tw/w/borg/docs/internals/data-structures.rst:971:
WARNING: Lexing literal_block
'
[cache]
version = 1
repository = 3c4...e59
manifest = 10e...21c
timestamp = 2017-06-01T21:31:39.699514
key_type = 2
previous_location = /path/to/repo

[integrity]
manifest = 10e...21c
files = {"algorithm": "XXH64", "digests": {"HashHeader": "eab...39e3", "final": "e2a...b24"}}
'
as "ini" resulted in an error at token: '}'.
Retrying in relaxed mode. [misc.highlighting_failure]

Note: this part of the docs didn't change for a long time, so I guess
the sudden warning comes from a change in sphinx' lexers.

Main problem is that rc != 0 will abort our CI pipeline.
Improve handling when defining a passphrase or debugging passphrase issues, fixes borgbackup#8496

Setting `BORG_DEBUG_PASSPHRASE=YES` enables passphrase debug logging to stderr, showing passphrase, hex utf-8 byte sequence and related env vars if a wrong passphrase was encountered.

Setting `BORG_DISPLAY_PASSHRASE=YES` now always shows passphrase and its hex utf-8 byte sequence.
allow timespan to be specified with common time units, fixes borgbackup#8624

Co-authored-by: Ken Kundert <[email protected]>
…al characters within a shell (borgbackup#8628)

docs: within a shell, cli options with special characters may require quoting, borgbackup#8578
…dows domain? (borgbackup#8636)

FAQ: Why backups are slow on a Linux server that is a member of a windows domain?
fixes borgbackup#8639
The priority of 40 for the udev rules as stated in to documentation
applies the rule too early on some systems, which prevents the rule from
matching. This commit changes the priority to 80.
…her than overwrite

fixes borgbackup#8641
In the example, setting SYSTEMD_WANTS instead of appending may prevent
other autostart services attached by earlier udev rules from launching.
This commit changes = to += to fix this behavior.
@ThomasWaldmann
Copy link
Member

Please check the commits in this PR, something has gone wrong here.

Also give the PR a meaningfull title.

@vancheese vancheese changed the title Fix issue 8550 issue 8550: Documentation update: ::REPO references replacement Mar 1, 2025
@vancheese
Copy link
Author

@ThomasWaldmann - I've updated the title - what are the issues with the commits?

@ThomasWaldmann
Copy link
Member

ThomasWaldmann commented Mar 1, 2025

Most of the commits are unrelated commits of other contributors.

https://github.com/borgbackup/borg/pull/8680/commits

Maybe rebase your commits onto master rather than merging master into your branch.

@ThomasWaldmann
Copy link
Member

ThomasWaldmann commented Mar 1, 2025

Another issue is that you changed auto-generated files:

  • man pages (*.1)
  • some *.rst.inc (see comment in 1st line)

These should never be edited and also not be updated within a PR.

The way to change their contents is to change the place in the source where they are generated from, usually a file in src/borg/archiver/*.py. When I do a release, I will then re-generate the files "auto-generated" from there.

@vancheese
Copy link
Author

Gotcha, Overzealous corrections and sorry about the merge. I'll tidy everything up in a single new branch... Should I close cancel this request and submit a new one (when everything is done)

@ThomasWaldmann
Copy link
Member

Yes, maybe make a new PR.

You could keep this branch / this PR as a backup until you have the new branch / PR ready.

@vancheese
Copy link
Author

New PR here -> #8681
Sorry for being PITA as I get up to speed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants