aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2009-04-26 21:04:29 +0300
committerLasse Collin <lasse.collin@tukaani.org>2009-04-26 21:04:29 +0300
commit780d6ad3df286be9c6debf5f73c5647c27ef6cea (patch)
treea8b22f71a87bd59ca1adbe2ec88ceb1cd086ab25 /README
parentd7a25a035d464aee570c4a3e3306e9deab17fe22 (diff)
downloadxz-embedded-780d6ad3df286be9c6debf5f73c5647c27ef6cea.tar.gz
Split the userspace defitions from xz_private.h into
xz_config.h, and generally clean up xz_private.h a little. Use get_unaligned_le32 and other macros provided by Linux in xz_dec_stream.c and xz_dec_bcj.c.
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 8 insertions, 3 deletions
diff --git a/README b/README
index fad17b8..38b71aa 100644
--- a/README
+++ b/README
@@ -66,6 +66,7 @@ Embedding into userspace applications
linux/lib/xz/xz_lzma2.h
linux/lib/xz/xz_private.h
linux/lib/xz/xz_stream.h
+ userspace/xz_config.h
Alternatively, xz.h may be placed into a different directory but then
that directory must be in the compiler include path when compiling
@@ -74,13 +75,17 @@ Embedding into userspace applications
Your code should use only the functions declared in xz.h. The rest of
the .h files are meant only for internal use in XZ Embedded.
+ You may want to modify xz_config.h to be more suitable for your build
+ environment. Probably you should at least skim through it even if the
+ default file works as is.
+
BCJ filter support
If you want support for one or more BCJ filters, you need to copy also
linux/lib/xz/xz_dec_bcj.c into your application, and use appropriate
- #defines when compiling XZ Embedded. You don't need these #defines in
- the code that just uses XZ Embedded via xz.h, but having them always
- #defined doesn't hurt either.
+ #defines in xz_config.h or in compiler flags. You don't need these
+ #defines in the code that just uses XZ Embedded via xz.h, but having
+ them always #defined doesn't hurt either.
#define Instruction set BCJ filter endianness
XZ_DEC_X86 x86 or x86-64 Little endian only