From 1f38adbce45b76edb55d37617c00b42749b65726 Mon Sep 17 00:00:00 2001 From: Naoto Yamaguchi Date: Sun, 24 Jul 2022 18:31:43 +0900 Subject: Add development information This patch add document for librefop configure options and dependency information. Bug-AGL: SPEC-4500 Signed-off-by: Naoto Yamaguchi Change-Id: I1e2813d6f8966a8f284bca84f111926239e917f3 --- DEVELOP.md | 37 +++++++++++++++++++++++++++++++++++++ README | 13 ++++++++++++- 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 DEVELOP.md diff --git a/DEVELOP.md b/DEVELOP.md new file mode 100644 index 0000000..b480d5b --- /dev/null +++ b/DEVELOP.md @@ -0,0 +1,37 @@ +# Development information + +## Test + +All test cases are included under the test/ dir. +These test code depend on gtest. + +### configure option + + --enable-test + +### Install gtest packages on host linux. + +#### Ubuntu: +libgtest-dev googletest googletest-tools + +### Run + + ./tools/run-test.sh + + +## gcov support + +This library support gcov support build. + +### configure option + + --enable-gcov + +#### Ubuntu: +lcov + +### Run + + ./tools/gen-test-report.sh + + diff --git a/README b/README index 35b4557..3fb6b47 100644 --- a/README +++ b/README @@ -4,7 +4,18 @@ Redundancy file operation library is a another implementation for the backup manager of AGL base system. It aim to tiny implementation. -File operation algorithm +Configure option : + --enable-address-sanitizer + Enable address sanitizer in build time (for debug, default is no) + + --enable-gcov + Enable gcov in build time (for debug, default is no) + + --enable-test + Enable unit test build (requir to gtest and gmock, default is no) + + +File operation algorithm : New data write - case 1.. -- cgit 1.2.3-korg