Re: [PATCH 1/3] mm, x86: Document return values of mapping funcs

[Toshi Kani <toshi.kani@hp.com>]

On Wed, 2015-03-11 at 06:30 +0000, Ingo Molnar wrote:
> * Toshi Kani <toshi.kani@hp.com> wrote:
> 
> > Documented the return values of KVA mapping functions,
> > pud_set_huge(), pmd_set_huge, pud_clear_huge() and
> > pmd_clear_huge().
> > 
> > Simplified the conditions to select HAVE_ARCH_HUGE_VMAP
> > in Kconfig since X86_PAE depends on X86_32.
> 
> Changelogs are not a diary, they are a story, generally written in the 
> present tense. 

Oh, I see. Thanks for the tip!

> So it should be something like:
> 
>   Document the return values of KVA mapping functions,
>   pud_set_huge(), pmd_set_huge, pud_clear_huge() and
>   pmd_clear_huge().
> 
>   Simplify the conditions to select HAVE_ARCH_HUGE_VMAP
>   in the Kconfig, since X86_PAE depends on X86_32.
> 
> (also note the slight fixes I made to the text.)

Updated with the descriptions above.

> > There is no functinal change in this patch.
> 
> Typo.

Fixed.

> > +/**
> > + * pud_set_huge - setup kernel PUD mapping
> > + *
> > + * MTRRs can override PAT memory types with a 4KB granularity.  Therefore,
> 
> s/with a/with

Fixed.

> > + * it does not set up a huge page when the range is covered by non-WB type
> > + * of MTRRs.  0xFF indicates that MTRRs are disabled.
> > + *
> > + * Return 1 on success, and 0 on no-operation.
> 
> What is a 'no-operation'?
> 
> I suspect you want:
> 
>     * Returns 1 on success, and 0 when no PUD was set.

Yes, that's what it meant to say.

> > +/**
> > + * pmd_set_huge - setup kernel PMD mapping
> > + *
> > + * MTRRs can override PAT memory types with a 4KB granularity.  Therefore,
> > + * it does not set up a huge page when the range is covered by non-WB type
> > + * of MTRRs.  0xFF indicates that MTRRs are disabled.
> > + *
> > + * Return 1 on success, and 0 on no-operation.
> 
> Ditto (and the rest of the patch).

Updated all functions. I changed pud_clear_huge()'s description to:  

 * Return 1 on success, and 0 when no PUD map was found.

Thanks!
-Toshi