feat(docs): add documentation for the posixfs scan command - #1084
Open
pbleser-oc wants to merge 3 commits into
Open
feat(docs): add documentation for the posixfs scan command#1084pbleser-oc wants to merge 3 commits into
pbleser-oc wants to merge 3 commits into
Conversation
* since the posixfs scan command has been augmented with an optional parameter with opencloud-eu/opencloud#3182, this change adds configuration for that command in the first place, which was missing altogether * addresses but does not close opencloud-eu#1070 since the `posixfs consistency` command is not documented by this change
…orting multiple resources as arguments
v-scharf
reviewed
Aug 7, 2026
v-scharf
left a comment
v-scharf
left a comment
Contributor
There was a problem hiding this comment.
I tested and added tests for that opencloud-eu/opencloud#3263
Looks good - a couple of nitpicks
|
|
||
| Optionally, one might want to specify resources to scan, using optional arguments that specify paths. | ||
|
|
||
| When that path is a directory, it will recurse and perform a storage scan for all the files contained within that directory and all its subdirectories. |
Contributor
There was a problem hiding this comment.
should we also mention about scanning space?
like: Scanning can also be performed for an individual space by specifying its storage path.
|
|
||
| Administrators can trigger the storage scanning manually. This might be useful during migrations, or when [collaborative mode](../configuration/storage/posixfs.md#posixfs-collaborative-mode) is disabled. | ||
|
|
||
| It is recommended practice in such situations, since files that have not been scanned |
Contributor
There was a problem hiding this comment.
This sentence feels incomplete.
maybe like:
It is recommended to scan files in such situations because unscanned files:
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
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.
since the posixfs scan command has been augmented with an optional parameter with Implement subtree scanning in "posixfs scan" opencloud#3182, this change adds configuration for that command in the first place, which was missing altogether
addresses but does not close documentation of posixfs command #1070 since the
posixfs consistencycommand is not documented by this change