--- libaitsync/inc/aitsync.h 2012/11/13 10:00:30 1.3.2.1 +++ libaitsync/inc/aitsync.h 2012/11/13 13:38:14 1.3.2.3 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitsync.h,v 1.3.2.1 2012/11/13 10:00:30 misho Exp $ +* $Id: aitsync.h,v 1.3.2.3 2012/11/13 13:38:14 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -55,7 +55,7 @@ inline const char *sync_GetError(); /* * syncSignature() - Calculate and create signature for diff * - * @csInput = Input file name for calculating check sums + * @csInput = Input target file name for calculating check sums * @csSig = Output Signature file name * @compress = 2 compress signatures output, 0 not compressed * return: -1 error, 0 ok @@ -66,7 +66,7 @@ int syncSignature(const char *csInput, const char *csS * syncDelta() - Create Delta patch file * * @csInput = Input original source file name for make delta patch file - * @csSig = Input Signature file name + * @csSig = Input target Signature file name * @csDelta = Output Delta patch file name * @compress = 3 everything compress, 2 compressed signatures, 1 compress delta output, 0 not compressed * return: -1 error, 0 ok, create delta patch, 1 ok, no differences and not create patch @@ -88,25 +88,28 @@ int syncPatch(const char *csInput, const char *csDelta struct tagDirName; /* - * sync_dircmp() Compare directories + * sync_dircmp() - Compare directories + * * @csDir1 = Directory 1 * @csDir2 = Directory 2 * return: -1 error, 0 is equal or 1 different */ int sync_dircmp(const char *csDir1, const char *csDir2); /* - * sync_dirCSum() Calculate checksum of directory + * sync_dirChkSum() - Calculate checksum of directory + * * @csDir = Directory - * @md = Message digest allocated memory, must be free after use! + * @md = Message digest allocated memory, must be free() after use! * return: -1 error or !=-1 ok */ -int sync_dirCSum(const char *csDir, u_char **md); +int sync_dirChkSum(const char *csDir, u_char **md); /* - * sync_dircmpList() Compare directories or directory and file list + * sync_dircmpList() - Compare directories or directory and file list + * * @csDir1 = Directory 1 * @csDir2 = Directory 2 or File list, if "-" get input from console - * @lm = Long mode options, 1 long output - * @list = Output diff list, after use must be free! + * @lm = Long mode options, !=NULL long output + * @list = Output diff list, after use must be free()! * return: -1 error, 0 is equal or >0 count of returned list items */ int sync_dircmpList(const char *csDir1, const char *csDir2, int lm, struct tagDirName **list);