docs: devices.rst: fix a C reference markup
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 29 Sep 2020 10:38:37 +0000 (12:38 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 15 Oct 2020 05:49:44 +0000 (07:49 +0200)
The C domain parser of Sphinx3 expects just function names
for :c:func: markups:

./Documentation/driver-api/pm/devices.rst:413: WARNING: Unparseable C cross-reference: 'device_may_wakeup(dev)'
Invalid C declaration: Expected end of definition. [error at 17]
  device_may_wakeup(dev)
  -----------------^

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/driver-api/pm/devices.rst

index 4bda8a21f5d1a9a7b70031bd1f9247ce5418e528..6b3bfd29fd844cac86990248035e15b81602c5a6 100644 (file)
@@ -410,7 +410,7 @@ On many platforms they will gate off one or more clock sources; sometimes they
 will also switch off power supplies or reduce voltages.  [Drivers supporting
 runtime PM may already have performed some or all of these steps.]
 
-If :c:func:`device_may_wakeup(dev)` returns ``true``, the device should be
+If :c:func:`device_may_wakeup()` returns ``true``, the device should be
 prepared for generating hardware wakeup signals to trigger a system wakeup event
 when the system is in the sleep state.  For example, :c:func:`enable_irq_wake()`
 might identify GPIO signals hooked up to a switch or other external hardware,