Subject: [PATCH 2/2] ARM: cpuidle: Document the code

From: [email-masked] (Lorenzo Pieralisi)
Date: Tue, 24 Mar 2015 19:04:05 +0000

On Tue, Mar 24, 2015 at 06:51:44PM +0000, Lorenzo Pieralisi wrote:
> On Tue, Mar 24, 2015 at 09:54:02AM +0000, Daniel Lezcano wrote:

[...]

> > +/*
> > + * arm_cpuidle_init() - Initialize cpuidle_ops for a specific cpu
> > + * @cpu: the cpu to be initialized
> > + *
> > + * Initialize the cpuidle ops with the device for the cpu and then call
> > + * the cpu's idle initialization callback. This may fail if the underlying HW
> > + * is not operational.
> > + *
> > + * Returns:
> > + *  0 on success,
> > + *  -ENODEV if it fails to find the cpu node in the device tree,
> > + *  -EOPNOTSUPP if it does not find a registered cpuidle_ops for this cpu,
> > + *  -ENOENT if it fails to find a enabled-method property,
> 
> Ultra-nit: "an enabled-method"

Bah, I cannot see the wood for the trees anymore. "an enable-method".

Lorenzo