From 3b86df94f7a83bbeb16080b6f952c1390c06b689 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Wed, 13 Mar 2024 15:08:01 +0100 Subject: 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 Signed-off-by: Richard Purdie --- documentation/profile-manual/usage.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'documentation/profile-manual') 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. 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) `__. Perf Setup @@ -1147,37 +1147,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 `__. +- The `'perf stat' manual page `__. - The `'perf record' - manpage `__. + manual page `__. - The `'perf report' - manpage `__. + manual page `__. -- The `'perf probe' manpage `__. +- The `'perf probe' manual page `__. - The `'perf script' - manpage `__. + manual page `__. - Documentation on using the `'perf script' Python binding `__. -- The top-level `perf(1) manpage `__. +- The top-level `perf(1) manual page `__. -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 @@ -2391,7 +2391,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 `__ manpage to learn the +`blkparse `__ manual page to learn the meaning of each field displayed in the trace listing. Live Mode @@ -2588,7 +2588,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 @@ -2597,7 +2597,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:: -- cgit v1.2.3-54-g00ecf