]> git.baikalelectronics.ru Git - kernel.git/commit
PM / docs: Fix structure references in device.rst
authorRafael J. Wysocki <rafael.j.wysocki@intel.com>
Mon, 20 Feb 2017 14:26:21 +0000 (15:26 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 20 Feb 2017 23:40:42 +0000 (16:40 -0700)
commit68bdd12ca919662a5a38359670caec963aa198d6
tree1cfb162d4b3a5b0835b37e8603572464006b4f23
parentf4e608ec83efd86cb5ce887461c8db5544de91af
PM / docs: Fix structure references in device.rst

There is a better way to represent structure references than it was
done in device.rst by commit 664df0b49508 (PM / sleep / docs: Convert
PM notifiers document to reST), which is to use "struct name" as a
link caption (e.g. :c:type:`struct device <device>`).  That will
cause sphinx to generate a proper reference to the data type in
question (struct device in the example above) and "struct name"
will work as the link in the HTML output.

Fix device.rst by using that convention where applicable.

Fixes: 664df0b49508 (PM / sleep / docs: Convert PM notifiers document to reST)
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/driver-api/pm/devices.rst