Major documentation update.
[icculus/xz.git] / TODO
1
2 XZ Utils To-Do List
3 ===================
4
5 Known bugs
6 ----------
7
8     The test suite is too incomplete.
9
10     If the memor usage limit is less than about 13 MiB, xz is unable to
11     automatically scale down the compression settings enough even though
12     it would be  possible by switching from BT2/BT3/BT4 match finder to
13     HC3/HC4.
14
15
16 Missing features
17 ----------------
18
19     "xz --list"
20
21     xz could create sparse files when decompressing. (Some prototyping
22     has been done.)
23
24     xz doesn't support copying extended attributes, access control
25     lists etc. from source to target file.
26
27     Multithreaded compression
28
29     Multithreaded decompression
30
31     Buffer-to-buffer coding could use less RAM (especially when
32     decompressing LZMA1 or LZMA2).
33
34     I/O library is not implemented. It will possibly be named libzzf.
35
36
37 Documentation
38 -------------
39
40     Some tutorial is needed for liblzma. I have planned to write some
41     extremely well commented example programs, which would work as
42     a tutorial. I suppose the Doxygen tags are quite OK as a quick
43     reference once one is familiar with the liblzma API.
44
45     Document the LZMA1 and LZMA2 algorithms.
46