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

docs: Make it clearer that "minitar" and "minitar_w" are handle structs

Browse Source
This commit is contained in:
apio 2023-02-04 19:39:12 +01:00
parent 9c43461e02
commit 9b39f43595
Signed by: apio
GPG Key ID: B8A7D06E42258954
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/API.md
View File

@ -6,12 +6,12 @@ Functions/types suffixed with `_w` or that contain `write` in their names are pa
### minitar_open ### minitar_open
`int minitar_open(const char* pathname, struct minitar* mp)` `int minitar_open(const char* pathname, struct minitar* mp)`
Initializes the caller-provided `mp` structure by opening the archive pointed to by `pathname` for reading. Returns 0 on success, anything else is failure. Initializes the caller-provided `mp` [handle](API.md#minitar) by opening the archive pointed to by `pathname` for reading. Returns 0 on success, anything else is failure.
### minitar_open_w ### minitar_open_w
`int minitar_open_w(const char* pathname, struct minitar_w* mp, enum minitar_write_mode mode)` `int minitar_open_w(const char* pathname, struct minitar_w* mp, enum minitar_write_mode mode)`
Initializes the caller-provided `mp` structure by opening the archive pointed to by `pathname` for writing (in case `pathname` already exists, mode selects if the existing file is overwritten or if new entries are appended to it). Returns 0 on success, anything else is failure. Initializes the caller-provided `mp` [handle](API.md#minitar_w) by opening the archive pointed to by `pathname` for writing (in case `pathname` already exists, mode selects if the existing file is overwritten or if new entries are appended to it). Returns 0 on success, anything else is failure.
### minitar_read_entry ### minitar_read_entry
`int minitar_read_entry(struct minitar* mp, struct minitar_entry* out)` `int minitar_read_entry(struct minitar* mp, struct minitar_entry* out)`