memblock: Document memblock_is_region_{memory,reserved}()
authorStephen Boyd <sboyd@codeaurora.org>
Thu, 24 May 2012 07:45:21 +0000 (00:45 -0700)
committerIngo Molnar <mingo@kernel.org>
Fri, 8 Jun 2012 09:59:46 +0000 (11:59 +0200)
commiteab309494ae2b9e15f85520f00de3893162c2e43
treedd0b7ae9b455e9b999665dc8dbcd51679fdade70
parent8a173b1476d126674104c7c5c6cef0bcd824b001
memblock: Document memblock_is_region_{memory,reserved}()

At first glance one would think that memblock_is_region_memory()
and memblock_is_region_reserved() would be implemented in the
same way. Unfortunately they aren't and the former returns
whether the region specified is a subset of a memory bank while
the latter returns whether the region specified intersects with
reserved memory.

Document the two functions so that users aren't tempted to
make the implementation the same between them and to clarify the
purpose of the functions.

Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
Cc: Tejun Heo <tj@kernel.org>
Link: http://lkml.kernel.org/r/1337845521-32755-1-git-send-email-sboyd@codeaurora.org
Signed-off-by: Ingo Molnar <mingo@kernel.org>
mm/memblock.c