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

resolve clarify borg check --verify-data (#5808) #5860

Merged
merged 1 commit into from Jun 19, 2021
Merged

resolve clarify borg check --verify-data (#5808) #5860

merged 1 commit into from Jun 19, 2021

Conversation

ghost
Copy link

@ghost ghost commented Jun 18, 2021

This should close #5808 and count towards completion of #5129.

@codecov-commenter
Copy link

codecov-commenter commented Jun 18, 2021

Codecov Report

Merging #5860 (4f9e30e) into master (008ee01) will decrease coverage by 0.34%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5860      +/-   ##
==========================================
- Coverage   83.84%   83.50%   -0.35%     
==========================================
  Files          37       38       +1     
  Lines        9763    10353     +590     
  Branches     1621     1710      +89     
==========================================
+ Hits         8186     8645     +459     
- Misses       1104     1205     +101     
- Partials      473      503      +30     
Impacted Files Coverage Δ
src/borg/archive.py 82.93% <ø> (+0.43%) ⬆️
src/borg/archiver.py 80.60% <ø> (-0.66%) ⬇️
src/borg/cache.py 85.74% <ø> (-0.51%) ⬇️
src/borg/constants.py 100.00% <ø> (ø)
src/borg/crypto/key.py 86.59% <ø> (+0.07%) ⬆️
src/borg/crypto/keymanager.py 91.01% <ø> (-0.16%) ⬇️
src/borg/fuse_impl.py 76.92% <ø> (ø)
src/borg/helpers/checks.py 40.74% <ø> (ø)
src/borg/helpers/datastruct.py 100.00% <ø> (ø)
src/borg/helpers/errors.py 100.00% <ø> (ø)
... and 43 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 64bbe39...4f9e30e. Read the comment docs.

Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe re-read the ticket.

the repository part of the check is a very simple and low-level check. no crypto there, just some crc32 checking etc.

the crypto stuff that also needs the key is in the archives part of the check. also --verify-data happens in the archives part of the check.

if none of the --repository-only or --archives-only options are given. borg does both checks, first the lowlevel repo check, then the higher level archives check.

Comment on lines 110 to 111
- The repository check can be skipped using the ``--archives-only`` option or the
``--verify-data`` option.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not correct.

slow. This option also implies ``--archives-only``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not correct.

Comment on lines 3057 to 3058
- The repository check can be skipped using the ``--archives-only`` option.
- The repository check can be skipped using the ``--archives-only`` option or the
``--verify-data`` option.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not correct.

Comment on lines 3099 to 3100
slow.
slow. This option also implies ``--archives-only``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not correct.

@ghost
Copy link
Author

ghost commented Jun 18, 2021

Is this any better?

Comment on lines +128 to +131
- In verify-data mode, a complete cryptographic verification of the archive data
integrity is performed. This conflicts with ``--repository-only`` as this mode
only makes sense if the archive checks are enabled. The full details of this mode
are documented below.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw you do not need to update these files, that is done automatically at release time (auto-generated from archiver.py).

Comment on lines +3075 to +3078
- In verify-data mode, a complete cryptographic verification of the archive data
integrity is performed. This conflicts with ``--repository-only`` as this mode
only makes sense if the archive checks are enabled. The full details of this mode
are documented below.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, much better!

@ThomasWaldmann ThomasWaldmann merged commit 35d2587 into borgbackup:master Jun 19, 2021
@ThomasWaldmann
Copy link
Member

thanks!

@ghost ghost deleted the verify_data branch June 19, 2021 12:11
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.

docs: clarify borg check --verify-data
3 participants