Updated patch-coverage.pl script

[platform/core/uifw/dali-toolkit.git] / automated-tests / README.md

diff --git a/automated-tests/README.md b/automated-tests/README.md
index ebc9e4f..f256435 100644 (file)
--- a/automated-tests/README.md
+++ b/automated-tests/README.md
@@ -57,21 +57,20 @@ Testing on desktop
 Building libraries with coverage options
 ----------------------------------------
 
-Building dali core:
+Building dali toolkit:
 
     cd dali-core  # the location of your dali-core repository
     cd build/tizen
     export CC=gcc
     export CXX=g++
     git clean -fxd . # Only do this in the build folder
-    autoreconf --install
-    CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' ./configure --prefix=$DESKTOP_PREFIX --enable-debug
+    CXXFLAGS='-g -O0 --coverage' LDFLAGS='--coverage' cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_BUILD_TYPE=Debug
     make -j8 install
 
-Repeat for dali-adaptor and toolkit.
-
 Note, you __must__ use a local build and not a distributed build, and you __must__ also build with debug enabled to allow *DALI_ASSERT_DEBUG* to trigger on wrong behaviour ( Which should always be a test case failure! )
 
+Further note that, for the following, your gcov version must match the version of the compiler.
+
 Building the tests
 ------------------
 
@@ -124,16 +123,34 @@ To execute a subset of tests, you can run individual test sets, e.g.
 
     ./execute.sh dali-toolkit
 
-To get coverage output (you need to first build dali libraries with
+To get full coverage output (you need to first build dali libraries with
 --coverage), run
 
     ./coverage.sh
 
+To check the coverage of your patch, (the build server uses its own copy
+of these scripts), you can use
+
+    ./patch-coverage.pl -q [diff-spec]
+
+to get a summary, or
+
+    ./patch-coverage.pl [diff-spec]
+
+to get textual output, or
+
+    ./patch-coverage.pl -o out.html [diff-spec]
+
+to get HTML output (used by build server).
+
+diff-spec is any refspec accepted by git-diff. If it's left out, it creates
+a refspec to the latest commit, or uses the index/working tree.
+
 
 Testing on target
 =================
 
-To build for target, first build and install dali-core, dali-adaptor and dali-toolkit, then build dali-capi without --keep-packs option.
+To build for target, first build and install dali-core, dali-adaptor and dali-toolkit.
 
 You will need to install libconfig-tiny-perl:
 
@@ -195,7 +212,7 @@ If you are adding test cases to existing files, then all you need to do is creat
       END_TEST;
     }
 
-Note that **there must be no extra whitespace in the method signature** (i.e., it must violate our coding convention and follow __exactly__ this pattern: `int UtcDaliMyTestcaseName(void)`), as it's parsed by an awk script to auto-generate the testcase arrays in the main header file.
+Note that **the parentheses in the method signature must not be empty** (i.e., it must violate our coding convention and follow __exactly__ this pattern: `int UtcDaliMyTestcaseName(void)`), as it's parsed by an awk script to auto-generate the testcase arrays in the main header file. Neither may any comments on the same line contain empty parentheses.
 
 You can contine to use the TET api, e.g. `tet_infoline`, `tet_result` and our test check methods `DALI_TEST_CHECK`, `DALI_TEST_EQUALS`, etc.