Re: [PATCH 10/18] rcu: rcupdate.h: get rid of Sphinx warnings at rcu_pointer_handoff()

Paul E. McKenney
2018-05-07T14:22:09Z

On Mon, May 07, 2018 at 06:35:46AM -0300, Mauro Carvalho Chehab wrote:
> 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.
>
> Change it to a code-block.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Acked-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>

If you don't tell me otherwise, I will assume that you are pushing this.
If you would rather that I take it, please let me know!

Thanx, Paul

> ---
> include/linux/rcupdate.h | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h
> index 36360d07f25b..c890d10978fa 100644
> --- a/include/linux/rcupdate.h
> +++ b/include/linux/rcupdate.h
> @@ -568,8 +568,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);
> @@ -580,7 +580,6 @@ static inline void rcu_preempt_sleep_check(void) { }
> * p = rcu_pointer_handoff(p);
> * }
> * rcu_read_unlock();
> - *``
> */
> #define rcu_pointer_handoff(p) (p)
>
> --
> 2.17.0
>