Skip to content

Commit

Permalink
docs / driver-api: Fix structure references in device_link.rst
Browse files Browse the repository at this point in the history
The format of the structure references in device_link.rst is
incorrect, because it doesn't cause proper references to the
struct data types to be generated (for struct dev_pm_domain in
particular).

Fix that by using the :c:type:`struct name <name>` convention
for encoding references to struct data types.

Fixes: aad8004 (Documentation/core-api/device_link: Add initial documentation)
Signed-off-by: Rafael J. Wysocki <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
rafaeljw authored and Jonathan Corbet committed Feb 20, 2017
1 parent e3941cd commit bd85626
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions Documentation/driver-api/device_link.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. |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 links
============
Expand Down Expand Up @@ -120,12 +123,11 @@ Examples
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
suggest usage of a :c:type:`struct dev_pm_domain` or :c:type:`struct
generic_pm_domain`, however these are not independent devices that
happen to share a power switch, but rather the MMU device serves the
busmaster device and is useless without it. A device link creates a
synthetic hierarchical relationship between the devices and is thus
more apt.
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
switch, but rather the MMU device serves the busmaster device and is
useless without it. A device link creates a synthetic hierarchical
relationship between the devices and is thus more apt.

* A Thunderbolt host controller comprises a number of PCIe hotplug ports
and an NHI device to manage the PCIe switch. On resume from system sleep,
Expand Down Expand Up @@ -157,7 +159,7 @@ Examples
Alternatives
============

* A :c:type:`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
a single on/off switch, however it does not guarantee a specific
suspend/resume ordering, this needs to be implemented separately.
Expand All @@ -166,7 +168,7 @@ Alternatives
suspended. Furthermore it cannot be used to enforce a specific shutdown
ordering or a driver presence dependency.

* A :c:type:`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
dependencies. It also cannot be used on ACPI systems.

Expand Down

0 comments on commit bd85626

Please sign in to comment.