2023-01-29 13:26:46

by Jonathan Neuschäfer

[permalink] [raw]
Subject: [PATCH] net: Add kerneldoc comment to napi_complete_done

Document napi_complete_done, so that it shows up in HTML documentation.

Signed-off-by: Jonathan Neuschäfer <[email protected]>
---
include/linux/netdevice.h | 9 +++++++++
1 file changed, 9 insertions(+)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index aad12a179e540..828e58791baa1 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -504,7 +504,16 @@ static inline bool napi_reschedule(struct napi_struct *napi)
return false;
}

+/**
+ * napi_complete_done - NAPI processing complete
+ * @n: NAPI context
+ * @work_done: The number of packets that were processed
+ *
+ * Mark NAPI processing as complete.
+ * Return false if device should avoid rearming interrupts.
+ */
bool napi_complete_done(struct napi_struct *n, int work_done);
+
/**
* napi_complete - NAPI processing complete
* @n: NAPI context
--
2.39.0



2023-01-31 02:26:28

by Jakub Kicinski

[permalink] [raw]
Subject: Re: [PATCH] net: Add kerneldoc comment to napi_complete_done

On Sun, 29 Jan 2023 14:26:18 +0100 Jonathan Neuschäfer wrote:
> Document napi_complete_done, so that it shows up in HTML documentation.

> diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
> index aad12a179e540..828e58791baa1 100644
> --- a/include/linux/netdevice.h
> +++ b/include/linux/netdevice.h

Please put the doc in the source file, rather than the header.


2023-01-31 20:55:04

by Jonathan Neuschäfer

[permalink] [raw]
Subject: Re: [PATCH] net: Add kerneldoc comment to napi_complete_done

On Mon, Jan 30, 2023 at 06:26:22PM -0800, Jakub Kicinski wrote:
> On Sun, 29 Jan 2023 14:26:18 +0100 Jonathan Neuschäfer wrote:
> > Document napi_complete_done, so that it shows up in HTML documentation.
>
> > diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
> > index aad12a179e540..828e58791baa1 100644
> > --- a/include/linux/netdevice.h
> > +++ b/include/linux/netdevice.h
>
> Please put the doc in the source file, rather than the header.

Will do.

Thanks,
Jonathan


Attachments:
(No filename) (493.00 B)
signature.asc (833.00 B)
Download all attachments