]> granicus.if.org Git - esp-idf/commitdiff
Linked API reference of 'Application Level Tracing' with description in the 'API...
authorkrzychb <krzychb@gazeta.pl>
Tue, 7 Nov 2017 18:54:07 +0000 (19:54 +0100)
committerkrzychb <krzychb@gazeta.pl>
Tue, 7 Nov 2017 19:27:19 +0000 (20:27 +0100)
docs/api-guides/app_trace.rst
docs/api-reference/system/app_trace.rst

index ba80c16f9695d8864659d5c93bd2cdfd00e8f80a..bdc1f5d33983a3b46ca0b41d5a89488b51a0eec0 100644 (file)
@@ -9,9 +9,9 @@ IDF provides useful feature for program behaviour analysis: application level tr
 
 Developers can use this library to send application specific state of execution to the host and receive commands or other type of info in the opposite direction at runtime. The main use cases of this library are:
 
-1. Collecting application specific data. See `Application Specific Tracing`_.
-2. Lightweight logging to the host. See `Logging to Host`_.
-3. System behaviour analysis. See `System Behaviour Analysis with SEGGER SystemView`_.
+1. Collecting application specific data, see :ref:`app_trace-application-specific-tracing`
+2. Lightweight logging to the host, see :ref:`app_trace-logging-to-host`
+3. System behaviour analysis, see :ref:`app_trace-system-behaviour-analysis-with-segger-systemview`
 
 Tracing components when working over JTAG interface are shown in the figure below.
 
@@ -56,6 +56,7 @@ How to use this library
 
 This library provides API for transferring arbitrary data between host and ESP32. When enabled in menuconfig target application tracing module is initialized automatically at the system startup, so all what the user needs to do is to call corresponding API to send, receive or flush the data.
 
+.. _app_trace-application-specific-tracing:
 
 Application Specific Tracing
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -307,6 +308,7 @@ Optional arguments:
 ``--no-errors``, ``-n``
     Do not print errors
 
+.. _app_trace-system-behaviour-analysis-with-segger-systemview:
 
 System Behaviour Analysis with SEGGER SystemView
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
index 666b89aa0465bcd99a33b01954bf45d6e3cb0da9..91860fb431c5cf1e9f7b9cdbef681aadf0a707d9 100644 (file)
@@ -7,9 +7,9 @@ Overview
 IDF provides useful feature for program behaviour analysis: application level tracing. It is implemented in the corresponding library and can be enabled via menuconfig. This feature allows to transfer arbitrary data between host and ESP32 via JTAG interface with small overhead on program execution.
 Developers can use this library to send application specific state of execution to the host and receive commands or other type of info in the opposite direction at runtime. The main use cases of this library are:
 
-1. System behaviour analysis.
-2. Lightweight logging to the host.
-3. Collecting application specific data.
+1. Collecting application specific data, see :ref:`app_trace-application-specific-tracing`
+2. Lightweight logging to the host, see :ref:`app_trace-logging-to-host`
+3. System behaviour analysis, see :ref:`app_trace-system-behaviour-analysis-with-segger-systemview`
 
 API Reference
 -------------