[tools] replace 'common' with 'tools' for performance

This commit is to rename the existing folder name from 'common' to 'tools'.
From now on, debugging facilities will be located in ./tools folder.

**Changes proposed in this PR:**
1. Added ./tools folder
2. Added ./tools/READMD.md
   - development, tracing, debugging, and profiling
3. Updated ./tests/README.md
4. Moved the testcase section from /README.md to ./tests/README.md file

Signed-off-by: Geunsik Lim <geunsik.lim@samsung.com>

diff --git a/README.md b/README.md
index a03bda2..7bac942 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,9 +42,6 @@ In [Component Description](Documentation/component-description.md) page, we desc
 For more details, please access the following manual.
 * Press [Here](Documentation/getting-started.md)
 
-## Test Cases
-* Press [Here](Documentation/how-to-use-testcases.md) to read how to write and run Test Cases.
-
 ## Usage Examples
 - [Example app with camera](nnstreamer_example/example_cam) (stable)
 - Wiki page [usage example screenshots](https://github.com/nnsuite/nnstreamer/wiki/usage-examples-screenshots) (stable)

diff --git a/tests/README.md b/tests/README.md
index 9294a91..e101706 100644 (file)
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,67 +1,5 @@
-# How to measure performance of testcases.
 
-This documents is for describing how to measure performance of testcase.
+## Test Cases
+* Press [Here](Documentation/how-to-use-testcases.md) to read how to write and run Test Cases.
 
-Three features will be supported.
 
-- Tracing(TBD)
-- Debugging
-- Profiling(in progress)
-
-refer: https://github.com/nnsuite/nnstreamer/issues/132
-
-## Tracing
-
-Not implemented yet.
-
-## Debugging
-
-### Pre-requirements
-
-- eog
-- gsteamer1.0-tools
-- graphviz(dot)
-
-```bash
-sudo apt install graphviz
-```
-
-- Build with cmake in nnstreamer/build folder.
-
-### How to
-
-```bash
-nnstreamer/test$ ./testAll.sh 1
-nnstreamer/test$ cd performance/debug/tensor_convertor
-$ eog ${number_of_test_case}.png
-```
-
-then, you can see elements and caps in pipeline.
-
-## Profiling
-
-### Pre-requirements
-
-- autoreconf
-- pkg-config
-- automake
-- libtool
-- gst-instruments
-
-```bash
-$ git clone https://github.com/kirushyk/gst-instruments.git
-$ cd gst-instruments
-$ ./autogen.sh
-$ make
-$ sudo make install
-```
-
-### How to
-
-```bash
-nnstreamer/test$ ./testAll.sh 1
-nnstreamer/test$ cd performance/profile/tensor_convertor
-$ eog ${number_of_test_case}.svg
-```
-
-then, you can see time and cpu usage in pipeline.

diff --git a/tools/README.md b/tools/README.md
new file mode 100644 (file)
index 0000000..e651ef5
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,95 @@
+
+
+Table of Contents
+=================
+
+* [Tools](#tools)
+  * [Development](##development)
+  * [Tracing](##tracing)
+  * [Debugging](##debugging)
+  * [Profiling](##profiling)
+
+
+# Tools
+
+This section describes how to do tracing, debugging, profiling when developers deploy NNStreamer on their own devices. 
+There are three features as following: 
+
+- Development
+- Tracing(TBD)
+- Debugging
+- Profiling(in progress)
+
+If you are interested in the tool technolog to optimize the your application using NNStremaer, Please refer to the below issue. 
+* https://github.com/nnsuite/nnstreamer/issues/132
+
+
+## Development 
+* getTestModels.sh: Get network model for evaluation
+* gst-indent: Check for existence of indent, and error out if not present
+* pre-commit: Verify what is about to be committed
+
+## Tracing
+* WIP
+
+
+## Debugging
+
+### Using $GST_DEBUG_DUMP_DOT_DIR
+* https://gstreamer.freedesktop.org/documentation/tutorials/basic/debugging-tools.html#getting-pipeline-graphs
+
+To obtain .dot files, simply set the GST_DEBUG_DUMP_DOT_DIR environment variable to point to the folder where you want the files to be placed.
+
+#### Prerequisite
+You must install the below packages to visualize the pipeline operations.
+```bash
+$ sudo apt install eog
+$ sudo apt install graphviz
+$ sudo apt install gsteamer1.0-tools
+```
+
+#### How to run
+
+First of all, try to build NNStreamer source code with cmake in nnstreamer/build folder.
+
+```bash
+nnstreamer/test$ ./testAll.sh 1
+nnstreamer/test$ cd performance/debug/tensor_convertor
+$ eog ${number_of_test_case}.png
+```
+
+then, you can see elements and caps in pipeline.
+
+## Profiling
+
+### Using $GST_DEBUG_DUMP_TRACE_DIR
+The gst-instruments tool is an easy-to-use profiler for GStreamer.
+* https://github.com/kirushyk/gst-instruments.git
+* gst-instruments displays the trace file.
+* gst-top is inspired by top and perf-top, this utility displays performance report for the particular command, analyzing GStreamer ABI calls.
+
+#### Prerequisite
+
+- autoreconf
+- pkg-config
+- automake
+- libtool
+- gst-instruments
+
+```bash
+$ git clone https://github.com/kirushyk/gst-instruments.git
+$ cd gst-instruments
+$ ./autogen.sh
+$ make
+$ sudo make install
+```
+
+#### How to run
+
+```bash
+nnstreamer/test$ ./testAll.sh 1
+nnstreamer/test$ cd performance/profile/tensor_convertor
+$ eog ${number_of_test_case}.svg
+```
+
+Then, you can see a time cost and a CPU usage in pipeline.

diff --git a/common/getTestModels.sh b/tools/getTestModels.sh
similarity index 100%
rename from common/getTestModels.sh
rename to tools/getTestModels.sh

diff --git a/common/gst-indent b/tools/gst-indent
similarity index 100%
rename from common/gst-indent
rename to tools/gst-indent

diff --git a/common/pre-commit b/tools/pre-commit
similarity index 100%
rename from common/pre-commit
rename to tools/pre-commit