diff options
author | Vidushi Vashishth <reachvidu@gmail.com> | 2018-06-14 19:47:58 +0530 |
---|---|---|
committer | Chris Johns <chrisj@rtems.org> | 2018-06-18 15:26:52 +1000 |
commit | 8f4f80d437c84ac8b4a0194a868ff83baf394462 (patch) | |
tree | 90bc5c7d49bcbd44a6e841444c9fd7dbeb02f7fa /user/tracing/index.rst | |
parent | Adding Trace Docuemntation Images (diff) | |
download | rtems-docs-8f4f80d437c84ac8b4a0194a868ff83baf394462.tar.bz2 |
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.
Diffstat (limited to '')
-rw-r--r-- | user/tracing/index.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/user/tracing/index.rst b/user/tracing/index.rst new file mode 100644 index 0000000..0d714bc --- /dev/null +++ b/user/tracing/index.rst @@ -0,0 +1,29 @@ +.. 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 |