apio/minitar
1
1
Fork 0
Code Issues Pull Requests Releases 15 Activity

docs: Clarify some sentences

Browse Source
This commit is contained in:
apio 2023-01-12 19:13:31 +01:00
parent d9b0dce41a
commit a790b6f960
Signed by: apio
GPG Key ID: B8A7D06E42258954
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -68,7 +68,7 @@ Rewinds the `struct minitar` back to the beginning of the archive file, which me
### minitar_find_by_name
`int minitar_find_by_name(struct minitar* mp, const char* name, struct minitar_entry* out)`
Stores the first entry with a matching name in `out` and returns 0, or non-zero if none are found. In this case, the state of `out` is unspecified and might have been changed by the function.
Stores the first entry with a matching name in `out` and returns 0, or non-zero if none are found. If none are found, the state of `out` is unspecified and might have been changed by the function. (In this context, a "name" means the base name of a file, so `baz.txt` given the path `foo/bar/baz.txt`)
This function starts searching from the current archive position, which means that to find a matching entry in the entire archive `minitar_rewind()` should be called on it first.