diff options
author | David Oberhollenzer <david.oberhollenzer@sigma-star.at> | 2019-06-30 23:05:48 +0200 |
---|---|---|
committer | David Oberhollenzer <david.oberhollenzer@sigma-star.at> | 2019-06-30 23:05:48 +0200 |
commit | 5a63f1d60442fc116d87e2a4d8183a681746f96b (patch) | |
tree | 2b20dffeb3782216af9a1229c2d217eac600868a | |
parent | cebdcd35f09527548635c6f80a7c0ed8c7a79cf1 (diff) |
Update documentation
Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
-rw-r--r-- | README | 17 | ||||
-rw-r--r-- | doc/tar2sqfs.1 | 23 |
2 files changed, 18 insertions, 22 deletions
@@ -50,22 +50,17 @@ together with the existing tools: At the moment, the following things still require some work: - - more testing + - more testing (extensive unit testing for libsqfs still needed) - extended attributes - - currently limited to SELinux labeling only - - rdsquashfs ignores them entirely - - SquashFS supports deduplicating values through "out of line" - storage but this is currently not used yet. - - hard links (not implemented yet; do we even want this?) + - gensquashfs supports SELinux labeling only + - rdsquashfs, sqfs2tar and tar2sqfs ignore them entirely + - entire key value blocks are deduplicated, but individual value + deduplication ("out of line" storage) isn't implemented. + - hard links (not implemented; tar2sqfs turns them into symlinks) - File deduplication (not implemented; do we even need this?) - NFS export tables (not implemented yet) -At the moment, tar2sqfs also has some limitations on what it can process: - - only POSIX tar archives with pax extensions (use --posix for GNU tar) - - no sparse files or hard links (converted to symlink) - - Future plans ************ diff --git a/doc/tar2sqfs.1 b/doc/tar2sqfs.1 index 61c6b47..c43e412 100644 --- a/doc/tar2sqfs.1 +++ b/doc/tar2sqfs.1 @@ -62,18 +62,19 @@ Print help text and exit. .TP \fB\-\-version\fR, \fB\-V\fR Print version information and exit. -.SH LIMITATIONS -Currently the tool can only process POSIX tar archives with pax extensions, so -you need to tell your tool that generates the tar ball to not use any other -extensions. +.SH COMPATIBILITY +The tool is designed to support a broad variety of commonly used tar archives. +Currently the tool can process v7 format, pre-POSIX ustar, POSIX tar and GNU +tar archives. PAX extension headers are supported. -For GNU tar, this can be done with the flag \fB\-\-posix\fR: -.IP -tar cf file.tar \-\-posix bin/ lib/ etc/ usr/ -.TP -Furthermore, hard links and sparse files are currently not supported. If any -unsupported section is encountered in a tar archive, the section is skipped and -a warning message is written to stderr. +The support for GNU tar is limited to commonly used header formats (i.e. some +older, legacy headers are not supported) and extensions like sparse files. + +Hard links are currently not supported and silently converted to symlinks. +Furthermore, none of the various xattr extensions are currently implemented. + +If any unsupported section is encountered in an archive, the section is skipped +and a warning message is written to stderr. .SH EXAMPLES .TP Turn an uncompressed tar archive into a squashfs image: |