Re: time_is_after_jiffies misnomer

[Johannes Weiner]

On Tue, Dec 16, 2008 at 04:17:30PM +0100, Peter T. Breuer wrote:
> "Also sprach Johannes Weiner:"
> > On Tue, Dec 16, 2008 at 12:31:41PM +0100, Peter T. Breuer wrote:
> > > 
> > > I thought at first that
> > > 
> > >     time_is_after_jiffies(foo)
> > > 
> > > meant that the current time is later than foo jiffies.
> > 
> > 'foo jiffies'?
> 
> 
> ?? What does that mean? Yes, "the current time is later than foo
> jiffies", is what I wrote. I don't understand why you query it. What I
> wrote is a perfectly normal english sentence. It means "if the current
> time is X and and the 

Sorry, I forgot to remove that when I realized you were referring to
jiffies as a unit here.  Don't worry, I got it.

> > It behaves like all the other time_(after|before) macros.  "Compare a
> > given time T against some other time X".
> 
> It's poor english. Yes, to an english speaker
> 
>    time_is_after_jiffies(foo)
> 
> looks like
> 
>    the current time is later than foo jiffies
> 
> Look at the two:
> 
>    the current time is later than foo jiffies
>                  |   |  |           `/.
>                time_is_after_jiffies(foo)

The only problem I see is the `is'.  It should be called

	time_after_jiffies()

But time doesn't refer to `the current time' in the first place!  The
macro is not (meant to be) an English sentence.

'time' is the prefix for a group of symbols, a namespace if you will
and it stands for the first argument in all these macros. 'is_after'
is the relation.  'jiffies' the thing you compare with.  It's an infix
operator used in prefix form.

The only problem that I see with the jiffies-comparing macros is the
`is'.  They should be called time_after_jiffies() and
time_before_jiffies() etc.

> (I AM a native english speaker, and a very good one - please take this
> on board and pay attention to it; you'll find me quoted as the author
> of hundreds of technical articles on google :-).

They are probably written in a natural language.

> The mathematical "jiffies(foo)" for colloquial "foo jiffies" is the
> normal way of writing formal predicates.  Like "colour(red)" for
> "red colour". This is a predicate.

I don't think there are many functions/macros in the (core-)kernel
that have the types they operate on encoded in their names.

So interpreting the macro the way you did makes no sense to me
regarding the code in context.

> > The banner comment above the macro group should have clarified the
> > misunderstanding, btw.
> 
> No, it says nothing:
> 
>   * These four macros compare jiffies and 'a' for convenience.
> 
> What's written above the individual macros is more explanatory, but
> it's the NAMES of the macros that are the wrong way round for english:
> 
>   
>   /* time_is_before_jiffies(a) return true if a is before jiffies */
>   #define time_is_before_jiffies(a) time_after(jiffies, a)
> 
> It's time_is_before_jiffies(foo) that reads the wrong way round in
> english. It should be
> 
> 
>      current_time_is_after_jiffies(foo).

How would you name the existing time_after() then?

	Hannes
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/