Commit abc59fd4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

docs: remove some replace macros like |struct foo|

There are three files with replace macros for structs,
mapping them into Sphinx 2.x C domain references.

Well, this is broken on Sphinx 3.x. Also, for Sphinx 2.x,
the automarkup macro should be able to take care of them.

So, let's just drop those.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 5b76632e
.. SPDX-License-Identifier: GPL-2.0 .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt> .. include:: <isonum.txt>
.. |struct cpufreq_policy| replace:: :c:type:`struct cpufreq_policy <cpufreq_policy>`
.. |intel_pstate| replace:: :doc:`intel_pstate <intel_pstate>` .. |intel_pstate| replace:: :doc:`intel_pstate <intel_pstate>`
======================= =======================
...@@ -92,16 +91,16 @@ control the P-state of multiple CPUs at the same time and writing to it affects ...@@ -92,16 +91,16 @@ control the P-state of multiple CPUs at the same time and writing to it affects
all of those CPUs simultaneously. all of those CPUs simultaneously.
Sets of CPUs sharing hardware P-state control interfaces are represented by Sets of CPUs sharing hardware P-state control interfaces are represented by
``CPUFreq`` as |struct cpufreq_policy| objects. For consistency, ``CPUFreq`` as struct cpufreq_policy objects. For consistency,
|struct cpufreq_policy| is also used when there is only one CPU in the given struct cpufreq_policy is also used when there is only one CPU in the given
set. set.
The ``CPUFreq`` core maintains a pointer to a |struct cpufreq_policy| object for The ``CPUFreq`` core maintains a pointer to a struct cpufreq_policy object for
every CPU in the system, including CPUs that are currently offline. If multiple every CPU in the system, including CPUs that are currently offline. If multiple
CPUs share the same hardware P-state control interface, all of the pointers CPUs share the same hardware P-state control interface, all of the pointers
corresponding to them point to the same |struct cpufreq_policy| object. corresponding to them point to the same struct cpufreq_policy object.
``CPUFreq`` uses |struct cpufreq_policy| as its basic data type and the design ``CPUFreq`` uses struct cpufreq_policy as its basic data type and the design
of its user space interface is based on the policy concept. of its user space interface is based on the policy concept.
......
.. |struct dev_pm_domain| replace:: :c:type:`struct dev_pm_domain <dev_pm_domain>`
.. |struct generic_pm_domain| replace:: :c:type:`struct generic_pm_domain <generic_pm_domain>`
.. _device_link: .. _device_link:
============ ============
...@@ -166,7 +162,7 @@ Examples ...@@ -166,7 +162,7 @@ Examples
is the same as if the MMU was the parent of the master device. is the same as if the MMU was the parent of the master device.
The fact that both devices share the same power domain would normally The fact that both devices share the same power domain would normally
suggest usage of a |struct dev_pm_domain| or |struct generic_pm_domain|, suggest usage of a struct dev_pm_domain or struct generic_pm_domain,
however these are not independent devices that happen to share a power however these are not independent devices that happen to share a power
switch, but rather the MMU device serves the busmaster device and is switch, but rather the MMU device serves the busmaster device and is
useless without it. A device link creates a synthetic hierarchical useless without it. A device link creates a synthetic hierarchical
...@@ -202,7 +198,7 @@ Examples ...@@ -202,7 +198,7 @@ Examples
Alternatives Alternatives
============ ============
* A |struct dev_pm_domain| can be used to override the bus, * A struct dev_pm_domain can be used to override the bus,
class or device type callbacks. It is intended for devices sharing class or device type callbacks. It is intended for devices sharing
a single on/off switch, however it does not guarantee a specific a single on/off switch, however it does not guarantee a specific
suspend/resume ordering, this needs to be implemented separately. suspend/resume ordering, this needs to be implemented separately.
...@@ -211,7 +207,7 @@ Alternatives ...@@ -211,7 +207,7 @@ Alternatives
suspended. Furthermore it cannot be used to enforce a specific shutdown suspended. Furthermore it cannot be used to enforce a specific shutdown
ordering or a driver presence dependency. ordering or a driver presence dependency.
* A |struct generic_pm_domain| is a lot more heavyweight than a * A struct generic_pm_domain is a lot more heavyweight than a
device link and does not allow for shutdown ordering or driver presence device link and does not allow for shutdown ordering or driver presence
dependencies. It also cannot be used on ACPI systems. dependencies. It also cannot be used on ACPI systems.
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment