aboutsummaryrefslogtreecommitdiff
path: root/debug/README
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2008-01-18 20:18:08 +0200
committerLasse Collin <lasse.collin@tukaani.org>2008-01-18 20:18:08 +0200
commit61dc82f3e306b25ce3cd3d529df9ec7a0ec04b73 (patch)
treecdc13dd318a6a3f34771a4acfc4f15cc5f6fdab5 /debug/README
parentAdded test files to test usage of flush marker in LZMA. (diff)
downloadxz-61dc82f3e306b25ce3cd3d529df9ec7a0ec04b73.tar.xz
Added the debug directory and the first debug tool
(sync_flush). These tools are not built unless the user runs "make" in the debug directory.
Diffstat (limited to '')
-rw-r--r--debug/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/debug/README b/debug/README
new file mode 100644
index 00000000..749610d7
--- /dev/null
+++ b/debug/README
@@ -0,0 +1,17 @@
+
+Debug tools
+-----------
+
+ This directory contains a few tiny programs that may be helpful when
+ debugging LZMA Utils.
+
+ These tools are not meant to be installed. Often one needs to edit
+ the source code a little to make the programs do the wanted things.
+ If you don't know how these programs could help you, it is likely
+ that they really are useless to you.
+
+ These aren't intended to be used as example programs. They take some
+ shortcuts here and there, which correct programs should not do. Many
+ possible errors (especially I/O errors) are ignored. Don't report
+ bugs or send patches to fix this kind of bugs.
+