update sources to v12.1.1

[ceph.git] / ceph / src / isa-l / README.md

diff --git a/ceph/src/isa-l/README.md b/ceph/src/isa-l/README.md
index b084891ed4ce2ed22917cf9f75a6bd73d9e668fe..48127384fe248849ac6eda039373f86fce89bc3a 100644 (file)
--- a/ceph/src/isa-l/README.md
+++ b/ceph/src/isa-l/README.md
@@ -1,37 +1,59 @@
-=================================================
 Intel(R) Intelligent Storage Acceleration Library
 =================================================
 
 [![Build Status](https://travis-ci.org/01org/isa-l.svg?branch=master)](https://travis-ci.org/01org/isa-l)
 
-Build Prerequisites
-===================
-
-ISA-L requires yasm version 1.2.0 or later or nasm v2.11.01 or later.  Building
-with autotools requires autoconf/automake packages.
+ISA-L is a collection of optimized low-level functions targeting storage
+applications.  ISA-L includes:
+* Erasure codes - Fast block Reed-Solomon type erasure codes for any
+  encode/decode matrix in GF(2^8).
+* CRC - Fast implementations of cyclic redundancy check.  Six different
+  polynomials supported.
+  - iscsi32, ieee32, t10dif, ecma64, iso64, jones64.
+* Raid - calculate and operate on XOR and P+Q parity found in common RAID
+  implementations.
+* Compression - Fast deflate-compatible data compression.
+* De-compression - Fast inflate-compatible data compression.
+
+Also see:
+* [ISA-L for updates](https://github.com/01org/isa-l).
+* For crypto functions see [isa-l_crypto on github](https://github.com/01org/isa-l_crypto).
+* The [github wiki](https://github.com/01org/isa-l/wiki).
+* ISA-L [mailing list](https://lists.01.org/mailman/listinfo/isal).
+* [Contributing](CONTRIBUTING.md).
 
 Building ISA-L
-==============
+--------------
+
+### Prerequisites
 
-Autotools
----------
+* yasm version 1.2.0 or later or nasm v2.11.01 or later.
+* gcc, clang, icc or VC compiler.
+* GNU 'make' or 'nmake' (Windows).
+* Building with autotools requires autoconf/automake packages.
 
-To build and install the library with autotools it is usually sufficient to run
-the following:
+### Autotools
+To build and install the library with autotools it is usually sufficient to run:
 
     ./autogen.sh
     ./configure
     make
     sudo make install
 
-Other targets include: make check, make tests, make perfs, make ex (examples)
-and make other.
+### Makefile
+To use a standard makefile run:
 
-Windows
--------
+    make -f Makefile.unx
 
+### Windows
 On Windows use nmake to build dll and static lib:
 
     nmake -f Makefile.nmake
 
-Other targes include: nmake check.
+### Other make targets
+Other targets include:
+* `make check` : create and run tests
+* `make tests` : create additional unit tests
+* `make perfs` : create included performance tests
+* `make ex`    : build examples
+* `make other` : build other utilities such as compression file tests