Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751473AbbG3VKa (ORCPT ); Thu, 30 Jul 2015 17:10:30 -0400 Received: from mx2.suse.de ([195.135.220.15]:36986 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750734AbbG3VK3 (ORCPT ); Thu, 30 Jul 2015 17:10:29 -0400 Date: Thu, 30 Jul 2015 23:10:26 +0200 From: "Luis R. Rodriguez" To: Dan Williams Cc: Thomas Gleixner , Ingo Molnar , "H. Peter Anvin" , linux-arch@vger.kernel.org, "Kani, Toshimitsu" , "linux-nvdimm@lists.01.org" , "linux-kernel@vger.kernel.org" , Russell King , Christoph Hellwig , "linux-arm-kernel@lists.infradead.org" Subject: Re: [PATCH v3 01/24] mm: enhance region_is_ram() to region_intersects() Message-ID: <20150730211026.GR30479@wotan.suse.de> References: <20150730165155.33962.64121.stgit@dwillia2-desk3.amr.corp.intel.com> <20150730165345.33962.80299.stgit@dwillia2-desk3.amr.corp.intel.com> <20150730204249.GN30479@wotan.suse.de> <20150730205449.GO30479@wotan.suse.de> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.21 (2010-09-15) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2151 Lines: 59 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 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 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 -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/