[PATCH] net: Add kerneldoc comment to napi_complete_done

Jonathan Neuschäfer posted 1 patch 2 years, 7 months ago
include/linux/netdevice.h | 9 +++++++++
1 file changed, 9 insertions(+)
[PATCH] net: Add kerneldoc comment to napi_complete_done
Posted by Jonathan Neuschäfer 2 years, 7 months ago
Document napi_complete_done, so that it shows up in HTML documentation.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 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
Re: [PATCH] net: Add kerneldoc comment to napi_complete_done
Posted by Jakub Kicinski 2 years, 7 months ago
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.
Re: [PATCH] net: Add kerneldoc comment to napi_complete_done
Posted by Jonathan Neuschäfer 2 years, 7 months ago
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