github/ocf
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add examples and build test info to Readme

Browse Source 
Signed-off-by: Robert Baldyga <robert.baldyga@intel.com>
This commit is contained in:
Robert Baldyga 2019-02-04 11:05:47 +01:00
parent ec37b2ea9e
commit 62eb5a23a7
1 changed files with 28 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,6 +1,6 @@
# Open CAS Framework # Open CAS Framework
Open CAS Framwework (OCF) is high performance block storage caching meta-library Open CAS Framework (OCF) is high performance block storage caching meta-library
written in C. It's entirely platform and system independent, accessing system API written in C. It's entirely platform and system independent, accessing system API
through user provided environment wrappers layer. OCF tightly integrates with the through user provided environment wrappers layer. OCF tightly integrates with the
rest of software stack, providing flawless, high performance, low latency caching rest of software stack, providing flawless, high performance, low latency caching
@ -11,7 +11,9 @@ utility.
* [Documentation](#documentation) * [Documentation](#documentation)
* [Source Code](#source) * [Source Code](#source)
* [Deployment](#deployment) * [Deployment](#deployment)
* [Unit Tests](#tests) * [Examples](#examples)
* [Unit Tests](#unit_tests)
* [Build Test](#build_test)
* [Contributing](#contributing) * [Contributing](#contributing)
<a id="documentation"></a> <a id="documentation"></a>
@ -54,7 +56,18 @@ make -C $OCFDIF src O=$SRCDIR CMD=cp
make -C $OCFDIF inc O=$INCDIR CMD=cp make -C $OCFDIF inc O=$INCDIR CMD=cp
~~~ ~~~
<a id="tests"></a> <a id="examples"></a>
## Examples
OCF is shipped with examples, which are complete, compillable and working
programs, containing lot of comments that explain basics of caching. They
are great starting point for everyone who wants to start working with OCF.
Examples can be found in directory `example/`.
Each example contains Makefile which can be used to compile it.
<a id="unit_tests"></a>
## Unit Tests ## Unit Tests
OCF is shipped with dedicated unit test framework based on Cmocka. OCF is shipped with dedicated unit test framework based on Cmocka.
@ -66,7 +79,18 @@ To run unit test you need to install following packages:
To run unit tests use following command: To run unit tests use following command:
~~~{.sh} ~~~{.sh}
./tests/ut-framework/run_unit_tests.py ./tests/unit/framework/run_unit_tests.py
~~~
<a id="build_test"></a>
## Build Test
OCF repository contains basic build test. It uses default POSIX environment.
To run this test, use following commands:
~~~{.sh}
cd tests/build/
make
~~~ ~~~
<a id="contributing"></a> <a id="contributing"></a>