summaryrefslogtreecommitdiffstats
path: root/documentation/profile-manual/profile-manual-arch.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 20:17:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:00 +0000
commitfa0cb4d34b1073f215fa3c680f2316208739d53d (patch)
treeba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/profile-manual/profile-manual-arch.rst
parenta038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff)
downloadpoky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz
sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/profile-manual/profile-manual-arch.rst')
-rw-r--r--documentation/profile-manual/profile-manual-arch.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/documentation/profile-manual/profile-manual-arch.rst b/documentation/profile-manual/profile-manual-arch.rst
new file mode 100644
index 0000000000..9e1e400e42
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-arch.rst
@@ -0,0 +1,29 @@
1.. SPDX-License-Identifier: CC-BY-2.0-UK
2
3*************************************************************
4Overall Architecture of the Linux Tracing and Profiling Tools
5*************************************************************
6
7Architecture of the Tracing and Profiling Tools
8===============================================
9
10It may seem surprising to see a section covering an 'overall
11architecture' for what seems to be a random collection of tracing tools
12that together make up the Linux tracing and profiling space. The fact
13is, however, that in recent years this seemingly disparate set of tools
14has started to converge on a 'core' set of underlying mechanisms:
15
16- static tracepoints
17- dynamic tracepoints
18
19 - kprobes
20 - uprobes
21
22- the perf_events subsystem
23- debugfs
24
25.. admonition:: Tying it Together
26
27 Rather than enumerating here how each tool makes use of these common
28 mechanisms, textboxes like this will make note of the specific usages
29 in each tool as they come up in the course of the text.