Re: [Qemu-devel] [PATCH v3 23/32] nvdimm: build ACPI NFIT table

[Xiao Guangrong]

On 10/13/2015 01:42 PM, Michael S. Tsirkin wrote:
> On Tue, Oct 13, 2015 at 01:13:18PM +0800, Xiao Guangrong wrote:
> > > >   #endif
> > >
> > > This header is too small to be worth it.
> > > nvdimm_get_built_list seems to be the only interface -
> > > just stick it in the header you have under include.
> >
> > Other functions are introudced and included into it in later patches,
> > it includes the internal things shared between nvdimm device, nvdimm ACPI,
> > nvdimm namespace.
> >
> > Furthermore, this is a internal include file, it is not bad i think.
>
> Each time we do this, this seems to invite abuse where
> people add APIs without documenting them.

Understood.

> I guess I could buy this if you add nvdimm_defs.h
> with just internal things such as layout of the buffer
> used for communication between ACPI and hardware.

Okay, i will rename internel.h to nvdimm_defs.h and carefully document
everything (definitions, function prototypes, etc.) in this file. :)