aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-06-12 13:53:00 -0400
committerJonathan Corbet <corbet@lwn.net>2019-06-14 16:31:48 -0400
commit458f69ef36656dc74679667380422dd8063eabfb (patch)
treec44aafca54ae7d01160fe8ef09e7999594145a67 /include
parent4ca9bc225e46eb7bc040dd948be7cb68975d80d3 (diff)
docs: timers: convert docs to ReST and rename to *.rst
The conversion here is really trivial: just a bunch of title markups and very few puntual changes is enough to make it to be parsed by Sphinx and generate a nice html. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'include')
-rw-r--r--include/linux/iopoll.h4
-rw-r--r--include/linux/regmap.h4
2 files changed, 4 insertions, 4 deletions
diff --git a/include/linux/iopoll.h b/include/linux/iopoll.h
index 3908353deec6..35e15dfd4155 100644
--- a/include/linux/iopoll.h
+++ b/include/linux/iopoll.h
@@ -21,7 +21,7 @@
21 * @cond: Break condition (usually involving @val) 21 * @cond: Break condition (usually involving @val)
22 * @sleep_us: Maximum time to sleep between reads in us (0 22 * @sleep_us: Maximum time to sleep between reads in us (0
23 * tight-loops). Should be less than ~20ms since usleep_range 23 * tight-loops). Should be less than ~20ms since usleep_range
24 * is used (see Documentation/timers/timers-howto.txt). 24 * is used (see Documentation/timers/timers-howto.rst).
25 * @timeout_us: Timeout in us, 0 means never timeout 25 * @timeout_us: Timeout in us, 0 means never timeout
26 * 26 *
27 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either 27 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
@@ -60,7 +60,7 @@
60 * @cond: Break condition (usually involving @val) 60 * @cond: Break condition (usually involving @val)
61 * @delay_us: Time to udelay between reads in us (0 tight-loops). Should 61 * @delay_us: Time to udelay between reads in us (0 tight-loops). Should
62 * be less than ~10us since udelay is used (see 62 * be less than ~10us since udelay is used (see
63 * Documentation/timers/timers-howto.txt). 63 * Documentation/timers/timers-howto.rst).
64 * @timeout_us: Timeout in us, 0 means never timeout 64 * @timeout_us: Timeout in us, 0 means never timeout
65 * 65 *
66 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either 66 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
diff --git a/include/linux/regmap.h b/include/linux/regmap.h
index daeec7dbd65c..ed5e9d0a1285 100644
--- a/include/linux/regmap.h
+++ b/include/linux/regmap.h
@@ -112,7 +112,7 @@ struct reg_sequence {
112 * @cond: Break condition (usually involving @val) 112 * @cond: Break condition (usually involving @val)
113 * @sleep_us: Maximum time to sleep between reads in us (0 113 * @sleep_us: Maximum time to sleep between reads in us (0
114 * tight-loops). Should be less than ~20ms since usleep_range 114 * tight-loops). Should be less than ~20ms since usleep_range
115 * is used (see Documentation/timers/timers-howto.txt). 115 * is used (see Documentation/timers/timers-howto.rst).
116 * @timeout_us: Timeout in us, 0 means never timeout 116 * @timeout_us: Timeout in us, 0 means never timeout
117 * 117 *
118 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read 118 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
@@ -154,7 +154,7 @@ struct reg_sequence {
154 * @cond: Break condition (usually involving @val) 154 * @cond: Break condition (usually involving @val)
155 * @sleep_us: Maximum time to sleep between reads in us (0 155 * @sleep_us: Maximum time to sleep between reads in us (0
156 * tight-loops). Should be less than ~20ms since usleep_range 156 * tight-loops). Should be less than ~20ms since usleep_range
157 * is used (see Documentation/timers/timers-howto.txt). 157 * is used (see Documentation/timers/timers-howto.rst).
158 * @timeout_us: Timeout in us, 0 means never timeout 158 * @timeout_us: Timeout in us, 0 means never timeout
159 * 159 *
160 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read 160 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read