From 9cee2f9558fe35150cee165b957fce0efac97d9e Mon Sep 17 00:00:00 2001 From: krzychb Date: Tue, 7 Nov 2017 19:54:07 +0100 Subject: [PATCH] Linked API reference of 'Application Level Tracing' with description in the 'API Guides' --- docs/api-guides/app_trace.rst | 8 +++++--- docs/api-reference/system/app_trace.rst | 6 +++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/api-guides/app_trace.rst b/docs/api-guides/app_trace.rst index ba80c16f96..bdc1f5d339 100644 --- a/docs/api-guides/app_trace.rst +++ b/docs/api-guides/app_trace.rst @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/api-reference/system/app_trace.rst b/docs/api-reference/system/app_trace.rst index 666b89aa04..91860fb431 100644 --- a/docs/api-reference/system/app_trace.rst +++ b/docs/api-reference/system/app_trace.rst @@ -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 ------------- -- 2.40.0