Update Tar_(lwt_)unix.extract documentation - #155
Merged
Conversation
The documentation said it would create [dst]. It did not. In fact, it does not attempt to create *any* directories; not even the ones listed in the archive explicitly or implicitly.
avsm
pushed a commit
to ocaml/opam-repository
that referenced
this pull request
Sep 20, 2024
CHANGES: - Fix a wrong assumption in `Tar_lwt_unix.run` for `Tar.Really_read _` that one tar block was always read. This meant that using `Tar.Really_read` with a size different from 512 would fail. (Reported by @jonahbeckford, review by @hannesm, @reynir, mirage/ocaml-tar#153) - Document better the actual behavior of `Tar_unix.extract` and `Tar_lwt_unix.extract` (@reynir, mirage/ocaml-tar#155)
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
1 participant
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.
The documentation said it would create [dst]. It did not. In fact, it does not attempt to create any directories; not even the ones listed in the archive explicitly or implicitly.
I think it should at least create the directories from the archive. #149 touched the same code (somewhat). In the meantime it's better to reflect what it actually does.