revi-archive/xz-archive
1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00
Code Activity

Docs: Cleanup line wrapping a bit.

Browse source
This commit is contained in:
Lasse Collin 2012-05-10 21:14:16 +03:00
parent fc39849c35
commit e077391982
2 changed files with 31 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README
View file

@ -109,8 +109,8 @@ XZ Utils
written yet. written yet.
For now, if you have never used liblzma, libbzip2, or zlib, I For now, if you have never used liblzma, libbzip2, or zlib, I
recommend learning the *basics* of the zlib API. Once you know that, it recommend learning the *basics* of the zlib API. Once you know that,
should be easier to learn liblzma. it should be easier to learn liblzma.
http://zlib.net/manual.html http://zlib.net/manual.html
http://zlib.net/zlib_how.html http://zlib.net/zlib_how.html
@ -124,10 +124,10 @@ XZ Utils
- X is the major version. When this is incremented, the library - X is the major version. When this is incremented, the library
API and ABI break. API and ABI break.
- Y is the minor version. It is incremented when new features are - Y is the minor version. It is incremented when new features
added without breaking the existing API or ABI. An even Y indicates are added without breaking the existing API or ABI. An even Y
a stable release and an odd Y indicates unstable (alpha or beta indicates a stable release and an odd Y indicates unstable
version). (alpha or beta version).
- Z is the revision. This has a different meaning for stable and - Z is the revision. This has a different meaning for stable and
unstable releases: unstable releases:

49
doc/history.txt
View file

@ -4,12 +4,12 @@ History of LZMA Utils and XZ Utils
Tukaani distribution Tukaani distribution
In 2005, there was a small group working on the Tukaani distribution, which In 2005, there was a small group working on the Tukaani distribution,
was a Slackware fork. One of the project's goals was to fit the distro on which was a Slackware fork. One of the project's goals was to fit the
a single 700 MiB ISO-9660 image. Using LZMA instead of gzip helped a distro on a single 700 MiB ISO-9660 image. Using LZMA instead of gzip
lot. Roughly speaking, one could fit data that took 1000 MiB in gzipped helped a lot. Roughly speaking, one could fit data that took 1000 MiB
form into 700 MiB with LZMA. Naturally, the compression ratio varied across in gzipped form into 700 MiB with LZMA. Naturally, the compression
packages, but this was what we got on average. ratio varied across packages, but this was what we got on average.
Slackware packages have traditionally had .tgz as the filename suffix, Slackware packages have traditionally had .tgz as the filename suffix,
which is an abbreviation of .tar.gz. A logical naming for LZMA which is an abbreviation of .tar.gz. A logical naming for LZMA
@ -50,9 +50,9 @@ Second generation
LZMA Utils 4.32.0beta1 introduced a new lzma command-line tool written LZMA Utils 4.32.0beta1 introduced a new lzma command-line tool written
by Ville Koskinen. It was written in C++, and used the encoder and by Ville Koskinen. It was written in C++, and used the encoder and
decoder from C++ LZMA SDK with some little modifications. This tool replaced decoder from C++ LZMA SDK with some little modifications. This tool
both the lzmash script and the LZMA_Alone command-line tool in LZMA replaced both the lzmash script and the LZMA_Alone command-line tool
Utils. in LZMA Utils.
Introducing this new tool caused some temporary incompatibilities, Introducing this new tool caused some temporary incompatibilities,
because the LZMA_Alone executable was simply named lzma like the new because the LZMA_Alone executable was simply named lzma like the new
@ -60,21 +60,22 @@ Second generation
interface. The file format was still the same. interface. The file format was still the same.
Lasse wrote liblzmadec, which was a small decoder-only library based Lasse wrote liblzmadec, which was a small decoder-only library based
on the C code found from LZMA SDK. liblzmadec had an API similar to zlib, on the C code found from LZMA SDK. liblzmadec had an API similar to
although there were some significant differences, which made it zlib, although there were some significant differences, which made it
non-trivial to use it in some applications designed for zlib and non-trivial to use it in some applications designed for zlib and
libbzip2. libbzip2.
The lzmadec command-line tool was converted to use liblzmadec. The lzmadec command-line tool was converted to use liblzmadec.
Alexandre Sauvé helped converting the build system to use GNU Autotools. Alexandre Sauvé helped converting the build system to use GNU
This made it easier to test for certain less portable features needed Autotools. This made it easier to test for certain less portable
by the new command-line tool. features needed by the new command-line tool.
Since the new command-line tool never got completely finished (for Since the new command-line tool never got completely finished (for
example, it didn't support the LZMA_OPT environment variable), the intent example, it didn't support the LZMA_OPT environment variable), the
was to not call 4.32.x stable. Similarly, liblzmadec wasn't polished, intent was to not call 4.32.x stable. Similarly, liblzmadec wasn't
but appeared to work well enough, so some people started using it too. polished, but appeared to work well enough, so some people started
using it too.
Because the development of the third generation of LZMA Utils was Because the development of the third generation of LZMA Utils was
delayed considerably (3-4 years), the 4.32.x branch had to be kept delayed considerably (3-4 years), the 4.32.x branch had to be kept
@ -87,8 +88,8 @@ File format problems
The file format used by LZMA_Alone was primitive. It was designed with The file format used by LZMA_Alone was primitive. It was designed with
embedded systems in mind, and thus provided only a minimal set of embedded systems in mind, and thus provided only a minimal set of
features. The two biggest problems for non-embedded use were the lack of features. The two biggest problems for non-embedded use were the lack
magic bytes and an integrity check. of magic bytes and an integrity check.
Igor and Lasse started developing a new file format with some help Igor and Lasse started developing a new file format with some help
from Ville Koskinen. Also Mark Adler, Mikko Pouru, H. Peter Anvin, from Ville Koskinen. Also Mark Adler, Mikko Pouru, H. Peter Anvin,
@ -125,13 +126,13 @@ Transition to XZ Utils
The early versions of XZ Utils were called LZMA Utils. The first The early versions of XZ Utils were called LZMA Utils. The first
releases were 4.42.0alphas. They dropped the rest of the C++ LZMA SDK. releases were 4.42.0alphas. They dropped the rest of the C++ LZMA SDK.
The code was still directly based on LZMA SDK but ported to C and The code was still directly based on LZMA SDK but ported to C and
converted from a callback API to a stateful API. Later, Igor Pavlov made converted from a callback API to a stateful API. Later, Igor Pavlov
a C version of the LZMA encoder too; these ports from C++ to C were made a C version of the LZMA encoder too; these ports from C++ to C
independent in LZMA SDK and LZMA Utils. were independent in LZMA SDK and LZMA Utils.
The core of the new LZMA Utils was liblzma, a compression library with The core of the new LZMA Utils was liblzma, a compression library with
a zlib-like API. liblzma supported both the old and new file format. The a zlib-like API. liblzma supported both the old and new file format.
gzip-like lzma command-line tool was rewritten to use liblzma. The gzip-like lzma command-line tool was rewritten to use liblzma.
The new LZMA Utils code base was renamed to XZ Utils when the name The new LZMA Utils code base was renamed to XZ Utils when the name
of the new file format had been decided. The liblzma compression of the new file format had been decided. The liblzma compression