From patchwork Mon Mar 25 13:27:31 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 41455 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 020A9CD11DD for ; Mon, 25 Mar 2024 13:27:52 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web10.51971.1711373266687661269 for ; Mon, 25 Mar 2024 06:27:47 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=IwhRMUP1; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 3B1F420011; Mon, 25 Mar 2024 13:27:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1711373265; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=m8ey1jskUojM+nsOnuxh0WZlX46YwqoxAcrJLSEGVfE=; b=IwhRMUP1bNKFwZ8Deh62egvkavlJfRfM8FQC/ExSyWXZ3P7pNQR6yBKt5uTSDiFji3vhFX pZhInwliOVYKiJIefYYHvZwquhu9rAyzNYnW7ftids20dqYjd3mbuX+1UmFht2vinxipLX bERUGJE10xY8lAHo2IE4cY2S3XibBEYd+9sVkuq4qDTOBKTEqg49HRn+aOeS6SYUgBZq5K CzElDbARcssp/3CJjF5NV4E0W7yer6qcqfqTOGElZM+/qoBeKNt3XPm6ZePy07xuVzL2qg jwlQmfYsoO5gIhH0n+eRWBerT7bYPWWNQpNfDXAtM5oAEVyKBJ+/yiK7n/CXHQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 3/9] manuals: use "manual page(s)" Date: Mon, 25 Mar 2024 14:27:31 +0100 Message-Id: <20240325132737.3018073-4-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240325132737.3018073-1-michael.opdenacker@bootlin.com> References: <20240325132737.3018073-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@bootlin.com List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Mon, 25 Mar 2024 13:27:52 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5000 From: Michael Opdenacker Instead of "manpage(s)" or "man page(s)". To address one of the errors reported by "make stylecheck" Signed-off-by: Michael Opdenacker --- 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) `__. 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 `__. +- 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 @@ -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 `__ manpage to learn the +`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 ` 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.