History

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.

Mauro Carvalho Chehab committed 7 years ago

Commit 458f69e1 parent 4ca9bc214 files · +84 −43Browse files

Showing the changes to include/linux (2 of 14 files). Show all

Unified · Split

2 files
  1. include/linux/iopoll.h +2 −2
  2. include/linux/regmap.h +2 −2
include/linux/iopoll.h+2−2
@@ -21,7 +21,7 @@ · 20 unmodified lines
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 (022 * @sleep_us: Maximum time to sleep between reads in us (0
23 * tight-loops). Should be less than ~20ms since usleep_range23 * 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 timeout25 * @timeout_us: Timeout in us, 0 means never timeout
26 *26 *
27 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either27 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
@@ -60,7 +60,7 @@ · 32 unmodified lines
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). Should61 * @delay_us: Time to udelay between reads in us (0 tight-loops). Should
62 * be less than ~10us since udelay is used (see62 * 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 timeout64 * @timeout_us: Timeout in us, 0 means never timeout
65 *65 *
66 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either66 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
include/linux/regmap.h+2−2
@@ -112,7 +112,7 @@ struct reg_sequence { · 111 unmodified lines
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 (0113 * @sleep_us: Maximum time to sleep between reads in us (0
114 * tight-loops). Should be less than ~20ms since usleep_range114 * 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 timeout116 * @timeout_us: Timeout in us, 0 means never timeout
117 *117 *
118 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read118 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
@@ -154,7 +154,7 @@ struct reg_sequence { · 35 unmodified lines
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 (0155 * @sleep_us: Maximum time to sleep between reads in us (0
156 * tight-loops). Should be less than ~20ms since usleep_range156 * 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 timeout158 * @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_read160 * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t