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

docs: Update docs/API.md with a proper link to the error handling section

Browse Source
This commit is contained in:
apio 2023-02-04 19:35:17 +01:00
parent f09e6f2e85
commit 53aa377bbb
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
docs/API.md
View File

@ -44,7 +44,7 @@ Writes a special file entry (anything that does not have contents, so directorie
This function only writes a header (generated from the metadata). The `size` field is written as 0, no matter what its original value was.
This function does not write entries for regular files (metadata.type == `MTAR_REGULAR`). Trying to do so will result in minitar panicking (see [error handling](README.md#error-handling)). To write regular files, use `minitar_write_file_entry`.
This function does not write entries for regular files (metadata.type == `MTAR_REGULAR`). Trying to do so will result in minitar panicking (see [error handling](../README.md#error-handling)). To write regular files, use `minitar_write_file_entry`.
This function returns 0 on success.