generic-library/isa-l
1
0
Fork 0
mirror of https://github.com/intel/isa-l.git synced 2024-12-12 09:23:50 +01:00
Code Issues Projects Releases Wiki Activity

doc: Updates and info on crc combine

Browse Source 
Change-Id: Ibe5d6c61e73a03e7ff1840ca0335ada3657eaf00
Signed-off-by: Greg Tucker <greg.b.tucker@intel.com>
This commit is contained in:
Greg Tucker 2023-02-10 16:32:41 -07:00
parent 4cbd285861
commit 33a2d94845
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -23,9 +23,9 @@ Also see:
* The [github wiki](https://github.com/intel/isa-l/wiki) including a list of
[distros/ports](https://github.com/intel/isa-l/wiki/Ports--Repos) offering binary packages
as well as a list of [language bindings](https://github.com/intel/isa-l/wiki/Language-Bindings).
* ISA-L [mailing list](https://lists.01.org/hyperkitty/list/isal@lists.01.org/).
* [Contributing](CONTRIBUTING.md).
* [Security Policy](SECURITY.md).
* Docs on [units](doc/functions.md), [tests](doc/test.md), or [build details](doc/build.md).
Building ISA-L
--------------
@ -38,7 +38,7 @@ Building ISA-L
x86_64:
* Assembler: nasm. Version 2.15 or later suggested (other versions of nasm and
yasm may build but with limited function [support.](doc/build.md)
yasm may build but with limited function [support](doc/build.md)).
* Compiler: gcc, clang, icc or VC compiler.
aarch64:

4
doc/functions.md
View File

@ -109,7 +109,8 @@ CRC functions have a simple interface such as in [crc example].
~~~
Updates with new buffers are possible with subsequent calls. No extra finalize
step is necessary.
step is necessary. An example of combining independent CRC values is found in
[crc combine example].
### Compress/Inflate Functions
@ -198,4 +199,5 @@ Examples:
[ec example]: https://github.com/intel/isa-l/blob/master/examples/ec/ec_simple_example.c
[raid example]: https://github.com/intel/isa-l/blob/master/raid/xor_example.c
[crc example]: https://github.com/intel/isa-l/blob/master/crc/crc64_example.c
[crc combine example]: https://github.com/intel/isa-l/blob/master/examples/crc/crc_combine_example.c
[igzip example]: https://github.com/intel/isa-l/blob/master/igzip/igzip_example.c