Doc: clarify VSICurlPartialClearCache()#11493
Merged
rouault merged 1 commit intoOSGeo:masterfrom Dec 14, 2024
Merged
Conversation
rouault
added
the
documentation
sgillies
reviewed
Dec 14, 2024
port/cpl_vsil_curl.cpp
Outdated
Comment on lines
6300
to
6302
| * VSICurlPartialClearCache("/vsis3/f") will clear all cached state for any file | ||
| * or directory starting with that prefix, so potentially "/vsis3/fu", | ||
| * "/vsis3/foo/" or "/vsis3/foo/bar". |
Contributor
There was a problem hiding this comment.
Me, I'm trying not to use foo and bar anymore.
Suggested change
| * VSICurlPartialClearCache("/vsis3/f") will clear all cached state for any file | |
| * or directory starting with that prefix, so potentially "/vsis3/fu", | |
| * "/vsis3/foo/" or "/vsis3/foo/bar". | |
| * VSICurlPartialClearCache("/vsis3/b") will clear all cached state for any file | |
| * or directory starting with that prefix, so potentially "/vsis3/bucket", | |
| * "/vsis3/basket/" or "/vsis3/basket/object". |
@rouault do I understanding correctly that /vsis3/ can't be truncated? Because that's the name of a handler and not a URL path?
Using "prefix" in the documentation is ambiguous, I think, because S3 also uses the term "prefix", but in a different sense.
Member
Author
There was a problem hiding this comment.
do I understanding correctly that
/vsis3/can't be truncated?
yes
Using "prefix" in the documentation is ambiguous
yes, any alternative suggestion? That said prefix here matches VSIGetFileSystemsPrefixes()
Member
Author
There was a problem hiding this comment.
yes, any alternative suggestion? That said prefix here matches VSIGetFileSystemsPrefixes()
changing to:
- The filename prefix must start with the name of a known virtual file system
- (such as "/vsicurl/", "/vsis3/", etc.)
rouault
force-pushed
the
doc_VSICurlPartialClearCache
branch
from
e7b5bbd to
c0c23cf
Compare
Collaborator
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
3 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.
Cf rasterio/rasterio#3276 (comment)