lkml.org 
[lkml]   [2020]   [Oct]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v5 36/52] docs: devices.rst: get rid of :c:type macros
    Date
    There's no need to use macros to use :c:type on this file,
    as automarkup.py should do this automatically.

    Also, this breaks compatibility with Sphinx 3.x, as there,
    structs should be declared using .. c:struct.

    So, get rid of them.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    Documentation/driver-api/pm/devices.rst | 24 ++++++++----------------
    1 file changed, 8 insertions(+), 16 deletions(-)

    diff --git a/Documentation/driver-api/pm/devices.rst b/Documentation/driver-api/pm/devices.rst
    index 946ad0b94e31..4bda8a21f5d1 100644
    --- a/Documentation/driver-api/pm/devices.rst
    +++ b/Documentation/driver-api/pm/devices.rst
    @@ -1,14 +1,6 @@
    .. SPDX-License-Identifier: GPL-2.0
    .. include:: <isonum.txt>

    -.. |struct dev_pm_ops| replace:: :c:type:`struct dev_pm_ops <dev_pm_ops>`
    -.. |struct dev_pm_domain| replace:: :c:type:`struct dev_pm_domain <dev_pm_domain>`
    -.. |struct bus_type| replace:: :c:type:`struct bus_type <bus_type>`
    -.. |struct device_type| replace:: :c:type:`struct device_type <device_type>`
    -.. |struct class| replace:: :c:type:`struct class <class>`
    -.. |struct wakeup_source| replace:: :c:type:`struct wakeup_source <wakeup_source>`
    -.. |struct device| replace:: :c:type:`struct device <device>`
    -
    .. _driverapi_pm_devices:

    ==============================
    @@ -107,7 +99,7 @@ Device Power Management Operations

    Device power management operations, at the subsystem level as well as at the
    device driver level, are implemented by defining and populating objects of type
    -|struct dev_pm_ops| defined in :file:`include/linux/pm.h`. The roles of the
    +struct dev_pm_ops defined in :file:`include/linux/pm.h`. The roles of the
    methods included in it will be explained in what follows. For now, it should be
    sufficient to remember that the last three methods are specific to runtime power
    management while the remaining ones are used during system-wide power
    @@ -115,7 +107,7 @@ transitions.

    There also is a deprecated "old" or "legacy" interface for power management
    operations available at least for some subsystems. This approach does not use
    -|struct dev_pm_ops| objects and it is suitable only for implementing system
    +struct dev_pm_ops objects and it is suitable only for implementing system
    sleep power management methods in a limited way. Therefore it is not described
    in this document, so please refer directly to the source code for more
    information about it.
    @@ -125,9 +117,9 @@ Subsystem-Level Methods
    -----------------------

    The core methods to suspend and resume devices reside in
    -|struct dev_pm_ops| pointed to by the :c:member:`ops` member of
    -|struct dev_pm_domain|, or by the :c:member:`pm` member of |struct bus_type|,
    -|struct device_type| and |struct class|. They are mostly of interest to the
    +struct dev_pm_ops pointed to by the :c:member:`ops` member of
    +struct dev_pm_domain, or by the :c:member:`pm` member of struct bus_type,
    +struct device_type and struct class. They are mostly of interest to the
    people writing infrastructure for platforms and buses, like PCI or USB, or
    device type and device class drivers. They also are relevant to the writers of
    device drivers whose subsystems (PM domains, device types, device classes and
    @@ -156,7 +148,7 @@ The :c:member:`power.can_wakeup` flag just records whether the device (and its
    driver) can physically support wakeup events. The
    :c:func:`device_set_wakeup_capable()` routine affects this flag. The
    :c:member:`power.wakeup` field is a pointer to an object of type
    -|struct wakeup_source| used for controlling whether or not the device should use
    +struct wakeup_source used for controlling whether or not the device should use
    its system wakeup mechanism and for notifying the PM core of system wakeup
    events signaled by the device. This object is only present for wakeup-capable
    devices (i.e. devices whose :c:member:`can_wakeup` flags are set) and is created
    @@ -713,8 +705,8 @@ nested inside another power domain. The nested domain is referred to as the
    sub-domain of the parent domain.

    Support for power domains is provided through the :c:member:`pm_domain` field of
    -|struct device|. This field is a pointer to an object of type
    -|struct dev_pm_domain|, defined in :file:`include/linux/pm.h`, providing a set
    +struct device. This field is a pointer to an object of type
    +struct dev_pm_domain, defined in :file:`include/linux/pm.h`, providing a set
    of power management callbacks analogous to the subsystem-level and device driver
    callbacks that are executed for the given device during all power transitions,
    instead of the respective subsystem-level callbacks. Specifically, if a
    --
    2.26.2
    \
     
     \ /
      Last update: 2020-10-06 16:06    [W:4.094 / U:0.028 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site