From 0c974aa0b12da1b158e75030eb1333dc36f71e1d Mon Sep 17 00:00:00 2001 From: shawn_he Date: Tue, 15 Mar 2022 15:49:32 +0800 Subject: [PATCH] update docs Signed-off-by: shawn_he --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bdf10d5..03b4588 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# bytrace +# ByTrace - [Introduction](#section152771918494) - [Architecture](#section6808195518497) @@ -8,10 +8,10 @@ ## Introduction -bytrace is a tool for you to trace processes and monitor performance. It encapsulates and extends the ftrace in the kernel and supports tracing in the user space. This tool provides APIs and commands: +ByTrace is a tool for you to trace processes and monitor performance. It encapsulates and extends the ftrace in the kernel and supports tracing in the user space. This tool provides APIs and commands: -1. APIs: When developing an application, you can call bytrace APIs in the application key code to perform tracing. -2. Commands: You can enable the desired label to obtain the tracing information. With bytrace, you can enable a user-space or kernel-space label you want to view (run the **bytrace -l** command to query all the supported labels) and run the corresponding commands to capture traces and dump them to a specified file. +1. APIs: When developing an application, you can call ByTrace APIs in the application key code to perform tracing. +2. Commands: You can enable the desired label to obtain the tracing information. With ByTrace, you can enable a user-space or kernel-space label you want to view (run the **bytrace -l** command to query all the supported labels) and run the corresponding commands to capture traces and dump them to a specified file. ## Architecture @@ -21,7 +21,7 @@ bytrace is a tool for you to trace processes and monitor performance. It encapsu ``` /developtools/bytrace_standard -├── bin # bytrace code +├── bin # ByTrace code │ └── include # Header files │ └── src # Source files │ └── test # Test cases @@ -33,9 +33,9 @@ bytrace is a tool for you to trace processes and monitor performance. It encapsu ## Usage -The following table lists the commands supported by bytrace. +The following table lists the commands supported by ByTrace. -** Table 1** Commands supported by bytrace +** Table 1** Commands supported by ByTrace - -

Option

@@ -56,7 +56,7 @@ The following table lists the commands supported by bytrace.

-t n, --time n

Sets the bytrace uptime in seconds, which depends on the time required for analysis.

+

Sets the ByTrace uptime in seconds, which depends on the time required for analysis.

--trace_clock clock

@@ -81,7 +81,7 @@ The following table lists the commands supported by bytrace.

-l, --list_categories

Lists the bytrace categories supported by the device.

+

Lists the ByTrace categories supported by the device.

--overwrite

@@ -102,7 +102,7 @@ The following table lists the commands supported by bytrace.
-The following are some example bytrace commands: +The following are some example ByTrace commands: - Run the following command to query supported labels: @@ -117,7 +117,7 @@ The following are some example bytrace commands: ``` -- Run the following command to capture traces whose label is ability, with the buffer size set to 4096 KB and bytrace uptime set to 10s: +- Run the following command to capture traces whose label is ability, with the buffer size set to 4096 KB and ByTrace uptime set to 10s: ``` bytrace -b 4096 -t 10 --overwrite ability > /data/mytrace.ftrace