docs: core/config/fs - Add explanation for fs wrappers #1395
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slusarz
requested changes
Jan 7, 2026
| | [[link,fs_compress,compress]] | File compression. | | ||
| <!-- @include: @docs/storage/providers/includes/fs-wrapper.inc --> | ||
|
|
||
| To wrap a fs driver into one of the wrapper it is to be listed after the |
Contributor
There was a problem hiding this comment.
A bit wordy, maybe "To wrap a fs driver, it should be listed after the wrapper in the configuration."
| wrapper in the configuration. | ||
| So to wrap [[link,fs_posix,posix]] with the [[link,fs_metawrap,metawrap]] to | ||
| support storing metadata with `fs posix` it should be added before the | ||
| `fs posix {}` block. The same applies to all other wrapping fs drivers |
Contributor
There was a problem hiding this comment.
I would remove "The same applies..." sentence. This is just an example, people are smart enough to understand this applies to any fs drivers.
|
|
||
| To wrap a fs driver into one of the wrapper it is to be listed after the | ||
| wrapper in the configuration. | ||
| So to wrap [[link,fs_posix,posix]] with the [[link,fs_metawrap,metawrap]] to |
Contributor
There was a problem hiding this comment.
Prefix this sentence with "For example" (or put it in a separate sub-header), to make clear this is an example.
| } | ||
| ``` | ||
|
|
||
| It is also possible to use multiple fs wrappers on top of each other. |
Contributor
There was a problem hiding this comment.
What does this mean? This probably needs an example as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DOV-7737