All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	"Rafael J. Wysocki" <rjw@rjwysocki.net>,
	Viresh Kumar <viresh.kumar@linaro.org>,
	linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org
Subject: [PATCH v2 03/29] docs: admin-guide: pm: avoid using ReST :doc:`foo` markup
Date: Wed, 16 Jun 2021 08:27:18 +0200	[thread overview]
Message-ID: <04616d9fc0b4a0d33486fa0018631a2db2eba860.1623824363.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1623824363.git.mchehab+huawei@kernel.org>

The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/admin-guide/pm/intel_idle.rst   | 16 ++++++++++------
 Documentation/admin-guide/pm/intel_pstate.rst |  9 +++++----
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/Documentation/admin-guide/pm/intel_idle.rst b/Documentation/admin-guide/pm/intel_idle.rst
index 89309e1b0e48..b799a43da62e 100644
--- a/Documentation/admin-guide/pm/intel_idle.rst
+++ b/Documentation/admin-guide/pm/intel_idle.rst
@@ -20,8 +20,8 @@ Nehalem and later generations of Intel processors, but the level of support for
 a particular processor model in it depends on whether or not it recognizes that
 processor model and may also depend on information coming from the platform
 firmware.  [To understand ``intel_idle`` it is necessary to know how ``CPUIdle``
-works in general, so this is the time to get familiar with :doc:`cpuidle` if you
-have not done that yet.]
+works in general, so this is the time to get familiar with
+Documentation/admin-guide/pm/cpuidle.rst if you have not done that yet.]
 
 ``intel_idle`` uses the ``MWAIT`` instruction to inform the processor that the
 logical CPU executing it is idle and so it may be possible to put some of the
@@ -53,7 +53,8 @@ processor) corresponding to them depends on the processor model and it may also
 depend on the configuration of the platform.
 
 In order to create a list of available idle states required by the ``CPUIdle``
-subsystem (see :ref:`idle-states-representation` in :doc:`cpuidle`),
+subsystem (see :ref:`idle-states-representation` in
+Documentation/admin-guide/pm/cpuidle.rst),
 ``intel_idle`` can use two sources of information: static tables of idle states
 for different processor models included in the driver itself and the ACPI tables
 of the system.  The former are always used if the processor model at hand is
@@ -98,7 +99,8 @@ states may not be enabled by default if there are no matching entries in the
 preliminary list of idle states coming from the ACPI tables.  In that case user
 space still can enable them later (on a per-CPU basis) with the help of
 the ``disable`` idle state attribute in ``sysfs`` (see
-:ref:`idle-states-representation` in :doc:`cpuidle`).  This basically means that
+:ref:`idle-states-representation` in
+Documentation/admin-guide/pm/cpuidle.rst).  This basically means that
 the idle states "known" to the driver may not be enabled by default if they have
 not been exposed by the platform firmware (through the ACPI tables).
 
@@ -186,7 +188,8 @@ be desirable.  In practice, it is only really necessary to do that if the idle
 states in question cannot be enabled during system startup, because in the
 working state of the system the CPU power management quality of service (PM
 QoS) feature can be used to prevent ``CPUIdle`` from touching those idle states
-even if they have been enumerated (see :ref:`cpu-pm-qos` in :doc:`cpuidle`).
+even if they have been enumerated (see :ref:`cpu-pm-qos` in
+Documentation/admin-guide/pm/cpuidle.rst).
 Setting ``max_cstate`` to 0 causes the ``intel_idle`` initialization to fail.
 
 The ``no_acpi`` and ``use_acpi`` module parameters (recognized by ``intel_idle``
@@ -202,7 +205,8 @@ Namely, the positions of the bits that are set in the ``states_off`` value are
 the indices of idle states to be disabled by default (as reflected by the names
 of the corresponding idle state directories in ``sysfs``, :file:`state0`,
 :file:`state1` ... :file:`state<i>` ..., where ``<i>`` is the index of the given
-idle state; see :ref:`idle-states-representation` in :doc:`cpuidle`).
+idle state; see :ref:`idle-states-representation` in
+Documentation/admin-guide/pm/cpuidle.rst).
 
 For example, if ``states_off`` is equal to 3, the driver will disable idle
 states 0 and 1 by default, and if it is equal to 8, idle state 3 will be
diff --git a/Documentation/admin-guide/pm/intel_pstate.rst b/Documentation/admin-guide/pm/intel_pstate.rst
index df29b4f1f219..7a7d4b041eac 100644
--- a/Documentation/admin-guide/pm/intel_pstate.rst
+++ b/Documentation/admin-guide/pm/intel_pstate.rst
@@ -18,8 +18,8 @@ General Information
 (``CPUFreq``).  It is a scaling driver for the Sandy Bridge and later
 generations of Intel processors.  Note, however, that some of those processors
 may not be supported.  [To understand ``intel_pstate`` it is necessary to know
-how ``CPUFreq`` works in general, so this is the time to read :doc:`cpufreq` if
-you have not done that yet.]
+how ``CPUFreq`` works in general, so this is the time to read
+Documentation/admin-guide/pm/cpufreq.rst if you have not done that yet.]
 
 For the processors supported by ``intel_pstate``, the P-state concept is broader
 than just an operating frequency or an operating performance point (see the
@@ -445,8 +445,9 @@ Interpretation of Policy Attributes
 -----------------------------------
 
 The interpretation of some ``CPUFreq`` policy attributes described in
-:doc:`cpufreq` is special with ``intel_pstate`` as the current scaling driver
-and it generally depends on the driver's `operation mode <Operation Modes_>`_.
+Documentation/admin-guide/pm/cpufreq.rst is special with ``intel_pstate``
+as the current scaling driver and it generally depends on the driver's
+`operation mode <Operation Modes_>`_.
 
 First of all, the values of the ``cpuinfo_max_freq``, ``cpuinfo_min_freq`` and
 ``scaling_cur_freq`` attributes are produced by applying a processor-specific
-- 
2.31.1


  parent reply	other threads:[~2021-06-16  6:28 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-16  6:27 [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-16  6:27 ` Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 01/29] docs: devices.rst: better reference documentation docs Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 02/29] docs: dev-tools: kunit: don't use a table for docs name Mauro Carvalho Chehab
2021-06-16  6:27 ` Mauro Carvalho Chehab [this message]
2021-06-16  6:27 ` [PATCH v2 04/29] docs: admin-guide: hw-vuln: avoid using ReST :doc:`foo` markup Mauro Carvalho Chehab
2021-06-16 18:21   ` mark gross
2021-06-16 20:21     ` Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 05/29] docs: admin-guide: sysctl: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 06/29] docs: block: biodoc.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 07/29] docs: bpf: bpf_lsm.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 08/29] docs: core-api: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 09/29] docs: dev-tools: testing-overview.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 10/29] docs: dev-tools: kunit: " Mauro Carvalho Chehab
2021-06-25 21:27   ` Brendan Higgins
2021-06-25 22:12     ` Jonathan Corbet
2021-06-16  6:27 ` [PATCH v2 11/29] docs: devicetree: bindings: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16 22:08   ` Rob Herring
2021-06-17  6:38     ` Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 12/29] docs: doc-guide: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 13/29] docs: driver-api: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 14/29] docs: driver-api: gpio: using-gpio.rst: " Mauro Carvalho Chehab
2021-06-25 10:37   ` Bartosz Golaszewski
2021-06-16  6:27 ` [PATCH v2 15/29] docs: driver-api: surface_aggregator: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 16/29] docs: driver-api: usb: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 17/29] docs: firmware-guide: acpi: " Mauro Carvalho Chehab
2021-06-16  6:55   ` Sakari Ailus
2021-06-16  6:27 ` [PATCH v2 18/29] docs: i2c: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 19/29] docs: kernel-hacking: hacking.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 20/29] docs: networking: devlink: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 21/29] docs: PCI: endpoint: pci-endpoint-cfs.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 22/29] docs: PCI: pci.rst: " Mauro Carvalho Chehab
2021-06-16 14:17   ` Bjorn Helgaas
2021-06-16  6:27 ` [PATCH v2 23/29] docs: process: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 24/29] docs: security: landlock.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 25/29] docs: trace: coresight: coresight.rst: " Mauro Carvalho Chehab
2021-06-16  6:27   ` Mauro Carvalho Chehab
2021-06-17 15:03   ` Mathieu Poirier
2021-06-17 15:03     ` Mathieu Poirier
2021-06-16  6:27 ` [PATCH v2 26/29] docs: trace: ftrace.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 27/29] docs: userspace-api: landlock.rst: " Mauro Carvalho Chehab
2021-06-23 12:26   ` Mickaël Salaün
2021-06-16  6:27 ` [PATCH v2 28/29] docs: virt: kvm: s390-pv-boot.rst: " Mauro Carvalho Chehab
2021-06-16  6:27 ` [PATCH v2 29/29] docs: x86: " Mauro Carvalho Chehab
2021-06-17 19:34 ` [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Jonathan Corbet
2021-06-17 19:34   ` Jonathan Corbet

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=04616d9fc0b4a0d33486fa0018631a2db2eba860.1623824363.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=rjw@rjwysocki.net \
    --cc=viresh.kumar@linaro.org \
    --subject='Re: [PATCH v2 03/29] docs: admin-guide: pm: avoid using ReST :doc:`foo` markup' \
    /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

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.