Commit 1445e917 authored May 07, 2018 by Mauro Carvalho Chehab Committed by Paul E. McKenney Jul 12, 2018

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>

parent 07f27570

include/linux/rcupdate.h

+2 −3

Original line number	Diff line number	Diff line
		@@ -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)

Admin message