Skip to content

Commit 14ae277

Browse files
committed
Extract new tools/README.md from top-level README.md
No content change (yet) Signed-off-by: Marc Herbert <marc.herbert@intel.com>
1 parent 82b4831 commit 14ae277

2 files changed

Lines changed: 48 additions & 48 deletions

File tree

README.md

Lines changed: 1 addition & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -105,54 +105,7 @@ apl
105105

106106
## Tools list description
107107

108-
* sof-boot-once.sh
109-
<br> This script writes to rc.local, which is loaded and read after reboot.
110-
<br> After rc.local command is run, the command will be removed.
111-
<br> example: sof-boot-once.sh reboot
112-
<br> Effect: when system boots up it will auto reboot again
113-
114-
* sof-combinatoric.py
115-
<br> Used to compute permutations or combinations of the various pipelines
116-
avilable during tests if multiple are needed at once.
117-
118-
* sof-disk-usage.sh
119-
<br> Used to ensure we have enough disk space to collect logs and avoid system
120-
problems.
121-
122-
* sof-dump-status.py
123-
<br> Dump the sound card status
124-
125-
* sof-get-default-tplg.sh
126-
<br> Load the tplg file name from system log which is recorded from system bootup
127-
128-
* sof-get-kernel-line.sh
129-
<br> Print all kernel versions and their line numbers from /var/log/kern.log,
130-
with the most recent <first/last>
131-
132-
* sof-kernel-dump.sh
133-
<br> Catch all kernel information after system boot up from /var/log/kern.log file
134-
135-
* sof-kernel-log-check.sh
136-
<br> Check dmesg for errors and ensure that any found are real errors
137-
138-
* sof-process-kill.sh
139-
<br> Kills aplay or arecord processes
140-
141-
* sof-process-state.sh
142-
<br> Shows the current state of a given process
143-
144-
* sof-tplgreader.py
145-
<br> tplgtool.py wrapper, it reads info from tplgtool.py to analyze topologies.
146-
147-
* tplgtool2.py
148-
<br> Dumps info from tplg binary file.
149-
SOF CI uses this to generate a topology graph.
150-
151-
* tplgtool.py
152-
<br> Dumps info from tplg binary file. sof-tplgreader.py still use this but new features
153-
will go to tplgtool2.py. When all functions are migrated to tplgtool2.py
154-
it will be deprecated.
155-
108+
See tools/README.md
156109

157110
## System configuration tips
158111

tools/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
* sof-boot-once.sh
2+
<br> This script writes to rc.local, which is loaded and read after reboot.
3+
<br> After rc.local command is run, the command will be removed.
4+
<br> example: sof-boot-once.sh reboot
5+
<br> Effect: when system boots up it will auto reboot again
6+
7+
* sof-combinatoric.py
8+
<br> Used to compute permutations or combinations of the various pipelines
9+
avilable during tests if multiple are needed at once.
10+
11+
* sof-disk-usage.sh
12+
<br> Used to ensure we have enough disk space to collect logs and avoid system
13+
problems.
14+
15+
* sof-dump-status.py
16+
<br> Dump the sound card status
17+
18+
* sof-get-default-tplg.sh
19+
<br> Load the tplg file name from system log which is recorded from system bootup
20+
21+
* sof-get-kernel-line.sh
22+
<br> Print all kernel versions and their line numbers from /var/log/kern.log,
23+
with the most recent <first/last>
24+
25+
* sof-kernel-dump.sh
26+
<br> Catch all kernel information after system boot up from /var/log/kern.log file
27+
28+
* sof-kernel-log-check.sh
29+
<br> Check dmesg for errors and ensure that any found are real errors
30+
31+
* sof-process-kill.sh
32+
<br> Kills aplay or arecord processes
33+
34+
* sof-process-state.sh
35+
<br> Shows the current state of a given process
36+
37+
* sof-tplgreader.py
38+
<br> tplgtool.py wrapper, it reads info from tplgtool.py to analyze topologies.
39+
40+
* tplgtool2.py
41+
<br> Dumps info from tplg binary file.
42+
SOF CI uses this to generate a topology graph.
43+
44+
* tplgtool.py
45+
<br> Dumps info from tplg binary file. sof-tplgreader.py still use this but new features
46+
will go to tplgtool2.py. When all functions are migrated to tplgtool2.py
47+
it will be deprecated.

0 commit comments

Comments
 (0)