Re: [PATCH v3 01/24] mm: enhance region_is_ram() to region_intersects()

Luis R. Rodriguez
2015-07-30T21:10:30Z

On Thu, Jul 30, 2015 at 01:59:20PM -0700, Dan Williams wrote:
> On Thu, Jul 30, 2015 at 1:54 PM, Luis R. Rodriguez <mcgrof@suse.com> wrote:
> > On Thu, Jul 30, 2015 at 01:44:44PM -0700, Dan Williams wrote:
> >> On Thu, Jul 30, 2015 at 1:42 PM, Luis R. Rodriguez <mcgrof@suse.com> wrote:
> >> > On Thu, Jul 30, 2015 at 12:53:45PM -0400, Dan Williams wrote:
> >> >> diff --git a/include/linux/mm.h b/include/linux/mm.h
> >> >> index 2e872f92dbac..84b05ebedb2d 100644
> >> >> --- a/include/linux/mm.h
> >> >> +++ b/include/linux/mm.h
> >> >> @@ -369,7 +369,14 @@ static inline int put_page_unless_one(struct page *page)
> >> >> }
> >> >>
> >> >> extern int page_is_ram(unsigned long pfn);
> >> >> -extern int region_is_ram(resource_size_t phys_addr, unsigned long size);
> >> >> +
> >> >> +enum {
> >> >> + REGION_INTERSECTS,
> >> >> + REGION_DISJOINT,
> >> >> + REGION_MIXED,
> >> >> +};
> >> >> +
> >> >
> >> > Can you Kdoc'ify this? Part of the reason for the enum request was this
> >> > could be then documented really well. The helper is documented but here
> >> > you can go into more detail about each region intersection.
> >>
> >> Given region_intersects() has its own kdoc I'd probably just say "See
> >> region_intersects() for details".
> >
> > With the kdoc in place in the enum you'd kick people to elaborate when
> > extending the enums, whereas without this you'd hope they do it. With
> > the enum in place you can also be more verbose.
> >
>
> Care to send a patch on what you are thinking? I wasn't planning on
> this enum growing any other entries.

I mean something like this:

/**
* enum region_intersect_type
*
* @REGION_INTERSECTS: explain and you you can go into any elaborate
* detail as you wish.
* @REGION_DISJOINT: explain
* @REGION_MIXED: explain
*/
enum region_intersect_type {
REGION_INTERSECTS,
REGION_DISJOINT,
REGION_MIXED,
};

Luis