Fix spacing and Edit Makefile (now run with make instead of make run)

diff --git a/contrib/randomDictBuilder/Makefile b/contrib/randomDictBuilder/Makefile
index 443f6f047d6651e0fdaf045773cbb0a6df5cff4c..77dd29337b3a1419e19ddaedc64809e8946c5d1d 100644 (file)
--- a/contrib/randomDictBuilder/Makefile
+++ b/contrib/randomDictBuilder/Makefile
@@ -4,16 +4,15 @@ TEST_INPUT := ../../lib
 TEST_OUTPUT := randomDict
 ARG :=
 
-all: main testrun test clean
+all: main run clean
 
-run: main rand clean
+test: main testrun testshell clean
 
-.PHONY: rand
-rand:
+.PHONY: run
+run:
        echo "Building a random dictionary with given arguments"
        ./main $(ARG)
 
-
 main: main.o random.o libzstd.a
        gcc main.o random.o libzstd.a -o main
 
@@ -34,8 +33,8 @@ testrun: main
        zstd -be3 -D $(TEST_OUTPUT) -r $(TEST_INPUT) -q
        rm -f $(TEST_OUTPUT)
 
-.PHONY: test
-test: test.sh
+.PHONY: testshell
+testshell: test.sh
        sh test.sh
        echo "Finish running test.sh"
 

diff --git a/contrib/randomDictBuilder/README.md b/contrib/randomDictBuilder/README.md
index 09f1e808852d4bc9e2c641bcd4d6b33f925de39f..0e70d3dccc7aa5777572f17d60512b0cad5996e4 100644 (file)
--- a/contrib/randomDictBuilder/README.md
+++ b/contrib/randomDictBuilder/README.md
@@ -7,11 +7,14 @@ Dictionary ID (dictID=#): nonnegative number; if not provided, default to 0
 Maximum Dictionary Size (maxdict=#): positive number; in bytes, if not provided, default to 110KB
 Size of Randomly Selected Segment (k=#): positive number; in bytes; if not provided, default to 200
 
+###Running Test:
+make test
+
 
 ###Usage:
-To build a random dictionary with the provided arguments: make run ARG= followed by arguments
+To build a random dictionary with the provided arguments: make ARG= followed by arguments
 
 
 ### Examples:
-make run ARG="in=../../lib/dictBuilder out=dict100 dictID=520"
-make run ARG="in=../../lib/dictBuilder in=../../lib/compress"
+make ARG="in=../../lib/dictBuilder out=dict100 dictID=520"
+make ARG="in=../../lib/dictBuilder in=../../lib/compress"

diff --git a/contrib/randomDictBuilder/main.c b/contrib/randomDictBuilder/main.c
index d9295aa9a00b0cfc7753202093adea4feaedc6e3..e195188befc789bf5c5bb1b08dac538821f1c496 100644 (file)
--- a/contrib/randomDictBuilder/main.c
+++ b/contrib/randomDictBuilder/main.c
@@ -52,7 +52,8 @@ static const unsigned g_defaultMaxDictSize = 110 KB;
 #define SAMPLESIZE_MAX (128 KB)
 #define RANDOM_MAX_SAMPLES_SIZE (sizeof(size_t) == 8 ? ((U32)-1) : ((U32)1 GB))
 #define RANDOM_MEMMULT 9
-static const size_t g_maxMemory = (sizeof(size_t) == 4) ? (2 GB - 64 MB) : ((size_t)(512 MB) << sizeof(size_t));
+static const size_t g_maxMemory = (sizeof(size_t) == 4) ?
+                          (2 GB - 64 MB) : ((size_t)(512 MB) << sizeof(size_t));
 
 #define NOISELENGTH 32
 
@@ -76,8 +77,7 @@ typedef struct {
 /*-*************************************
 *  Commandline related functions
 ***************************************/
-static unsigned readU32FromChar(const char** stringPtr)
-{
+static unsigned readU32FromChar(const char** stringPtr){
     const char errorMsg[] = "error: numeric value too large";
     unsigned result = 0;
     while ((**stringPtr >='0') && (**stringPtr <='9')) {
@@ -105,8 +105,7 @@ static unsigned readU32FromChar(const char** stringPtr)
  *  If yes, @return 1 and advances *stringPtr to the position which immediately follows longCommand.
  * @return 0 and doesn't modify *stringPtr otherwise.
  */
-static unsigned longCommandWArg(const char** stringPtr, const char* longCommand)
-{
+static unsigned longCommandWArg(const char** stringPtr, const char* longCommand){
     size_t const comSize = strlen(longCommand);
     int const result = !strncmp(*stringPtr, longCommand, comSize);
     if (result) *stringPtr += comSize;
@@ -125,11 +124,9 @@ static unsigned longCommandWArg(const char** stringPtr, const char* longCommand)
  * *bufferSizePtr is modified, it provides the amount data loaded within buffer.
  *  sampleSizes is filled with the size of each sample.
  */
-static unsigned loadFiles(void* buffer, size_t* bufferSizePtr,
-                              size_t* sampleSizes, unsigned sstSize,
-                              const char** fileNamesTable, unsigned nbFiles, size_t targetChunkSize,
-                              unsigned displayLevel)
-{
+static unsigned loadFiles(void* buffer, size_t* bufferSizePtr, size_t* sampleSizes,
+                          unsigned sstSize, const char** fileNamesTable, unsigned nbFiles,
+                          size_t targetChunkSize, unsigned displayLevel) {
     char* const buff = (char*)buffer;
     size_t pos = 0;
     unsigned nbLoadedChunks = 0, fileIndex;
@@ -200,8 +197,7 @@ static void shuffle(const char** fileNamesTable, unsigned nbFiles) {
 /*-********************************************************
 *  Dictionary training functions
 **********************************************************/
-static size_t findMaxMem(unsigned long long requiredMem)
-{
+static size_t findMaxMem(unsigned long long requiredMem) {
     size_t const step = 8 MB;
     void* testmem = NULL;
 
@@ -219,8 +215,7 @@ static size_t findMaxMem(unsigned long long requiredMem)
 }
 
 static void saveDict(const char* dictFileName,
-                         const void* buff, size_t buffSize)
-{
+                         const void* buff, size_t buffSize) {
     FILE* const f = fopen(dictFileName, "wb");
     if (f==NULL) EXM_THROW(3, "cannot open %s ", dictFileName);
 
@@ -236,8 +231,8 @@ static void saveDict(const char* dictFileName,
  *  provides the amount of data to be loaded and the resulting nb of samples.
  *  This is useful primarily for allocation purpose => sample buffer, and sample sizes table.
  */
-static fileStats getFileStats(const char** fileNamesTable, unsigned nbFiles, size_t chunkSize, unsigned displayLevel)
-{
+static fileStats getFileStats(const char** fileNamesTable, unsigned nbFiles,
+                              size_t chunkSize, unsigned displayLevel) {
     fileStats fs;
     unsigned n;
     memset(&fs, 0, sizeof(fs));
@@ -255,8 +250,9 @@ static fileStats getFileStats(const char** fileNamesTable, unsigned nbFiles, siz
     return fs;
 }
 
-int RANDOM_trainFromFiles(const char* dictFileName, sampleInfo *info, unsigned maxDictSize,
-                       ZDICT_random_params_t *params){
+int RANDOM_trainFromFiles(const char* dictFileName, sampleInfo *info,
+                          unsigned maxDictSize,
+                          ZDICT_random_params_t *params) {
     unsigned const displayLevel = params->zParams.notificationLevel;
     void* const dictBuffer = malloc(maxDictSize);
 
@@ -285,8 +281,8 @@ int RANDOM_trainFromFiles(const char* dictFileName, sampleInfo *info, unsigned m
     return result;
 }
 
-sampleInfo* getSampleInfo(const char** fileNamesTable,
-                  unsigned nbFiles, size_t chunkSize, unsigned maxDictSize, const unsigned displayLevel){
+sampleInfo* getSampleInfo(const char** fileNamesTable, unsigned nbFiles, size_t chunkSize,
+                          unsigned maxDictSize, const unsigned displayLevel) {
     fileStats const fs = getFileStats(fileNamesTable, nbFiles, chunkSize, displayLevel);
     size_t* const sampleSizes = (size_t*)malloc(fs.nbSamples * sizeof(size_t));
     size_t const memMult = RANDOM_MEMMULT;
@@ -320,7 +316,8 @@ sampleInfo* getSampleInfo(const char** fileNamesTable,
     /* Load input buffer */
     DISPLAYLEVEL(3, "Shuffling input files\n");
     shuffle(fileNamesTable, nbFiles);
-    nbFiles = loadFiles(srcBuffer, &loadedSize, sampleSizes, fs.nbSamples, fileNamesTable, nbFiles, chunkSize, displayLevel);
+    nbFiles = loadFiles(srcBuffer, &loadedSize, sampleSizes, fs.nbSamples,
+                        fileNamesTable, nbFiles, chunkSize, displayLevel);
 
     sampleInfo *info = (sampleInfo *)malloc(sizeof(sampleInfo));
 
@@ -376,7 +373,8 @@ int main(int argCount, const char* argv[])
   unsigned fileNamesNb = filenameIdx;
   int followLinks = 0;
   const char** extendedFileList = NULL;
-  extendedFileList = UTIL_createFileList(filenameTable, filenameIdx, &fileNamesBuf, &fileNamesNb, followLinks);
+  extendedFileList = UTIL_createFileList(filenameTable, filenameIdx, &fileNamesBuf,
+                                        &fileNamesNb, followLinks);
   if (extendedFileList) {
       unsigned u;
       for (u=0; u<fileNamesNb; u++) DISPLAYLEVEL(4, "%u %s\n", u, extendedFileList[u]);

diff --git a/contrib/randomDictBuilder/random.c b/contrib/randomDictBuilder/random.c
index 96c02389f1515b80bb27e80df51f435d3d0ab6df..cfed14a4adc3fff8394b04e9ebff1e19f3a861e7 100644 (file)
--- a/contrib/randomDictBuilder/random.c
+++ b/contrib/randomDictBuilder/random.c
@@ -71,7 +71,8 @@ static RANDOM_segment_t RANDOM_selectSegment(const size_t totalSamplesSize,
  * Check the validity of the parameters.
  * Returns non-zero if the parameters are valid and 0 otherwise.
  */
-static int RANDOM_checkParameters(ZDICT_random_params_t parameters, size_t maxDictSize) {
+static int RANDOM_checkParameters(ZDICT_random_params_t parameters,
+                                  size_t maxDictSize) {
     /* k is a required parameter */
     if (parameters.k == 0) {
       return 0;
@@ -115,7 +116,8 @@ static size_t RANDOM_buildDictionary(const size_t totalSamplesSize, const BYTE *
 /*! ZDICT_trainFromBuffer_random():
  *  Train a dictionary from an array of samples using the RANDOM algorithm.
  *  Samples must be stored concatenated in a single flat buffer `samplesBuffer`,
- *  supplied with an array of sizes `samplesSizes`, providing the size of each sample, in order.
+ *  supplied with an array of sizes `samplesSizes`, providing the size of each
+ *  sample, in order.
  *  The resulting dictionary will be saved into `dictBuffer`.
  * @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)
  *          or an error code, which can be tested with ZDICT_isError().
@@ -145,7 +147,8 @@ ZDICTLIB_API size_t ZDICT_trainFromBuffer_random(
 
       DISPLAYLEVEL(2, "Building dictionary\n");
       {
-        const size_t tail = RANDOM_buildDictionary(totalSamplesSize, samples, dictBuffer, dictBufferCapacity, parameters);
+        const size_t tail = RANDOM_buildDictionary(totalSamplesSize, samples,
+                                  dictBuffer, dictBufferCapacity, parameters);
         const size_t dictSize = ZDICT_finalizeDictionary(
             dict, dictBufferCapacity, dict + tail, dictBufferCapacity - tail,
             samplesBuffer, samplesSizes, nbSamples, parameters.zParams);

diff --git a/contrib/randomDictBuilder/random.h b/contrib/randomDictBuilder/random.h
index 77529dafbf64db6ad2b052a9adf570d8ec20d261..b6696323a8c393f7fd4e9adc3cccdedb5d2e0f6e 100644 (file)
--- a/contrib/randomDictBuilder/random.h
+++ b/contrib/randomDictBuilder/random.h
@@ -18,13 +18,12 @@ typedef struct {
 
 
 typedef struct {
-    unsigned k;                  /* Segment size : constraint: 0 < k : Reasonable range [16, 2048+]; Default to 200 */
+    unsigned k; /* Segment size : constraint: 0 < k : Reasonable range [16, 2048+]; Default to 200 */
     ZDICT_params_t zParams;
 } ZDICT_random_params_t;
 
 
 
-ZDICTLIB_API size_t ZDICT_trainFromBuffer_random(
-    void *dictBuffer, size_t dictBufferCapacity,
+ZDICTLIB_API size_t ZDICT_trainFromBuffer_random( void *dictBuffer, size_t dictBufferCapacity,
     const void *samplesBuffer, const size_t *samplesSizes, unsigned nbSamples,
     ZDICT_random_params_t parameters);