diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2024-03-13 15:08:01 +0100 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2024-04-05 07:23:59 -0700 |
commit | 832975f59dd5d026f4b8f01cc9308f996f613c6d (patch) | |
tree | 6c3486233516a02bd771b25b372a6efaf88426b8 | |
parent | 8b7e9c67e3f75b9154a4b09f402ccb4a95ed5cdd (diff) | |
download | poky-832975f59dd5d026f4b8f01cc9308f996f613c6d.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: f6e69f8877d1d33200993f21b448e7fa3cf7859b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r-- | documentation/profile-manual/usage.rst | 28 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 2 |
3 files changed, 16 insertions, 16 deletions
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 912e4c9602..41a2d9ba3f 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 |
@@ -1132,37 +1132,37 @@ callgraphs from starting a few programs during those 30 seconds: | |||
1132 | Perf Documentation | 1132 | Perf Documentation |
1133 | ------------------ | 1133 | ------------------ |
1134 | 1134 | ||
1135 | Online versions of the man pages for the commands discussed in this | 1135 | Online versions of the manual pages for the commands discussed in this |
1136 | section can be found here: | 1136 | section can be found here: |
1137 | 1137 | ||
1138 | - The `'perf stat' manpage <https://linux.die.net/man/1/perf-stat>`__. | 1138 | - The `'perf stat' manual page <https://linux.die.net/man/1/perf-stat>`__. |
1139 | 1139 | ||
1140 | - The `'perf record' | 1140 | - The `'perf record' |
1141 | manpage <https://linux.die.net/man/1/perf-record>`__. | 1141 | manual page <https://linux.die.net/man/1/perf-record>`__. |
1142 | 1142 | ||
1143 | - The `'perf report' | 1143 | - The `'perf report' |
1144 | manpage <https://linux.die.net/man/1/perf-report>`__. | 1144 | manual page <https://linux.die.net/man/1/perf-report>`__. |
1145 | 1145 | ||
1146 | - The `'perf probe' manpage <https://linux.die.net/man/1/perf-probe>`__. | 1146 | - The `'perf probe' manual page <https://linux.die.net/man/1/perf-probe>`__. |
1147 | 1147 | ||
1148 | - The `'perf script' | 1148 | - The `'perf script' |
1149 | manpage <https://linux.die.net/man/1/perf-script>`__. | 1149 | manual page <https://linux.die.net/man/1/perf-script>`__. |
1150 | 1150 | ||
1151 | - Documentation on using the `'perf script' python | 1151 | - Documentation on using the `'perf script' python |
1152 | binding <https://linux.die.net/man/1/perf-script-python>`__. | 1152 | binding <https://linux.die.net/man/1/perf-script-python>`__. |
1153 | 1153 | ||
1154 | - The top-level `perf(1) manpage <https://linux.die.net/man/1/perf>`__. | 1154 | - The top-level `perf(1) manual page <https://linux.die.net/man/1/perf>`__. |
1155 | 1155 | ||
1156 | Normally, you should be able to invoke the man pages via perf itself | 1156 | Normally, you should be able to invoke the manual pages via perf itself |
1157 | e.g. ``perf help`` or ``perf help record``. | 1157 | e.g. ``perf help`` or ``perf help record``. |
1158 | 1158 | ||
1159 | To have the perf manpages installed on your target, modify your | 1159 | To have the perf manual pages installed on your target, modify your |
1160 | configuration as follows:: | 1160 | configuration as follows:: |
1161 | 1161 | ||
1162 | IMAGE_INSTALL:append = " perf perf-doc" | 1162 | IMAGE_INSTALL:append = " perf perf-doc" |
1163 | DISTRO_FEATURES:append = " api-documentation" | 1163 | DISTRO_FEATURES:append = " api-documentation" |
1164 | 1164 | ||
1165 | The man pages in text form, along with some other files, such as a set | 1165 | The manual pages in text form, along with some other files, such as a set |
1166 | of examples, can also be found in the ``perf`` directory of the kernel tree:: | 1166 | of examples, can also be found in the ``perf`` directory of the kernel tree:: |
1167 | 1167 | ||
1168 | tools/perf/Documentation | 1168 | tools/perf/Documentation |
@@ -2369,7 +2369,7 @@ first part of the filenames:: | |||
2369 | The report shows each event that was | 2369 | The report shows each event that was |
2370 | found in the blktrace data, along with a summary of the overall block | 2370 | found in the blktrace data, along with a summary of the overall block |
2371 | I/O traffic during the run. You can look at the | 2371 | I/O traffic during the run. You can look at the |
2372 | `blkparse <https://linux.die.net/man/1/blkparse>`__ manpage to learn the | 2372 | `blkparse <https://linux.die.net/man/1/blkparse>`__ manual page to learn the |
2373 | meaning of each field displayed in the trace listing. | 2373 | meaning of each field displayed in the trace listing. |
2374 | 2374 | ||
2375 | Live Mode | 2375 | Live Mode |
@@ -2566,7 +2566,7 @@ And this turns off tracing for the specified device:: | |||
2566 | blktrace Documentation | 2566 | blktrace Documentation |
2567 | ---------------------- | 2567 | ---------------------- |
2568 | 2568 | ||
2569 | Online versions of the man pages for the commands discussed in this | 2569 | Online versions of the manual pages for the commands discussed in this |
2570 | section can be found here: | 2570 | section can be found here: |
2571 | 2571 | ||
2572 | - https://linux.die.net/man/8/blktrace | 2572 | - https://linux.die.net/man/8/blktrace |
@@ -2575,7 +2575,7 @@ section can be found here: | |||
2575 | 2575 | ||
2576 | - https://linux.die.net/man/8/btrace | 2576 | - https://linux.die.net/man/8/btrace |
2577 | 2577 | ||
2578 | The above manpages, along with manuals for the other blktrace utilities | 2578 | The above manual pages, along with manuals for the other blktrace utilities |
2579 | (btt, blkiomon, etc) can be found in the ``/doc`` directory of the blktrace | 2579 | (btt, blkiomon, etc) can be found in the ``/doc`` directory of the blktrace |
2580 | tools git repo:: | 2580 | tools git repo:: |
2581 | 2581 | ||
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 05473edcca..e7bf5e9a6e 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -346,7 +346,7 @@ and BusyBox. It could have been called "kconfig" too. | |||
346 | ``compress_doc`` | 346 | ``compress_doc`` |
347 | ================ | 347 | ================ |
348 | 348 | ||
349 | Enables compression for man pages and info pages. This class is intended | 349 | Enables compression for manual and info pages. This class is intended |
350 | to be inherited globally. The default compression mechanism is gz (gzip) | 350 | to be inherited globally. The default compression mechanism is gz (gzip) |
351 | but you can select an alternative mechanism by setting the | 351 | but you can select an alternative mechanism by setting the |
352 | :term:`DOC_COMPRESS` variable. | 352 | :term:`DOC_COMPRESS` variable. |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index ccd1963339..aa1d5f393d 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -2107,7 +2107,7 @@ system and gives an overview of their function and contents. | |||
2107 | :term:`DOC_COMPRESS` | 2107 | :term:`DOC_COMPRESS` |
2108 | When inheriting the :ref:`compress_doc <ref-classes-compress_doc>` | 2108 | When inheriting the :ref:`compress_doc <ref-classes-compress_doc>` |
2109 | class, this variable sets the compression policy used when the | 2109 | class, this variable sets the compression policy used when the |
2110 | OpenEmbedded build system compresses man pages and info pages. By | 2110 | OpenEmbedded build system compresses manual and info pages. By |
2111 | default, the compression method used is gz (gzip). Other policies | 2111 | default, the compression method used is gz (gzip). Other policies |
2112 | available are xz and bz2. | 2112 | available are xz and bz2. |
2113 | 2113 | ||