diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2024-03-13 15:08:01 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-03-19 15:22:27 +0000 |
commit | 3b86df94f7a83bbeb16080b6f952c1390c06b689 (patch) | |
tree | 7e17514757931434402389d354333eeeb8390d5a /documentation/profile-manual | |
parent | 063b0cf8f99e2a438e35c4796a48cf946a5e5329 (diff) | |
download | poky-3b86df94f7a83bbeb16080b6f952c1390c06b689.tar.gz |
manuals: use "manual page(s)"
Instead of "manpage(s)" or "man page(s)".
To address one of the errors reported by "make stylecheck"
(From yocto-docs rev: 86f5f5cd385f09c48c4cf0b1ab222d6e1e7c7e54)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/profile-manual')
-rw-r--r-- | documentation/profile-manual/usage.rst | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index bd45dc2137..768349512a 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
@@ -38,7 +38,7 @@ other tools when it seems useful to do so. | |||
38 | 38 | ||
39 | The coverage below details some of the most common ways you'll likely | 39 | The coverage below details some of the most common ways you'll likely |
40 | want to apply the tool; full documentation can be found either within | 40 | want to apply the tool; full documentation can be found either within |
41 | the tool itself or in the man pages at | 41 | the tool itself or in the manual pages at |
42 | `perf(1) <https://linux.die.net/man/1/perf>`__. | 42 | `perf(1) <https://linux.die.net/man/1/perf>`__. |
43 | 43 | ||
44 | Perf Setup | 44 | Perf Setup |
@@ -1147,37 +1147,37 @@ callgraphs from starting a few programs during those 30 seconds: | |||
1147 | Perf Documentation | 1147 | Perf Documentation |
1148 | ------------------ | 1148 | ------------------ |
1149 | 1149 | ||
1150 | Online versions of the man pages for the commands discussed in this | 1150 | Online versions of the manual pages for the commands discussed in this |
1151 | section can be found here: | 1151 | section can be found here: |
1152 | 1152 | ||
1153 | - The `'perf stat' manpage <https://linux.die.net/man/1/perf-stat>`__. | 1153 | - The `'perf stat' manual page <https://linux.die.net/man/1/perf-stat>`__. |
1154 | 1154 | ||
1155 | - The `'perf record' | 1155 | - The `'perf record' |
1156 | manpage <https://linux.die.net/man/1/perf-record>`__. | 1156 | manual page <https://linux.die.net/man/1/perf-record>`__. |
1157 | 1157 | ||
1158 | - The `'perf report' | 1158 | - The `'perf report' |
1159 | manpage <https://linux.die.net/man/1/perf-report>`__. | 1159 | manual page <https://linux.die.net/man/1/perf-report>`__. |
1160 | 1160 | ||
1161 | - The `'perf probe' manpage <https://linux.die.net/man/1/perf-probe>`__. | 1161 | - The `'perf probe' manual page <https://linux.die.net/man/1/perf-probe>`__. |
1162 | 1162 | ||
1163 | - The `'perf script' | 1163 | - The `'perf script' |
1164 | manpage <https://linux.die.net/man/1/perf-script>`__. | 1164 | manual page <https://linux.die.net/man/1/perf-script>`__. |
1165 | 1165 | ||
1166 | - Documentation on using the `'perf script' Python | 1166 | - Documentation on using the `'perf script' Python |
1167 | binding <https://linux.die.net/man/1/perf-script-python>`__. | 1167 | binding <https://linux.die.net/man/1/perf-script-python>`__. |
1168 | 1168 | ||
1169 | - The top-level `perf(1) manpage <https://linux.die.net/man/1/perf>`__. | 1169 | - The top-level `perf(1) manual page <https://linux.die.net/man/1/perf>`__. |
1170 | 1170 | ||
1171 | Normally, you should be able to invoke the man pages via perf itself | 1171 | Normally, you should be able to invoke the manual pages via perf itself |
1172 | e.g. ``perf help`` or ``perf help record``. | 1172 | e.g. ``perf help`` or ``perf help record``. |
1173 | 1173 | ||
1174 | To have the perf manpages installed on your target, modify your | 1174 | To have the perf manual pages installed on your target, modify your |
1175 | configuration as follows:: | 1175 | configuration as follows:: |
1176 | 1176 | ||
1177 | IMAGE_INSTALL:append = " perf perf-doc" | 1177 | IMAGE_INSTALL:append = " perf perf-doc" |
1178 | DISTRO_FEATURES:append = " api-documentation" | 1178 | DISTRO_FEATURES:append = " api-documentation" |
1179 | 1179 | ||
1180 | The man pages in text form, along with some other files, such as a set | 1180 | The manual pages in text form, along with some other files, such as a set |
1181 | of examples, can also be found in the ``perf`` directory of the kernel tree:: | 1181 | of examples, can also be found in the ``perf`` directory of the kernel tree:: |
1182 | 1182 | ||
1183 | tools/perf/Documentation | 1183 | tools/perf/Documentation |
@@ -2391,7 +2391,7 @@ first part of the filenames:: | |||
2391 | The report shows each event that was | 2391 | The report shows each event that was |
2392 | found in the blktrace data, along with a summary of the overall block | 2392 | found in the blktrace data, along with a summary of the overall block |
2393 | I/O traffic during the run. You can look at the | 2393 | I/O traffic during the run. You can look at the |
2394 | `blkparse <https://linux.die.net/man/1/blkparse>`__ manpage to learn the | 2394 | `blkparse <https://linux.die.net/man/1/blkparse>`__ manual page to learn the |
2395 | meaning of each field displayed in the trace listing. | 2395 | meaning of each field displayed in the trace listing. |
2396 | 2396 | ||
2397 | Live Mode | 2397 | Live Mode |
@@ -2588,7 +2588,7 @@ And this turns off tracing for the specified device:: | |||
2588 | blktrace Documentation | 2588 | blktrace Documentation |
2589 | ---------------------- | 2589 | ---------------------- |
2590 | 2590 | ||
2591 | Online versions of the man pages for the commands discussed in this | 2591 | Online versions of the manual pages for the commands discussed in this |
2592 | section can be found here: | 2592 | section can be found here: |
2593 | 2593 | ||
2594 | - https://linux.die.net/man/8/blktrace | 2594 | - https://linux.die.net/man/8/blktrace |
@@ -2597,7 +2597,7 @@ section can be found here: | |||
2597 | 2597 | ||
2598 | - https://linux.die.net/man/8/btrace | 2598 | - https://linux.die.net/man/8/btrace |
2599 | 2599 | ||
2600 | The above manpages, along with manuals for the other blktrace utilities | 2600 | The above manual pages, along with manuals for the other blktrace utilities |
2601 | (btt, blkiomon, etc) can be found in the ``/doc`` directory of the blktrace | 2601 | (btt, blkiomon, etc) can be found in the ``/doc`` directory of the blktrace |
2602 | tools git repo:: | 2602 | tools git repo:: |
2603 | 2603 | ||