From: Yann Collet <yann.collet.73@gmail.com>
Date: Thu, 28 Jan 2016 09:30:02 +0000 (+0100)
Subject: minor API update
X-Git-Tag: v0.5.0~1^2~3^2~22
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b31de73435fb114ca3ba22313321baabf160199f;p=thirdparty%2Fzstd.git

minor API update
---

diff --git a/dictBuilder/dibcli.c b/dictBuilder/dibcli.c
index 50369c220..ce4a7ac73 100644
--- a/dictBuilder/dibcli.c
+++ b/dictBuilder/dibcli.c
@@ -247,8 +247,8 @@ int main(int argCount, const char** argv)
     if (filenameIdx==0) return badusage(programName);
 
     /* building ... */
-    DiB_setDisplayLevel(displayLevel);
-    operationResult = DiB_trainFiles(dictFileName, maxDictSize, filenameTable, filenameIdx, selectionLevel);
+    DiB_setNotificationLevel(displayLevel);
+    operationResult = DiB_trainDictionary(dictFileName, maxDictSize, selectionLevel, filenameTable, filenameIdx);
 
     if (main_pause) waitEnter();
     free((void*)filenameTable);
diff --git a/dictBuilder/dictBuilder.c b/dictBuilder/dictBuilder.c
index ed41d7c51..fa14ed2ca 100644
--- a/dictBuilder/dictBuilder.c
+++ b/dictBuilder/dictBuilder.c
@@ -98,8 +98,8 @@ static const size_t maxMemory = (sizeof(size_t)==4)  ?  (2 GB - 64 MB) : (size_t
 ***************************************/
 #define DISPLAY(...)         fprintf(stderr, __VA_ARGS__)
 #define DISPLAYLEVEL(l, ...) if (g_displayLevel>=l) { DISPLAY(__VA_ARGS__); }
-static unsigned g_displayLevel = 2;   /* 0 : no display;   1: errors;   2: default;  4: full information */
-void DiB_setDisplayLevel(unsigned l) { g_displayLevel=l; }
+static unsigned g_displayLevel = 0;   /* 0 : no display;   1: errors;   2: default;  4: full information */
+void DiB_setNotificationLevel(unsigned l) { g_displayLevel=l; }
 
 #define DISPLAYUPDATE(l, ...) if (g_displayLevel>=l) { \
             if (DiB_GetMilliSpan(g_time) > refreshRate)  \
@@ -833,9 +833,8 @@ static void DiB_saveDict(const char* dictFileName,
 }
 
 
-int DiB_trainFiles(const char* dictFileName, unsigned maxDictSize,
-                   const char** fileNamesTable, unsigned nbFiles,
-                   unsigned shiftRatio)
+int DiB_trainDictionary(const char* dictFileName, unsigned maxDictSize, unsigned shiftRatio,
+                   const char** fileNamesTable, unsigned nbFiles)
 {
     void* srcBuffer;
     size_t benchedSize;
diff --git a/dictBuilder/dictBuilder.h b/dictBuilder/dictBuilder.h
index 76efed293..74fa2b0c0 100644
--- a/dictBuilder/dictBuilder.h
+++ b/dictBuilder/dictBuilder.h
@@ -23,7 +23,10 @@
     - ztsd public forum : https://groups.google.com/forum/#!forum/lz4c
 */
 
-/* *************************************
+/* This library is designed for a single-threaded console application.
+*  It abruptly exits (exit() function) when it encounters an error condition. */
+
+/*-*************************************
 *  Version
 ***************************************/
 #define DiB_VERSION_MAJOR    0    /* for breaking interface changes  */
@@ -33,12 +36,21 @@
 unsigned DiB_versionNumber (void);
 
 
-/* *************************************
+/*-*************************************
 *  Main functions
 ***************************************/
-int DiB_trainFiles(const char* dictFileName, unsigned maxDictSize,
-                   const char** fileNamesTable, unsigned nbFiles,
-                   unsigned selectionLevel);
+/*! DiB_trainDictionary
+    Train a dictionary from a set of files provided by @fileNamesTable
+    Resulting dictionary is written in file @dictFileName
+    @result : 0 if fine
+*/
+int DiB_trainDictionary(const char* dictFileName, unsigned maxDictSize, unsigned selectivityLevel,
+                        const char** fileNamesTable, unsigned nbFiles);
 
 
-void DiB_setDisplayLevel(unsigned l);
+/*! DiB_setNotificationLevel
+    Set amount of notification to be displayed on the console.
+    0 = no console notification (default).
+    Note : not thread-safe (use a global constant)
+*/
+void DiB_setNotificationLevel(unsigned l);