rtems-docs/user/tracing/index.rst
Vidushi Vashishth 8f4f80d437 Adding Trace Documentation
- Updates #3454
- This commit adds Tracing Framework Chapter in the RTEMS User Manual
- It comprises of subchapters on RTEMS Trace Linker, Capture Engine, Trace
  generation techniques explaining trace generation using Trace Buffering and
  Printk generators and sample demonstrations.
2018-06-18 15:26:52 +10:00

30 lines
1.0 KiB
ReStructuredText

.. comment SPDX-License-Identifier: CC-BY-SA-4.0
.. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
.. comment: All rights reserved.
.. _tracing-framework:
RTEMS Tracing Framework
***********************
.. index:: Tracing Framework
RTEMS Tracing Framework is an on-target software based system which helps track
the ongoings inside the operation of applications, 3rd party packages, and the
kernel in real time.
Software based tracing is a complex process which requires components on both
the target and the host to work together. However its portability across all
architectures and board support packages makes it a useful asset. A key
requirement in RTEMS trace process is to take existing code in compiled format
(ELF) and instrument it in order to log various events and records in real time.
However instrumenting of the code for tracing should happen without rebuilding
the code from the source and without annotating the source with trace code.
.. toctree::
introduction
examples
captureengine
tracelinker