facebook/zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor tidy

Browse Source
This commit is contained in:
Carl Woffenden 2020-05-18 12:33:44 +02:00
parent c6b03fa69c
commit 1a8767cbda
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
contrib/single_file_libs/README.md
View File

@ -12,7 +12,7 @@ This is the most common use case. The decompression library is small, adding, fo
Create `zstddeclib.c` from the Zstd source using: Create `zstddeclib.c` from the Zstd source using:
``` ```
cd zstd/contrib/single_file_libs cd zstd/contrib/single_file_libs
./combine.sh -r ../../lib -r ../../lib/common -r ../../lib/decompress -o zstddeclib.c zstddeclib-in.c ./combine.sh -r ../../lib -o zstddeclib.c zstddeclib-in.c
``` ```
Then add the resulting file to your project (see the [example files](examples)). Then add the resulting file to your project (see the [example files](examples)).
@ -21,12 +21,12 @@ Then add the resulting file to your project (see the [example files](examples)).
Full Library Full Library
------------ ------------
The same tool can amalgamate the entire Zstd library for ease of adding both compression and decompression to a project. The [roundtrip example](examples/roundtrip.c) uses the original `zstd.h` with the remaining source files combined into `zstd.c` (currently just over 1MB) created from `zstd-in.c`. As with the standalone decoder the most useful compile flags have already been rolled-in and the resulting file can be added to a project as-is. The same tool can amalgamate the entire Zstd library for ease of adding both compression and decompression to a project. The [roundtrip example](examples/roundtrip.c) uses the original `zstd.h` with the remaining source files combined into `zstd.c` (currently just over 1.2MB) created from `zstd-in.c`. As with the standalone decoder the most useful compile flags have already been rolled-in and the resulting file can be added to a project as-is.
Create `zstd.c` from the Zstd source using: Create `zstd.c` from the Zstd source using:
``` ```
cd zstd/contrib/single_file_libs cd zstd/contrib/single_file_libs
combine.sh -r ../../lib -r ../../lib/common -r ../../lib/compress -r ../../lib/decompress -k zstd.h -o zstd.c zstd-in.c ./combine.sh -r ../../lib -o zstd.c zstd-in.c
``` ```
It's possible to create a compressor-only library but since the decompressor is so small in comparison this doesn't bring much of a gain (but for the curious, simply remove the files in the _decompress_ section at the end of `zstd-in.c`). It's possible to create a compressor-only library but since the decompressor is so small in comparison this doesn't bring much of a gain (but for the curious, simply remove the files in the _decompress_ section at the end of `zstd-in.c`).

2
contrib/single_file_libs/create_single_file_library.sh
View File

@ -5,7 +5,7 @@ ZSTD_SRC_ROOT="../../lib"
# Amalgamate the sources # Amalgamate the sources
echo "Amalgamating files... this can take a while" echo "Amalgamating files... this can take a while"
./combine.sh -r "$ZSTD_SRC_ROOT" -k zstd.h -o zstd.c zstd-in.c ./combine.sh -r "$ZSTD_SRC_ROOT" -o zstd.c zstd-in.c
# Did combining work? # Did combining work?
if [ $? -ne 0 ]; then if [ $? -ne 0 ]; then
echo "Combine script: FAILED" echo "Combine script: FAILED"

2
contrib/single_file_libs/zstd-in.c
View File

@ -4,7 +4,7 @@
* *
* Generate using: * Generate using:
* \code * \code
* combine.sh -r ../../lib -k zstd.h -o zstd.c zstd-in.c * combine.sh -r ../../lib -o zstd.c zstd-in.c
* \endcode * \endcode
*/ */
/* /*