On Thu, 2013-12-19 at 15:19 -0800, Darren Hart wrote: > On Thu, 2013-12-19 at 15:05 -0800, Randy Dunlap wrote: > > On 12/19/13 13:07, Darren Hart wrote: > > > On Thu, 2013-12-19 at 13:00 -0800, Davidlohr Bueso wrote: > > >> On Thu, 2013-12-19 at 12:51 -0800, Randy Dunlap wrote: > > >>> On 12/19/13 12:45, Davidlohr Bueso wrote: > > >>>> From: Thomas Gleixner <[email protected]> > > >>>> > > >>>> That's essential, if you want to hack on futexes. > > >>>> > > >>>> Cc: Ingo Molnar <[email protected]> > > >>>> Cc: Darren Hart <[email protected]> > > >>>> Acked-by: Peter Zijlstra <[email protected]> > > >>>> Cc: Thomas Gleixner <[email protected]> > > >>>> Cc: Paul E. McKenney <[email protected]> > > >>>> Cc: Mike Galbraith <[email protected]> > > >>>> Cc: Jeff Mahoney <[email protected]> > > >>>> Cc: Linus Torvalds <[email protected]> > > >>>> Cc: Scott Norton <[email protected]> > > >>>> Cc: Tom Vaden <[email protected]> > > >>>> Cc: Aswin Chandramouleeswaran <[email protected]> > > >>>> Cc: Waiman Long <[email protected]> > > >>>> Cc: Jason Low <[email protected]> > > >>>> Signed-off-by: Thomas Gleixner <[email protected]> > > >>>> Signed-off-by: Davidlohr Bueso <[email protected]> > > >>>> --- > > >>>> kernel/futex.c | 57 > > >>>> +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ > > >>>> 1 file changed, 57 insertions(+) > > >>>> > > >>>> diff --git a/kernel/futex.c b/kernel/futex.c > > >>>> index 577481d..af1fc31 100644 > > >>>> --- a/kernel/futex.c > > >>>> +++ b/kernel/futex.c > > >>>> @@ -69,6 +69,63 @@ > > >>>> > > >>>> #include "locking/rtmutex_common.h" > > >>>> > > >>>> +/* > > >>>> + * Basic futex operation and ordering guarantees: > > >>>> + * > > >>>> + * The waiter reads the futex value in user space and calls > > >>>> + * futex_wait(). It computes the hash bucket and acquires the hash > > >>> > > >>> does It > > >>> refer to "the waiter" or to futex_wait()? > > >>> I read it as referring to the waiter, but ISTM that the comments are > > >>> using It > > >>> to refer to futex_wait()... ??? > > >>> > > >> > > >> Yes, it refers to futex_wait(), which IMO in a futex context is pretty > > >> clear. > > > > > > > > > Agreed. > > > > > > > > > > I'll just have to get by with disagreeing with both of you then. > > I say that the pronoun's antecedent is ambiguous (unclear). > > > > You are correct from a purely grammatical perspective, no argument > there. I just feel that the comment is clear enough from the context - > although perhaps people that hack on futexes should be excluded from > having an opinion here as we are biased :-) > > If Davidlohr is going to resubmit for other reasons, then by all means, > please correct this per Randy's suggestion - I just didn't want to put > him (Davidlohr ;-) through another round of patches for this alone. > > Thanks for ensuring our docs are as clear as possible Randy!
Absolutely. I've found that we have the same grammatical error when describing futex_wake() as well, so I've updated the doc to say "This function" instead of "It". Thanks, Davidlohr -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
