docs: update protocol to 5.0 version

Change-Id: I25a9a6eec165e5196409d198a8f12fb702058141
Signed-off-by: Vyacheslav Cherkashin <v.cherkashin@samsung.com>

diff --git a/docs/conf.py b/docs/conf.py
index bbc19a916afea79b65ed18f92f4bea19b0573b06..b2d3915f3d1bf6c1e78b578fe6843e81cb298233 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -54,9 +54,9 @@ author = u'Anastasia Lyupa'
 # built documents.
 #
 # The short X.Y version.
-version = u'4.2'
+version = u'5.0'
 # The full version, including alpha/beta/rc tags.
-release = u'4.2'
+release = u'5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/lsan_example.log b/docs/lsan_example.log
new file mode 100644 (file)
index 0000000..0c1dc3f
--- /dev/null
+++ b/docs/lsan_example.log
@@ -0,0 +1,28 @@
+
+=================================================================
+==3298==ERROR: LeakSanitizer: detected memory leaks
+
+Direct leak of 596 byte(s) in 35 object(s) allocated from:
+    #0 0xb470d6a2 (/opt/usr/globalapps/org.example.common_lsan/bin/common_lsan+0x6a2)
+    #1 0x800c2d7d (/usr/bin/launchpad-loader+0x2d7d)
+    #2 0x800c912a (/usr/bin/launchpad-loader+0x912a)
+    #3 0x800c29ce (/usr/bin/launchpad-loader+0x29ce)
+    #4 0xb6a50187 (/lib/libc.so.6+0x18187)
+
+Direct leak of 16 byte(s) in 1 object(s) allocated from:
+    #0 0xb470d64a (/opt/usr/globalapps/org.example.common_lsan/bin/common_lsan+0x64a)
+    #1 0xb470d683 (/opt/usr/globalapps/org.example.common_lsan/bin/common_lsan+0x683)
+    #2 0x800c2d7d (/usr/bin/launchpad-loader+0x2d7d)
+    #3 0x800c912a (/usr/bin/launchpad-loader+0x912a)
+    #4 0x800c29ce (/usr/bin/launchpad-loader+0x29ce)
+    #5 0xb6a50187 (/lib/libc.so.6+0x18187)
+
+Direct leak of 15 byte(s) in 1 object(s) allocated from:
+    #0 0xb470d634 (/opt/usr/globalapps/org.example.common_lsan/bin/common_lsan+0x634)
+    #1 0xb470d683 (/opt/usr/globalapps/org.example.common_lsan/bin/common_lsan+0x683)
+    #2 0x800c2d7d (/usr/bin/launchpad-loader+0x2d7d)
+    #3 0x800c912a (/usr/bin/launchpad-loader+0x912a)
+    #4 0x800c29ce (/usr/bin/launchpad-loader+0x29ce)
+    #5 0xb6a50187 (/lib/libc.so.6+0x18187)
+
+SUMMARY: LeakSanitizer: 627 byte(s) leaked in 37 allocation(s).

diff --git a/docs/protocol.rst b/docs/protocol.rst
index 407b5086a317dde7c01987b47bd189b9c83f062b..2c232f8a40dc17879524aba7eb76d242b022ba8e 100644 (file)
--- a/docs/protocol.rst
+++ b/docs/protocol.rst
@@ -2,7 +2,7 @@
    :maxdepth: 2
    :caption: Contents:
 
-**SWAP Protocol 4.2**
+**SWAP Protocol 5.0**
 
 .. contents::
     :depth: 4
@@ -371,7 +371,7 @@ Response message
 +======================================+========+=========================+================================+========================================================+
 | MSG\_UNKNOWN\_ACK                    | 0x1000 | return ID               | no payload                     | unknown message received                               |
 +--------------------------------------+--------+-------------------------+--------------------------------+--------------------------------------------------------+
-| MSG\_VERSION\_ACK                    | 0x1001 | return ID               | version string                 | reply version, current version is "4.2"                |
+| MSG\_VERSION\_ACK                    | 0x1001 | return ID               | version string                 | reply version, current version is "5.0"                |
 +--------------------------------------+--------+-------------------------+--------------------------------+--------------------------------------------------------+
 | MSG\_START\_ACK                      | 0x1002 | return ID               | profiling start time           | time when the swap\_deamon send                        |
 |                                      |        |                         |                                | the MSG\_START\_ACK                                    |
@@ -1221,7 +1221,7 @@ MSG\_LSAN
 +==================+========+=========+==================================================================================================+
 | status           | uint32 | 0,1,2,4 | | 0x0 - LSAN\_MSG\_ERR,                                                                          |
 |                  |        |         | | 0x1 - LSAN\_MSG\_STATUS,                                                                       |
-|                  |        |         | | 0x2 - LSAN\_MSG\_REPORT,                                                                       |
+|                  |        |         | | 0x2 - LSAN\_MSG\_REPORT, see :ref:`lsan_report`                                                |
 |                  |        |         | | 0x4 - LSAN\_MSG\_DONE                                                                          |
 +------------------+--------+---------+--------------------------------------------------------------------------------------------------+
 | pid              | uint32 | pid     | process id                                                                                       |
@@ -2998,3 +2998,28 @@ properties of Win
 |                                     |        | | ELM\_WIN\_TIZEN\_WIDGET = 0x11,                                                                |
 |                                     |        | | ELM\_WIN\_FAKE = 0x12                                                                          |
 +-------------------------------------+--------+--------------------------------------------------------------------------------------------------+
+
+********
+Appendix
+********
+
+.. _lsan_report:
+
+LSan report
+===========
+
+Format
+------
+Backtrace format:
+
+``'    #%n %p %L'``
+ | ``%n`` - frame number
+ | ``%p`` - PC in hex format
+ | ``%L`` - prints location information: file/line/column, if it is known, or module+offset if it is known, or (<unknown module>) string.
+
+Memory leaks can be **Direct** or **Indirect**.
+
+Example
+-------
+.. include:: lsan_example.log
+    :literal: