mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-20 03:49:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

manuals: use "manual page(s)"

Browse Source 
Instead of "manpage(s)" or "man page(s)".
To address one of the errors reported by "make stylecheck"

(From yocto-docs rev: 7d9faaf283454d653e541a8faf0d50f4c968cc66)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This commit is contained in:
Michael Opdenacker
2024-03-13 15:08:01 +01:00
committed by Steve Sakoman
parent c3871e9b55
commit 92af404c25
3 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
documentation/profile-manual/usage.rst
View File

@@ -38,7 +38,7 @@ other tools when it seems useful to do so.
The coverage below details some of the most common ways you'll likely The coverage below details some of the most common ways you'll likely
want to apply the tool; full documentation can be found either within want to apply the tool; full documentation can be found either within
the tool itself or in the man pages at the tool itself or in the manual pages at
`perf(1) <https://linux.die.net/man/1/perf>`__. `perf(1) <https://linux.die.net/man/1/perf>`__.
Perf Setup Perf Setup
@@ -1147,37 +1147,37 @@ callgraphs from starting a few programs during those 30 seconds:
Perf Documentation Perf Documentation
------------------ ------------------
Online versions of the man pages for the commands discussed in this Online versions of the manual pages for the commands discussed in this
section can be found here: section can be found here:
- The `'perf stat' manpage <https://linux.die.net/man/1/perf-stat>`__. - The `'perf stat' manual page <https://linux.die.net/man/1/perf-stat>`__.
- The `'perf record' - The `'perf record'
manpage <https://linux.die.net/man/1/perf-record>`__. manual page <https://linux.die.net/man/1/perf-record>`__.
- The `'perf report' - The `'perf report'
manpage <https://linux.die.net/man/1/perf-report>`__. manual page <https://linux.die.net/man/1/perf-report>`__.
- The `'perf probe' manpage <https://linux.die.net/man/1/perf-probe>`__. - The `'perf probe' manual page <https://linux.die.net/man/1/perf-probe>`__.
- The `'perf script' - The `'perf script'
manpage <https://linux.die.net/man/1/perf-script>`__. manual page <https://linux.die.net/man/1/perf-script>`__.
- Documentation on using the `'perf script' Python - Documentation on using the `'perf script' Python
binding <https://linux.die.net/man/1/perf-script-python>`__. binding <https://linux.die.net/man/1/perf-script-python>`__.
- The top-level `perf(1) manpage <https://linux.die.net/man/1/perf>`__. - The top-level `perf(1) manual page <https://linux.die.net/man/1/perf>`__.
Normally, you should be able to invoke the man pages via perf itself Normally, you should be able to invoke the manual pages via perf itself
e.g. ``perf help`` or ``perf help record``. e.g. ``perf help`` or ``perf help record``.
To have the perf manpages installed on your target, modify your To have the perf manual pages installed on your target, modify your
configuration as follows:: configuration as follows::
IMAGE_INSTALL:append = " perf perf-doc" IMAGE_INSTALL:append = " perf perf-doc"
DISTRO_FEATURES:append = " api-documentation" DISTRO_FEATURES:append = " api-documentation"
The man pages in text form, along with some other files, such as a set The manual pages in text form, along with some other files, such as a set
of examples, can also be found in the ``perf`` directory of the kernel tree:: of examples, can also be found in the ``perf`` directory of the kernel tree::
tools/perf/Documentation tools/perf/Documentation
@@ -2391,7 +2391,7 @@ first part of the filenames::
The report shows each event that was The report shows each event that was
found in the blktrace data, along with a summary of the overall block found in the blktrace data, along with a summary of the overall block
I/O traffic during the run. You can look at the I/O traffic during the run. You can look at the
`blkparse <https://linux.die.net/man/1/blkparse>`__ manpage to learn the `blkparse <https://linux.die.net/man/1/blkparse>`__ manual page to learn the
meaning of each field displayed in the trace listing. meaning of each field displayed in the trace listing.
Live Mode Live Mode
@@ -2588,7 +2588,7 @@ And this turns off tracing for the specified device::
blktrace Documentation blktrace Documentation
---------------------- ----------------------
Online versions of the man pages for the commands discussed in this Online versions of the manual pages for the commands discussed in this
section can be found here: section can be found here:
- https://linux.die.net/man/8/blktrace - https://linux.die.net/man/8/blktrace
@@ -2597,7 +2597,7 @@ section can be found here:
- https://linux.die.net/man/8/btrace - https://linux.die.net/man/8/btrace
The above manpages, along with manuals for the other blktrace utilities The above manual pages, along with manuals for the other blktrace utilities
(btt, blkiomon, etc) can be found in the ``/doc`` directory of the blktrace (btt, blkiomon, etc) can be found in the ``/doc`` directory of the blktrace
tools git repo:: tools git repo::

2
documentation/ref-manual/classes.rst
View File

@@ -392,7 +392,7 @@ and BusyBox. It could have been called "kconfig" too.
``compress_doc`` ``compress_doc``
================ ================
Enables compression for man pages and info pages. This class is intended Enables compression for manual and info pages. This class is intended
to be inherited globally. The default compression mechanism is gz (gzip) to be inherited globally. The default compression mechanism is gz (gzip)
but you can select an alternative mechanism by setting the but you can select an alternative mechanism by setting the
:term:`DOC_COMPRESS` variable. :term:`DOC_COMPRESS` variable.

2
documentation/ref-manual/variables.rst
View File

@@ -2292,7 +2292,7 @@ system and gives an overview of their function and contents.
:term:`DOC_COMPRESS` :term:`DOC_COMPRESS`
When inheriting the :ref:`ref-classes-compress_doc` When inheriting the :ref:`ref-classes-compress_doc`
class, this variable sets the compression policy used when the class, this variable sets the compression policy used when the
OpenEmbedded build system compresses man pages and info pages. By OpenEmbedded build system compresses manual and info pages. By
default, the compression method used is gz (gzip). Other policies default, the compression method used is gz (gzip). Other policies
available are xz and bz2. available are xz and bz2.