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

docs: Add APi documentation for MTAR_CHRDEV and MTAR_BLKDEV

Browse Source 
Missed that in the previous commits.
This commit is contained in:
apio 2023-01-29 22:14:05 +01:00
parent e96f7127bf
commit 45fbd789d6
Signed by: apio
GPG Key ID: B8A7D06E42258954
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt
View File

@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.8..3.22) cmake_minimum_required(VERSION 3.8..3.22)
project(minitar LANGUAGES C VERSION 1.6.0) project(minitar LANGUAGES C VERSION 1.6.1)
option(MINITAR_IGNORE_UNSUPPORTED_TYPES "Skip past entries that have unsupported types instead of panicking (deprecated)" OFF) option(MINITAR_IGNORE_UNSUPPORTED_TYPES "Skip past entries that have unsupported types instead of panicking (deprecated)" OFF)

8
docs/API.md
View File

@ -81,6 +81,10 @@ This enum lists all supported file types:
`MTAR_FIFO`: FIFO special files `MTAR_FIFO`: FIFO special files
`MTAR_BLKDEV`: Block devices
`MTAR_CHRDEV`: Character devices
Other file types supported in tar archives, such as block/character devices or FIFOs, are not supported and minitar will throw an error when encountering one of them. This behavior can be controlled by passing `-DMINITAR_IGNORE_UNSUPPORTED_TYPES=ON` to CMake when configuring, which will make minitar silently ignore such entries instead of panicking. Other file types supported in tar archives, such as block/character devices or FIFOs, are not supported and minitar will throw an error when encountering one of them. This behavior can be controlled by passing `-DMINITAR_IGNORE_UNSUPPORTED_TYPES=ON` to CMake when configuring, which will make minitar silently ignore such entries instead of panicking.
### minitar_entry_metadata ### minitar_entry_metadata
@ -110,6 +114,10 @@ This structure represents an entry's metadata, with the following fields:
`gname`: A string representing the group name of the entry's owner. (`char[]`) `gname`: A string representing the group name of the entry's owner. (`char[]`)
`devmajor`: An integer representing the major number of a device. (`unsigned int`)
`devminor`: An integer representing the minor number of a device. (`unsigned int`)
### minitar_entry ### minitar_entry
`struct minitar_entry` `struct minitar_entry`