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

[Ingo Molnar]

* Toshi Kani <toshi.kani@xxxxxx> 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. 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.)

> There is no functinal change in this patch.

Typo.

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

s/with a/with

> + * 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.


> +/**
> + * 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).

Thanks,

	Ingo
--
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/