| Message ID | 20240614032133.45365-3-yaoxt.fnst@fujitsu.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | check interleave capability | expand |
On Thu, Jun 13, 2024 at 11:21:32PM -0400, Yao Xingtao wrote: > Since the interleave capability check is supported, and this feature > depends on cxl_hdm, add cxl_hdm structure to the cxl driver API > documentation. > Hi Yao, I was hoping you were going to add the other missing files here, core/cdat.c and core/hdm.c If you don't we can pick them up another time. However, the new struct in Patch 1 doesn't have the kernel doc notation so this isn't picking up the cxl_hdm structure for the docs. -- Alison > Suggested-by: Dan Williams <dan.j.williams@intel.com> > Signed-off-by: Yao Xingtao <yaoxt.fnst@fujitsu.com> > --- > Documentation/driver-api/cxl/memory-devices.rst | 3 +++ > 1 file changed, 3 insertions(+) > > diff --git a/Documentation/driver-api/cxl/memory-devices.rst b/Documentation/driver-api/cxl/memory-devices.rst > index 5149ecdc53c7..e33ee67ac1a2 100644 > --- a/Documentation/driver-api/cxl/memory-devices.rst > +++ b/Documentation/driver-api/cxl/memory-devices.rst > @@ -325,6 +325,9 @@ CXL Memory Device > .. kernel-doc:: drivers/cxl/pci.c > :internal: > > +.. kernel-doc:: drivers/cxl/cxlmem.h > + :internal: > + > .. kernel-doc:: drivers/cxl/mem.c > :doc: cxl mem > > -- > 2.37.3 >
> -----Original Message----- > From: Alison Schofield <alison.schofield@intel.com> > Sent: Friday, June 14, 2024 12:47 PM > To: Yao, Xingtao/姚 幸涛 <yaoxt.fnst@fujitsu.com> > Cc: dave@stgolabs.net; jonathan.cameron@huawei.com; dave.jiang@intel.com; > vishal.l.verma@intel.com; ira.weiny@intel.com; dan.j.williams@intel.com; > jim.harris@samsung.com; linux-cxl@vger.kernel.org > Subject: Re: [PATCH v8 2/3] cxl: documentation: add cxlmem.h to cxl driver-api > > On Thu, Jun 13, 2024 at 11:21:32PM -0400, Yao Xingtao wrote: > > Since the interleave capability check is supported, and this feature > > depends on cxl_hdm, add cxl_hdm structure to the cxl driver API > > documentation. > > > > Hi Yao, > > I was hoping you were going to add the other missing files here, > core/cdat.c and core/hdm.c > > If you don't we can pick them up another time. sorry, I misunderstood what your request. I thought that these file will be added in another patch other than in this patch set. will add in next revision. > > However, the new struct in Patch 1 doesn't have the kernel doc > notation so this isn't picking up the cxl_hdm structure for the > docs. yes, that's a problem. > > -- Alison > > > > Suggested-by: Dan Williams <dan.j.williams@intel.com> > > Signed-off-by: Yao Xingtao <yaoxt.fnst@fujitsu.com> > > --- > > Documentation/driver-api/cxl/memory-devices.rst | 3 +++ > > 1 file changed, 3 insertions(+) > > > > diff --git a/Documentation/driver-api/cxl/memory-devices.rst > b/Documentation/driver-api/cxl/memory-devices.rst > > index 5149ecdc53c7..e33ee67ac1a2 100644 > > --- a/Documentation/driver-api/cxl/memory-devices.rst > > +++ b/Documentation/driver-api/cxl/memory-devices.rst > > @@ -325,6 +325,9 @@ CXL Memory Device > > .. kernel-doc:: drivers/cxl/pci.c > > :internal: > > > > +.. kernel-doc:: drivers/cxl/cxlmem.h > > + :internal: > > + > > .. kernel-doc:: drivers/cxl/mem.c > > :doc: cxl mem > > > > -- > > 2.37.3 > >
diff --git a/Documentation/driver-api/cxl/memory-devices.rst b/Documentation/driver-api/cxl/memory-devices.rst index 5149ecdc53c7..e33ee67ac1a2 100644 --- a/Documentation/driver-api/cxl/memory-devices.rst +++ b/Documentation/driver-api/cxl/memory-devices.rst @@ -325,6 +325,9 @@ CXL Memory Device .. kernel-doc:: drivers/cxl/pci.c :internal: +.. kernel-doc:: drivers/cxl/cxlmem.h + :internal: + .. kernel-doc:: drivers/cxl/mem.c :doc: cxl mem
Since the interleave capability check is supported, and this feature depends on cxl_hdm, add cxl_hdm structure to the cxl driver API documentation. Suggested-by: Dan Williams <dan.j.williams@intel.com> Signed-off-by: Yao Xingtao <yaoxt.fnst@fujitsu.com> --- Documentation/driver-api/cxl/memory-devices.rst | 3 +++ 1 file changed, 3 insertions(+)