diff options
| author |   Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2018-05-07 06:35:46 -0300 |
|---|---|---|
| committer |   Paul E. McKenney <paulmck@linux.vnet.ibm.com> | 2018-07-12 15:39:12 -0700 |
| commit | 1445e9175bead409bb9930f3c745246a09f22cf6 (patch) | |
| tree | beee4b5c1577bb583c4d43402e7573b04875610e /include/linux/rcupdate.h | |
| parent | rcu: Improve rcu_note_voluntary_context_switch() reporting (diff) | |
| download | wireguard-linux-1445e9175bead409bb9930f3c745246a09f22cf6.tar.xz wireguard-linux-1445e9175bead409bb9930f3c745246a09f22cf6.zip | |
rcu: rcupdate.h: Get rid of Sphinx warnings at rcu_pointer_handoff()
The code example at rcupdate.h currently produce lots of warnings:
./include/linux/rcupdate.h:572: WARNING: Unexpected indentation.
./include/linux/rcupdate.h:576: WARNING: Unexpected indentation.
./include/linux/rcupdate.h:580: WARNING: Block quote ends without a blank line; unexpected unindent.
./include/linux/rcupdate.h:582: WARNING: Block quote ends without a blank line; unexpected unindent.
./include/linux/rcupdate.h:582: WARNING: Inline literal start-string without end-string.
This commit therefore changes it to a code-block.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Diffstat (limited to 'include/linux/rcupdate.h')
| -rw-r--r-- | include/linux/rcupdate.h | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h index 5cab15e7ec83..dacc90358b33 100644 --- a/include/linux/rcupdate.h +++ b/include/linux/rcupdate.h @@ -566,8 +566,8 @@ static inline void rcu_preempt_sleep_check(void) { } * This is simply an identity function, but it documents where a pointer * is handed off from RCU to some other synchronization mechanism, for * example, reference counting or locking. In C11, it would map to - * kill_dependency(). It could be used as follows: - * `` + * kill_dependency(). It could be used as follows:: + * * rcu_read_lock(); * p = rcu_dereference(gp); * long_lived = is_long_lived(p); @@ -578,7 +578,6 @@ static inline void rcu_preempt_sleep_check(void) { } * p = rcu_pointer_handoff(p); * } * rcu_read_unlock(); - *`` */ #define rcu_pointer_handoff(p) (p) |