From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [kirkstone][PATCH 3/9] manuals: use "manual page(s)"
Date: Mon, 25 Mar 2024 14:27:31 +0100 [thread overview]
Message-ID: <20240325132737.3018073-4-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20240325132737.3018073-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Instead of "manpage(s)" or "man page(s)".
To address one of the errors reported by "make stylecheck"
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/profile-manual/usage.rst | 28 +++++++++++++-------------
documentation/ref-manual/classes.rst | 2 +-
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.
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
-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 Setup
@@ -1132,37 +1132,37 @@ callgraphs from starting a few programs during those 30 seconds:
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:
-- 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'
- manpage <https://linux.die.net/man/1/perf-record>`__.
+ manual page <https://linux.die.net/man/1/perf-record>`__.
- 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'
- 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
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``.
-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::
IMAGE_INSTALL:append = " perf perf-doc"
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::
tools/perf/Documentation
@@ -2369,7 +2369,7 @@ first part of the filenames::
The report shows each event that was
found in the blktrace data, along with a summary of the overall block
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.
Live Mode
@@ -2566,7 +2566,7 @@ And this turns off tracing for the specified device::
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:
- https://linux.die.net/man/8/blktrace
@@ -2575,7 +2575,7 @@ section can be found here:
- 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
tools git repo::
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.
``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)
but you can select an alternative mechanism by setting the
: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.
:term:`DOC_COMPRESS`
When inheriting the :ref:`compress_doc <ref-classes-compress_doc>`
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
available are xz and bz2.
--
2.34.1
next prev parent reply other threads:[~2024-03-25 13:27 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-25 13:27 [kirkstone][PATCH 0/9] documentation backports michael.opdenacker
2024-03-25 13:27 ` [kirkstone][PATCH 1/9] manuals: add initial stylechecks with Vale michael.opdenacker
2024-03-25 13:27 ` [kirkstone][PATCH 2/9] profile-manual: usage.rst: formatting fixes michael.opdenacker
2024-03-25 13:27 ` michael.opdenacker [this message]
2024-03-25 13:27 ` [kirkstone][PATCH 4/9] profile-manual: usage.rst: fix reference to bug report michael.opdenacker
2024-03-25 13:27 ` [kirkstone][PATCH 5/9] migration-guides: add release notes for 4.0.17 michael.opdenacker
2024-03-25 13:27 ` [kirkstone][PATCH 6/9] contributor-guide: be more specific about meta-* trees michael.opdenacker
2024-03-25 13:27 ` [kirkstone][PATCH 7/9] profile-manual: usage.rst: further style improvements michael.opdenacker
2024-03-25 13:27 ` [kirkstone][PATCH 8/9] ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX michael.opdenacker
2024-03-25 13:27 ` [kirkstone][PATCH 9/9] dev-manual: improve descriptions of 'bitbake -S printdiff' michael.opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240325132737.3018073-4-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.