summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-03-13 15:08:01 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-03-19 15:22:27 +0000
commit3b86df94f7a83bbeb16080b6f952c1390c06b689 (patch)
tree7e17514757931434402389d354333eeeb8390d5a /documentation
parent063b0cf8f99e2a438e35c4796a48cf946a5e5329 (diff)
downloadpoky-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')
-rw-r--r--documentation/profile-manual/usage.rst28
-rw-r--r--documentation/ref-manual/classes.rst2
-rw-r--r--documentation/ref-manual/variables.rst2
3 files changed, 16 insertions, 16 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
39The coverage below details some of the most common ways you'll likely 39The coverage below details some of the most common ways you'll likely
40want to apply the tool; full documentation can be found either within 40want to apply the tool; full documentation can be found either within
41the tool itself or in the man pages at 41the 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
44Perf Setup 44Perf Setup
@@ -1147,37 +1147,37 @@ callgraphs from starting a few programs during those 30 seconds:
1147Perf Documentation 1147Perf Documentation
1148------------------ 1148------------------
1149 1149
1150Online versions of the man pages for the commands discussed in this 1150Online versions of the manual pages for the commands discussed in this
1151section can be found here: 1151section 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
1171Normally, you should be able to invoke the man pages via perf itself 1171Normally, you should be able to invoke the manual pages via perf itself
1172e.g. ``perf help`` or ``perf help record``. 1172e.g. ``perf help`` or ``perf help record``.
1173 1173
1174To have the perf manpages installed on your target, modify your 1174To have the perf manual pages installed on your target, modify your
1175configuration as follows:: 1175configuration 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
1180The man pages in text form, along with some other files, such as a set 1180The manual pages in text form, along with some other files, such as a set
1181of examples, can also be found in the ``perf`` directory of the kernel tree:: 1181of 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::
2391The report shows each event that was 2391The report shows each event that was
2392found in the blktrace data, along with a summary of the overall block 2392found in the blktrace data, along with a summary of the overall block
2393I/O traffic during the run. You can look at the 2393I/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
2395meaning of each field displayed in the trace listing. 2395meaning of each field displayed in the trace listing.
2396 2396
2397Live Mode 2397Live Mode
@@ -2588,7 +2588,7 @@ And this turns off tracing for the specified device::
2588blktrace Documentation 2588blktrace Documentation
2589---------------------- 2589----------------------
2590 2590
2591Online versions of the man pages for the commands discussed in this 2591Online versions of the manual pages for the commands discussed in this
2592section can be found here: 2592section 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
2600The above manpages, along with manuals for the other blktrace utilities 2600The 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
2602tools git repo:: 2602tools git repo::
2603 2603
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 412dc5ca2f..ab71cbe40c 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -421,7 +421,7 @@ and BusyBox. It could have been called "kconfig" too.
421``compress_doc`` 421``compress_doc``
422================ 422================
423 423
424Enables compression for man pages and info pages. This class is intended 424Enables compression for manual and info pages. This class is intended
425to be inherited globally. The default compression mechanism is gz (gzip) 425to be inherited globally. The default compression mechanism is gz (gzip)
426but you can select an alternative mechanism by setting the 426but you can select an alternative mechanism by setting the
427:term:`DOC_COMPRESS` variable. 427:term:`DOC_COMPRESS` variable.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6e66dc7358..4571f2522c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2292,7 +2292,7 @@ system and gives an overview of their function and contents.
2292 :term:`DOC_COMPRESS` 2292 :term:`DOC_COMPRESS`
2293 When inheriting the :ref:`ref-classes-compress_doc` 2293 When inheriting the :ref:`ref-classes-compress_doc`
2294 class, this variable sets the compression policy used when the 2294 class, this variable sets the compression policy used when the
2295 OpenEmbedded build system compresses man pages and info pages. By 2295 OpenEmbedded build system compresses manual and info pages. By
2296 default, the compression method used is gz (gzip). Other policies 2296 default, the compression method used is gz (gzip). Other policies
2297 available are xz and bz2. 2297 available are xz and bz2.
2298 2298