Commit Graph

46 Commits

Author SHA1 Message Date
Lasse Collin b8e12f5ab4 Typo fixes from fossies.org.
https://fossies.org/linux/misc/xz-5.2.5.tar.xz/codespell.html
2020-03-23 18:07:50 +02:00
Antoine Cœur 2fb0ddaa55 spelling 2019-05-11 20:52:37 +03:00
Alexey Tourbin 0b0e1e6803 Docs: Fix a typo in a comment in doc/examples/02_decompress.c. 2017-05-23 18:46:49 +03:00
Lasse Collin c2e29f06a7 Docs: Add doc/examples/11_file_info.c. 2017-04-24 20:20:11 +03:00
Lasse Collin 662b27c417 Update the home page URLs to HTTPS. 2017-04-19 22:17:35 +03:00
Lasse Collin cbafa71091 Docs: Use lzma_cputhreads() in 04_compress_easy_mt.c. 2014-12-21 18:58:44 +02:00
Lasse Collin 8dbb57238d Docs: Update docs/examples/00_README.txt. 2014-12-21 18:56:44 +02:00
Lasse Collin d716acdae3 Docs: Update comments to refer to lzma/lzma12.h in example programs. 2014-05-04 11:09:11 +03:00
Lasse Collin 5876ca27da Docs: Add example program for threaded encoding.
I didn't add -DLZMA_UNSTABLE to Makefile so one has to
specify it manually as long as LZMA_UNSTABLE is needed.
2014-01-29 20:19:41 +02:00
Lasse Collin b3235a0b1a Docs: Language fix to 01_compress_easy.c.
Thanks to Jonathan Nieder.
2012-06-18 21:27:47 +03:00
Lasse Collin 3a0c5378ab Docs: Add new example programs.
These have more comments than the old examples and
human-readable error messages. More tutorial-like examples
are needed but these are a start.
2012-06-14 10:52:33 +03:00
Lasse Collin 1bd2c2c553 Docs: Move xz_pipe_comp.c and xz_pipe_decomp.c to doc/examples_old.
It is good to keep these around to so that if someone has
copied the decompressor bug from xz_pipe_decomp.c he has
an example how to easily fix it.
2012-06-14 10:33:27 +03:00
Lasse Collin 905f0ab5b5 Docs: Fix a bug in xz_pipe_decomp.c example program. 2012-06-14 10:33:01 +03:00
Lasse Collin e077391982 Docs: Cleanup line wrapping a bit. 2012-05-10 21:14:16 +03:00
Benno Schulenberg fc39849c35 Fix a few typos and add some missing articles in some documents.
Also hyphenate several compound adjectives.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2012-05-10 21:04:23 +03:00
Lasse Collin 3e321a3acd Remove doubled words from documentation and comments.
Spot candidates by running these commands:
  git ls-files |xargs perl -0777 -n \
    -e 'while (/\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims)' \
    -e '{$n=($` =~ tr/\n/\n/ + 1); ($v=$&)=~s/\n/\\n/g; print "$ARGV:$n:$v\n"}'

Thanks to Jim Meyering for the original patch.
2011-04-12 11:59:49 +03:00
Lasse Collin f9722dbeca Update the FAQ. 2010-10-02 12:07:33 +03:00
Lasse Collin bab0f01ed9 Add two simple example programs.
Hopefully these help a bit when learning the basics
of liblzma API. I plan to write detailed examples about
both basic and advanced features with lots of comments,
but these two examples are good have right now.

The examples were written by Daniel Mealha Cabrita. Thanks.
2010-07-13 19:55:50 +03:00
Lasse Collin a1f7a986b8 Add a simple tip to faq.txt about tar and xz.
Thanks to Gilles Espinasse.
2010-03-31 16:47:25 +03:00
Lasse Collin eb7d51a3fa Collection of language fixes to comments and docs.
Thanks to Jonathan Nieder.
2010-02-12 13:16:15 +02:00
Lasse Collin c29e76c0f9 .xz file format specification 1.0.4 (probably).
Thanks to Christian von Roques, Peter Lawler,
and Jim Meyering for the fixes.
2009-08-27 16:12:52 +03:00
Lasse Collin 371b04e19f Removed doc/bugs.txt. 2009-08-27 10:41:01 +03:00
Lasse Collin 92e536d8b8 Fix a typo in FAQ.
Thanks to Jim Meyering.

(From now on, I try to always remember to put
the relevant thanks to commit messages.)
2009-08-27 10:21:18 +03:00
Lasse Collin b198e770a1 Updated faq.txt.
Some questions worth answering were removed, because I
currently don't have good up to date answers to them.
2009-08-18 00:26:48 +03:00
Lasse Collin 1735d31ea3 A few more spelling fixes. Released the .xz spec 1.0.3. 2009-06-05 13:46:26 +03:00
Lasse Collin 1774f27c61 Fix purporse -> purpose. Thanks to Andrew Dudman.
Released .xz spec 1.0.2 due to this fix too.
2009-06-04 22:59:55 +03:00
Lasse Collin cb61345564 The .xz file format version 1.0.1 2009-06-01 14:53:57 +03:00
Lasse Collin be06858d5c Remove docs that are too outdated to be updated
(rewrite will be better).
2009-05-01 11:28:52 +03:00
Lasse Collin 0255401e57 Added documentation about the legacy .lzma file format. 2009-05-01 11:21:46 +03:00
Lasse Collin 1496ff437c Renamed the file format specification to xz-file-format.txt
which is the filename used on the WWW.
2009-05-01 11:20:23 +03:00
Lasse Collin 4787d65443 Updated history.txt. 2009-04-13 16:36:41 +03:00
Lasse Collin 02ddf09bc3 Put the interesting parts of XZ Utils into the public domain.
Some minor documentation cleanups were made at the same time.
2009-04-13 11:27:40 +03:00
Lasse Collin 982da7ed31 The .xz file format specification version 1.0.0 is now
officially released. The format has been technically the same
since 2008-11-19, but now that it is frozen, people can start
using it without a fear that the format will break.
2009-01-28 17:16:38 +02:00
Lasse Collin bceb3918db Put the file format specification into the public domain.
Same will be done to the actual code later.
2008-12-09 17:43:31 +02:00
Lasse Collin e114502b2b Oh well, big messy commit again. Some highlights:
- Updated to the latest, probably final file format version.
  - Command line tool reworked to not use threads anymore.
    Threading will probably go into liblzma anyway.
  - Memory usage limit is now about 30 % for uncompression
    and about 90 % for compression.
  - Progress indicator with --verbose
  - Simplified --help and full --long-help
  - Upgraded to the last LGPLv2.1+ getopt_long from gnulib.
  - Some bug fixes
2008-11-19 20:46:52 +02:00
Lasse Collin c6ca26eef7 Updated file format specification. It changes the suffix
of the new format to .xz and removes the recently added
LZMA filter.
2008-09-27 19:11:02 +03:00
Lasse Collin 07efcb5a6b Changed Filter ID of LZMA to 0x20. 2008-09-07 10:23:13 +03:00
Lasse Collin bea301c26d Minor updates to the file format specification. 2008-09-03 17:06:25 +03:00
Lasse Collin bf6348d1a3 Update the file format specification draft. The new one is
a lot simpler than the previous versions, but it also means
that the existing code will change a lot.
2008-06-17 15:03:46 +03:00
Lasse Collin e55e0e873c Typo fixes from meyering. 2008-05-30 11:53:41 +03:00
Lasse Collin 11de5d5267 Bunch of grammar fixes from meyering. 2008-05-06 15:15:07 +03:00
Lasse Collin 3be21fb12f Fixed wrong spelling "limitter" to "limiter". This affects
liblzma's API.
2008-04-28 17:06:34 +03:00
Lasse Collin de74858062 Tiny clean up to file-format.txt. 2008-02-06 13:25:32 +02:00
Lasse Collin bc0b945ca3 Tiny non-technical edits to file-format.txt. 2008-01-16 16:33:37 +02:00
Lasse Collin 4e7e54c4c5 Introduced compatibility with systems that have pre-C99
or no inttypes.h. This is useful when the compiler has
good enough support for C99, but libc headers don't.

Changed liblzma API so that sys/types.h and inttypes.h
have to be #included before #including lzma.h. On systems
that don't have C99 inttypes.h, it's the problem of the
applications to provide the required types and macros
before #including lzma.h.

If lzma.h defined the missing types and macros, it could
conflict with third-party applications whose configure
has detected that the types are missing and defined them
in config.h already. An alternative would have been
introducing lzma_uint32 and similar types, but that would
just be an extra pain on modern systems.
2008-01-06 16:27:41 +02:00
Lasse Collin 5d018dc035 Imported to git. 2007-12-09 00:42:33 +02:00