Clarify '--one-file-system' for btrfs by eike-fokken · Pull Request #5391 · borgbackup/borg

eike-fokken · 2020-10-06T12:00:21Z

This addresses #4009. The documentation now explicitly mentions
btrfs subvolumes.

I'm happy to change the wording if the PR is welcome but the exact wording is not.

This addresses borgbackup#4009. The documentation now explicitly mentions btrfs subvolumes.

src/borg/archiver.py

eike-fokken · 2020-10-06T13:44:46Z

rather than adding it to the (short) help here, one could check whether it is documented how -x works (see the check in the code - iirc it is checking for the device number [not] changing) and if that is not documented, add it there.

I don't understand what you mean by "check in the code". I found the code relating to --one-file-system in archiver.py.
To my understanding it explicitely checks the device number from stat.
But is there further documentation on this?

after talking about how borg -x works, one could also point out that some filesystems trigger this change detection:

btrfs for subvolumes

(more to come?)

I think, borg create is the only command accepting --one-file-system.
So, do you mean, I should add a paragraph in the text part of the borg create page?

ThomasWaldmann · 2020-10-06T14:30:44Z

Yes, that is what I meant, add a paragraph to user docs.

Just say what it does so that it is clear how "one filesystem" is defined.

ThomasWaldmann · 2020-10-06T14:33:04Z

This PR is changing way to many files.

ThomasWaldmann · 2020-10-06T14:34:45Z

Do not run build_usage / build_man (or at least do not commit the result, so it is more clear what the PR is actually changing) - this is done at release time.

eike-fokken · 2020-10-06T15:51:04Z

Oh, sorry, I'm not familiar with github pull requests. I meant to make a different pull request, but it got mashed into this one. I will have look later on or tomorrow.

eike-fokken · 2020-10-07T14:16:53Z

I now inserted a paragraph in the prose part of the docs.

ThomasWaldmann · 2020-10-07T17:36:06Z

Looks good.

Can you get some other btrfs user from #4009 to review this also (I am unfamiliar with btrfs specifics)?

eike-fokken · 2020-10-07T22:02:38Z

I will.
What does it mean, that the codecov/project check fails?

ThomasWaldmann · 2020-10-08T10:26:12Z

@eike-fokken it means the overall test coverage could be improved. Unrelated to this PR.

The feedback from issue borgbackup#4009 is now included.

eike-fokken · 2020-10-12T07:27:36Z

I got replies from two btrfs users and included their comments, see #4009.

codecov-io · 2020-10-12T08:03:54Z

Codecov Report

Merging #5391 into master will decrease coverage by 0.20%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5391      +/-   ##
==========================================
- Coverage   83.61%   83.41%   -0.21%     
==========================================
  Files          37       37              
  Lines        9957     9957              
  Branches     1656     1656              
==========================================
- Hits         8326     8306      -20     
- Misses       1149     1162      +13     
- Partials      482      489       +7

Impacted Files	Coverage Δ
src/borg/archiver.py	`81.37% <ø> (+0.10%)`	⬆️
src/borg/platform/__init__.py	`72.00% <0.00%> (-12.00%)`	⬇️
src/borg/platform/xattr.py	`82.53% <0.00%> (-6.35%)`	⬇️
src/borg/xattr.py	`48.83% <0.00%> (-3.49%)`	⬇️
src/borg/platform/base.py	`77.58% <0.00%> (-3.45%)`	⬇️
src/borg/helpers/misc.py	`77.02% <0.00%> (-2.03%)`	⬇️
src/borg/archive.py	`82.36% <0.00%> (-0.28%)`	⬇️
src/borg/helpers/parseformat.py	`89.00% <0.00%> (-0.17%)`	⬇️

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 f18c4bf...449e07f. Read the comment docs.

codecov-commenter · 2020-10-12T08:10:21Z

Codecov Report

Merging #5391 into master will decrease coverage by 0.20%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5391      +/-   ##
==========================================
- Coverage   83.61%   83.41%   -0.21%     
==========================================
  Files          37       37              
  Lines        9957     9957              
  Branches     1656     1656              
==========================================
- Hits         8326     8306      -20     
- Misses       1149     1162      +13     
- Partials      482      489       +7

Impacted Files	Coverage Δ
src/borg/archiver.py	`81.37% <ø> (+0.10%)`	⬆️
src/borg/platform/__init__.py	`72.00% <0.00%> (-12.00%)`	⬇️
src/borg/platform/xattr.py	`82.53% <0.00%> (-6.35%)`	⬇️
src/borg/xattr.py	`48.83% <0.00%> (-3.49%)`	⬇️
src/borg/platform/base.py	`77.58% <0.00%> (-3.45%)`	⬇️
src/borg/helpers/misc.py	`77.02% <0.00%> (-2.03%)`	⬇️
src/borg/archive.py	`82.36% <0.00%> (-0.28%)`	⬇️
src/borg/helpers/parseformat.py	`89.00% <0.00%> (-0.17%)`	⬇️

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 f18c4bf...449e07f. Read the comment docs.

ThomasWaldmann · 2020-10-12T10:57:26Z

Looks good, are you finished?

eike-fokken · 2020-10-12T11:17:21Z

I am!

That was a pleasant experience, thanks for your time!

ThomasWaldmann · 2020-10-12T11:27:02Z

Thanks for working on this. Guess we better do a backport to 1.1-maint (as the 1.1.x docs are what people usually read).

eike-fokken · 2020-10-12T11:41:22Z

Seems like a good idea, my system's borg is 1.1.13 and I am on Debian testing, so rather up-to-date.

docs: clarify borg create's '--one-file-system' option, borgbackup#4009 The documentation now explicitly mentions btrfs subvolumes and explains how --one-file-system works. Co-authored-by: Eike <e.fokken+git@posteo.de>

Clarify '--one-file-system' for btrfs

4652fc0

This addresses borgbackup#4009. The documentation now explicitly mentions btrfs subvolumes.

ThomasWaldmann reviewed Oct 6, 2020

View reviewed changes

src/borg/archiver.py Outdated Show resolved Hide resolved

eike-fokken force-pushed the master branch from 624c179 to 4652fc0 Compare October 6, 2020 16:04

explained --one-file-system in detail.

260b386

ThomasWaldmann added the backport/1.1-maint label Oct 7, 2020

eike-fokken mentioned this pull request Oct 7, 2020

BTRFS subvolumes treated as external filesystems #4009

Open

Update on the docs on --one-file-system

449e07f

The feedback from issue borgbackup#4009 is now included.

ThomasWaldmann merged commit 1f0458d into borgbackup:master Oct 12, 2020

twilligon mentioned this pull request Nov 3, 2020

Clarify '--one-file-system' for btrfs (1.1 backport) #5478

Merged

ThomasWaldmann removed the backport/1.1-maint label Nov 3, 2020

ghost mentioned this pull request Aug 26, 2021

backport #5969

Closed

Uh oh!

Conversation

eike-fokken commented Oct 6, 2020

Uh oh!

Uh oh!

eike-fokken commented Oct 6, 2020

Uh oh!

ThomasWaldmann commented Oct 6, 2020

Uh oh!

ThomasWaldmann commented Oct 6, 2020

Uh oh!

ThomasWaldmann commented Oct 6, 2020

Uh oh!

eike-fokken commented Oct 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eike-fokken commented Oct 7, 2020

Uh oh!

ThomasWaldmann commented Oct 7, 2020

Uh oh!

eike-fokken commented Oct 7, 2020

Uh oh!

ThomasWaldmann commented Oct 8, 2020

Uh oh!

eike-fokken commented Oct 12, 2020

Uh oh!

codecov-io commented Oct 12, 2020

Codecov Report

Uh oh!

codecov-commenter commented Oct 12, 2020

Codecov Report

Uh oh!

ThomasWaldmann commented Oct 12, 2020

Uh oh!

eike-fokken commented Oct 12, 2020

Uh oh!

ThomasWaldmann commented Oct 12, 2020

Uh oh!

eike-fokken commented Oct 12, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

eike-fokken commented Oct 6, 2020 •

edited

Loading