| Message ID | 20230130153437.3153-1-Jonathan.Cameron@huawei.com |
|---|---|
| State | Accepted |
| Commit | 7ebf38c9115ec3b4502c73b4377a7648374d700f |
| Headers | show |
| Series | cxl/mbox: Add missing parameter to docs. | expand |
On 1/30/23 8:34 AM, Jonathan Cameron wrote: > Kernel-doc should be complete, so add documentation for the status > parameter. > > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Reviewed-by: Dave Jiang <dave.jiang@intel.com> > > --- > Fixes ("cxl/mem: Read, trace, and clear events on driver load") > > Bad fixes tag is deliberate as patch is currently only in the cxl/pending > branch. Feel free to squash this or drop the fixes entirely. > > I'm odd and for various reasons run W=1 builds. The resulting > warning has been irritating me, hence the fixlet. > --- > drivers/cxl/core/mbox.c | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/drivers/cxl/core/mbox.c b/drivers/cxl/core/mbox.c > index a0bd2170af48..03909b6cef55 100644 > --- a/drivers/cxl/core/mbox.c > +++ b/drivers/cxl/core/mbox.c > @@ -913,6 +913,7 @@ static void cxl_mem_get_records_log(struct cxl_dev_state *cxlds, > /** > * cxl_mem_get_event_records - Get Event Records from the device > * @cxlds: The device data for the operation > + * @status: Event Status register value identifying which events are available. > * > * Retrieve all event records available on the device, report them as trace > * events, and clear them.
Jonathan Cameron wrote: > Kernel-doc should be complete, so add documentation for the status > parameter. > > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> > > --- > Fixes ("cxl/mem: Read, trace, and clear events on driver load") > > Bad fixes tag is deliberate as patch is currently only in the cxl/pending > branch. Feel free to squash this or drop the fixes entirely. > > I'm odd and for various reasons run W=1 builds. The resulting > warning has been irritating me, hence the fixlet. I appreciate it, looks good.
diff --git a/drivers/cxl/core/mbox.c b/drivers/cxl/core/mbox.c index a0bd2170af48..03909b6cef55 100644 --- a/drivers/cxl/core/mbox.c +++ b/drivers/cxl/core/mbox.c @@ -913,6 +913,7 @@ static void cxl_mem_get_records_log(struct cxl_dev_state *cxlds, /** * cxl_mem_get_event_records - Get Event Records from the device * @cxlds: The device data for the operation + * @status: Event Status register value identifying which events are available. * * Retrieve all event records available on the device, report them as trace * events, and clear them.
Kernel-doc should be complete, so add documentation for the status parameter. Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> --- Fixes ("cxl/mem: Read, trace, and clear events on driver load") Bad fixes tag is deliberate as patch is currently only in the cxl/pending branch. Feel free to squash this or drop the fixes entirely. I'm odd and for various reasons run W=1 builds. The resulting warning has been irritating me, hence the fixlet. --- drivers/cxl/core/mbox.c | 1 + 1 file changed, 1 insertion(+)