diff options
author | KyleJHarper <KyleJHarper@gmail.com> | 2015-10-29 02:10:01 (GMT) |
---|---|---|
committer | KyleJHarper <KyleJHarper@gmail.com> | 2015-10-29 02:10:01 (GMT) |
commit | d1be164e492bcfee04e3d17d4a00bb7d0736f6bd (patch) | |
tree | 360e3521ca474a2d8cea0a572a16ff99a856a324 /examples/basics.c | |
parent | 0d25185671ddbd23d91b814cfd55dd2bc3d9e8d6 (diff) | |
download | lz4-d1be164e492bcfee04e3d17d4a00bb7d0736f6bd.zip lz4-d1be164e492bcfee04e3d17d4a00bb7d0736f6bd.tar.gz lz4-d1be164e492bcfee04e3d17d4a00bb7d0736f6bd.tar.bz2 |
Added a note about why char* is used. Also removed a binary that wasn't supposed to be in there.
Diffstat (limited to 'examples/basics.c')
-rw-r--r-- | examples/basics.c | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/examples/basics.c b/examples/basics.c index 7c26473..79cd075 100644 --- a/examples/basics.c +++ b/examples/basics.c @@ -27,6 +27,13 @@ void run_screaming(const char *message, const int code) { * main */ int main(void) { + /* Introduction */ + // Below we will have a Compression and Decompression section to demonstrate. There are a few important notes before we start: + // 1) The return codes of LZ4_ functions are important. Read lz4.h if you're unsure what a given code means. + // 2) LZ4 uses char* pointers in all LZ4_ functions. This is baked into the API and probably not going to change. If your + // program uses pointers that are unsigned char*, void*, or otherwise different you may need to do some casting or set the + // right -W compiler flags to ignore those warnings (e.g.: -Wno-pointer-sign). + /* Compression */ // We'll store some text into a variable pointed to by *src to be compressed later. const char *src = "Lorem ipsum dolor sit amet, consectetur adipiscing elit."; |