Skip to content

Commit c28d5c0

Browse files
mchehabpaulmckrcu
authored andcommitted
rcu: Get rid of some doc warnings in update.c
This commit escapes *ret, because otherwise the documentation system thinks that this is an incomplete emphasis block: ./kernel/rcu/update.c:65: WARNING: Inline emphasis start-string without end-string. ./kernel/rcu/update.c:65: WARNING: Inline emphasis start-string without end-string. ./kernel/rcu/update.c:70: WARNING: Inline emphasis start-string without end-string. ./kernel/rcu/update.c:82: WARNING: Inline emphasis start-string without end-string. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent ddc4659 commit c28d5c0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

kernel/rcu/update.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ module_param(rcu_normal_after_boot, int, 0);
6363
* rcu_read_lock_held_common() - might we be in RCU-sched read-side critical section?
6464
* @ret: Best guess answer if lockdep cannot be relied on
6565
*
66-
* Returns true if lockdep must be ignored, in which case *ret contains
66+
* Returns true if lockdep must be ignored, in which case ``*ret`` contains
6767
* the best guess described below. Otherwise returns false, in which
68-
* case *ret tells the caller nothing and the caller should instead
68+
* case ``*ret`` tells the caller nothing and the caller should instead
6969
* consult lockdep.
7070
*
71-
* If CONFIG_DEBUG_LOCK_ALLOC is selected, set *ret to nonzero iff in an
71+
* If CONFIG_DEBUG_LOCK_ALLOC is selected, set ``*ret`` to nonzero iff in an
7272
* RCU-sched read-side critical section. In absence of
7373
* CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
7474
* critical section unless it can prove otherwise. Note that disabling
@@ -82,7 +82,7 @@ module_param(rcu_normal_after_boot, int, 0);
8282
*
8383
* Note that if the CPU is in the idle loop from an RCU point of view (ie:
8484
* that we are in the section between rcu_idle_enter() and rcu_idle_exit())
85-
* then rcu_read_lock_held() sets *ret to false even if the CPU did an
85+
* then rcu_read_lock_held() sets ``*ret`` to false even if the CPU did an
8686
* rcu_read_lock(). The reason for this is that RCU ignores CPUs that are
8787
* in such a section, considering these as in extended quiescent state,
8888
* so such a CPU is effectively never in an RCU read-side critical section

0 commit comments

Comments
 (0)