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

btrfs-progs: docs: further improve space cache documentation #620

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

calestyo
Copy link
Contributor

  • For the btrfs check option of clearing, indicate that - since it's actually a full removing - a new space cache may be generated on the next mount.

  • In the summary of the clear_cache mount option, don't mention that it rebuilds the cache, as the option itself is in principle only about the clearing and the rebuilding happens "automatically" (unless other options are used).

  • In the details mention, however that there is rebuilding unless prevented by mount option.

  • Remove the "if something has gone wrong", as the mount option would also remove the cache if nothing went wrong.

- For the btrfs check option of clearing, indicate that - since it's actually a
  full removing - a new space cache may be generated on the next mount.

- In the summary of the `clear_cache` mount option, don't mention that it
  rebuilds the cache, as the option itself is in principle only about the
  clearing and the rebuilding happens "automatically" (unless other options are
  used).

- In the details mention, however that there is rebuilding unless prevented by
  mount option.

- Remove the "if something has gone wrong", as the mount option would also
  remove the cache if nothing went wrong.

Signed-off-by: Christoph Anton Mitterer <[email protected]>
@calestyo
Copy link
Contributor Author

please wait with this one... there's more to come

Strcturise the details more clearly by:
- What it does/implications.
- The different versions an their details.
- What happens if both versions are present.
- What happens with kernels that cannot use v2.
- How each version can be disabled, cleared or removed.
- Make it more clear that the default of "space cache v2" applies also if the
  option isn't given at all.

Signed-off-by: Christoph Anton Mitterer <[email protected]>
@calestyo calestyo force-pushed the further-improve-space-cache-documentation branch from e94afc8 to e8a471c Compare April 27, 2023 00:59
@calestyo
Copy link
Contributor Author

Correctly rebased on devel... but there's one question open for the 2nd commit:

When *v2* is enabled, a *v1* space cache will be cleared (at the first mount).

Is the old v1 then cleared or (as with btrfs check --clear-space-cache v2) completely removed (if the latter, the wording should be adapted).

@kdave kdave force-pushed the devel branch 3 times, most recently from af681f4 to 1628b2f Compare May 10, 2023 19:47
@kdave kdave force-pushed the devel branch 2 times, most recently from a8c6f08 to 34c5de3 Compare May 22, 2023 12:32
@kdave kdave force-pushed the devel branch 5 times, most recently from 5e02de0 to adfc8a9 Compare May 26, 2023 17:53
@kdave kdave force-pushed the devel branch 2 times, most recently from d21d383 to 77988fe Compare June 15, 2023 10:31
@kdave kdave force-pushed the devel branch 7 times, most recently from ff87660 to 89204e7 Compare August 23, 2023 17:44
@kdave kdave force-pushed the devel branch 2 times, most recently from 869b77c to 76f0670 Compare August 28, 2023 16:05
@kdave kdave force-pushed the devel branch 4 times, most recently from 247e2d2 to 208150e Compare April 19, 2024 23:44
@kdave kdave force-pushed the devel branch 2 times, most recently from 0bbf8b9 to bcb887a Compare May 3, 2024 13:01
@kdave kdave force-pushed the devel branch 2 times, most recently from 87a1129 to e4d372e Compare June 6, 2024 23:14
@kdave kdave force-pushed the devel branch 2 times, most recently from ca84db7 to 8e8c554 Compare June 27, 2024 00:22
@kdave kdave force-pushed the devel branch 3 times, most recently from c94327d to 2ce4219 Compare July 17, 2024 02:59
@kdave kdave force-pushed the devel branch 5 times, most recently from 48be42f to 082ce75 Compare August 19, 2024 22:30
@kdave kdave force-pushed the devel branch 2 times, most recently from f6d1943 to 5ff9f62 Compare September 17, 2024 15:00
@adam900710 adam900710 force-pushed the devel branch 2 times, most recently from b7cd74f to 66f08f9 Compare November 4, 2024 08:01
@kdave kdave force-pushed the devel branch 3 times, most recently from 72c9865 to 164145b Compare November 28, 2024 13:41
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.

1 participant