Skip to content

Commit 619dcc7

Browse files
committed
update doc;
1 parent b715db2 commit 619dcc7

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
[HDiffPatch] is a C\C++ library and command-line tools for **diff** & **patch** between binary files or directories(folder); cross-platform; fast running; create small delta/differential; support large files and limit memory requires when diff & patch.
1212

13-
[HDiffPatch] defines its own patch file format, this lib is also compatible with the [bsdiff4] patch file format and partially compatible with the [open-vcdiff] and [xdelta3] patch file format [VCDIFF(RFC 3284)].
13+
[HDiffPatch] defines its own patch file format, this lib is also compatible with the [bsdiff4] & [endsley/bsdiff] patch file format and [partially compatible](https://github.com/sisong/HDiffPatch/issues/369#issuecomment-1869798843) with the [open-vcdiff] & [xdelta3] patch file format [VCDIFF(RFC 3284)].
1414

1515
if need patch (OTA) on embedded systems,MCU,NB-IoT..., see demo [HPatchLite], +[tinyuz] decompressor can run on 1KB RAM devices!
1616

@@ -30,6 +30,7 @@ NOTE: *This library does not deal with file metadata, such as file last wirte ti
3030
[HPatchLite]: https://github.com/sisong/HPatchLite
3131
[tinyuz]: https://github.com/sisong/tinyuz
3232
[bsdiff4]: http://www.daemonology.net/bsdiff/
33+
[endsley/bsdiff]: https://github.com/mendsley/bsdiff
3334
[xdelta3]: https://github.com/jmacd/xdelta
3435
[open-vcdiff]: https://github.com/google/open-vcdiff
3536
[archive-patcher]: https://github.com/google/archive-patcher
@@ -122,7 +123,7 @@ options:
122123
stepSize>=(1024*4), DEFAULT -SD-256k, recommended 64k,2m etc...
123124
-BSD
124125
create diffFile compatible with bsdiff4, unsupport input directory(folder).
125-
support run with -SD (not used stepSize), then create single compressed
126+
also support run with -SD (not used stepSize), then create single compressed
126127
diffFile compatible with endsley/bsdiff (https://github.com/mendsley/bsdiff).
127128
-VCD[-compressLevel[-dictSize]]
128129
create diffFile compatible with VCDIFF, unsupport input directory(folder).
@@ -310,11 +311,11 @@ options:
310311
* **create_lite_diff()**
311312
* **hpatch_lite_open()**
312313
* **hpatch_lite_patch()**
313-
#### bsdiff4 & endsley/bsdiff wrapper API:
314+
#### bsdiff ([bsdiff4] & [endsley/bsdiff]) wrapper API:
314315
* **create_bsdiff()**
315316
* **create_bsdiff_stream()**
316317
* **bspatch_with_cache()**
317-
#### vcdiff wrapper API:
318+
#### vcdiff ([open-vcdiff] & [xdelta3]) wrapper API:
318319
* **create_vcdiff()**
319320
* **create_vcdiff_stream()**
320321
* **vcpatch_with_cache()**

README_cn.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
[HDiffPatch] 是一个C\C++库和命令行工具,用于在二进制文件或文件夹之间执行 **diff**(创建补丁) 和 **patch**(打补丁);跨平台、运行速度快、创建的补丁小、支持巨大的文件并且diff和patch时都可以控制内存占用量。
1212

13-
[HDiffPatch] 定义了自己的补丁包格式,同时这个库也完全兼容了 [bsdiff4] 的补丁包格式,并部分兼容 [open-vcdiff][xdelta3] 的补丁包格式 [VCDIFF(RFC 3284)]
13+
[HDiffPatch] 定义了自己的补丁包格式,同时这个库也完全兼容了 [bsdiff4] [endsley/bsdiff] 的补丁包格式,[部分兼容](https://github.com/sisong/HDiffPatch/issues/369#issuecomment-1869798843) [open-vcdiff][xdelta3] 的补丁包格式 [VCDIFF(RFC 3284)]
1414

1515
如果你需要在嵌入式系统(MCU、NB-IoT)等设备上进行增量更新(OTA), 可以看看例子 [HPatchLite], +[tinyuz] 解压缩器可以在1KB内存的设备上运行!
1616

@@ -30,6 +30,7 @@
3030
[HPatchLite]: https://github.com/sisong/HPatchLite
3131
[tinyuz]: https://github.com/sisong/tinyuz
3232
[bsdiff4]: http://www.daemonology.net/bsdiff/
33+
[endsley/bsdiff]: https://github.com/mendsley/bsdiff
3334
[xdelta3]: https://github.com/jmacd/xdelta
3435
[open-vcdiff]: https://github.com/google/open-vcdiff
3536
[archive-patcher]: https://github.com/google/archive-patcher
@@ -122,7 +123,7 @@ $ git clone https://github.com/sisong/bzip2.git ../bzip2
122123
压缩步长stepSize>=(1024*4), 默认为256k, 推荐64k,2m等。
123124
-BSD
124125
创建一个和bsdiff4兼容的补丁, 不支持参数为文件夹。
125-
支持和-SD选项一起运行(不使用其stepSize), 创建单压缩流的补丁文件
126+
也支持和-SD选项一起运行(不使用其stepSize), 从而创建单压缩流的补丁文件
126127
兼容endsley/bsdiff格式 (https://github.com/mendsley/bsdiff)。
127128
-VCD[-compressLevel[-dictSize]]
128129
创建一个标准规范VCDIFF格式的补丁, 不支持参数为文件夹。
@@ -306,11 +307,11 @@ $ git clone https://github.com/sisong/bzip2.git ../bzip2
306307
* **create_lite_diff()**
307308
* **hpatch_lite_open()**
308309
* **hpatch_lite_patch()**
309-
#### bsdiff4endsley/bsdiff 兼容包装 API:
310+
#### bsdiff ([bsdiff4] & [endsley/bsdiff]) 兼容包装 API:
310311
* **create_bsdiff()**
311312
* **create_bsdiff_stream()**
312313
* **bspatch_with_cache()**
313-
#### vcdiff 兼容包装 API:
314+
#### vcdiff ([open-vcdiff] & [xdelta3]) 兼容包装 API:
314315
* **create_vcdiff()**
315316
* **create_vcdiff_stream()**
316317
* **vcpatch_with_cache()**

hdiffz.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ static void printUsage(){
184184
#if (_IS_NEED_BSDIFF)
185185
" -BSD\n"
186186
" create diffFile compatible with bsdiff4, unsupport input directory(folder).\n"
187-
" support run with -SD (not used stepSize), then create single compressed\n"
187+
" also support run with -SD (not used stepSize), then create single compressed\n"
188188
" diffFile compatible with endsley/bsdiff (https://github.com/mendsley/bsdiff).\n"
189189
#endif
190190
#if (_IS_NEED_VCDIFF)

0 commit comments

Comments
 (0)