* [PATCH] net: Add kerneldoc comment to napi_complete_done
@ 2023-01-29 13:26 Jonathan Neuschäfer
2023-01-31 2:26 ` Jakub Kicinski
0 siblings, 1 reply; 3+ messages in thread
From: Jonathan Neuschäfer @ 2023-01-29 13:26 UTC (permalink / raw)
To: netdev
Cc: Jonathan Neuschäfer, David S. Miller, Eric Dumazet,
Jakub Kicinski, Paolo Abeni, linux-kernel
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] net: Add kerneldoc comment to napi_complete_done
2023-01-29 13:26 [PATCH] net: Add kerneldoc comment to napi_complete_done Jonathan Neuschäfer
@ 2023-01-31 2:26 ` Jakub Kicinski
2023-01-31 20:54 ` Jonathan Neuschäfer
0 siblings, 1 reply; 3+ messages in thread
From: Jakub Kicinski @ 2023-01-31 2:26 UTC (permalink / raw)
To: Jonathan Neuschäfer
Cc: netdev, David S. Miller, Eric Dumazet, Paolo Abeni, linux-kernel
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.
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] net: Add kerneldoc comment to napi_complete_done
2023-01-31 2:26 ` Jakub Kicinski
@ 2023-01-31 20:54 ` Jonathan Neuschäfer
0 siblings, 0 replies; 3+ messages in thread
From: Jonathan Neuschäfer @ 2023-01-31 20:54 UTC (permalink / raw)
To: Jakub Kicinski
Cc: Jonathan Neuschäfer, netdev, David S. Miller, Eric Dumazet,
Paolo Abeni, linux-kernel
[-- Attachment #1: Type: text/plain, Size: 508 bytes --]
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
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-01-31 20:55 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-01-29 13:26 [PATCH] net: Add kerneldoc comment to napi_complete_done Jonathan Neuschäfer
2023-01-31 2:26 ` Jakub Kicinski
2023-01-31 20:54 ` Jonathan Neuschäfer
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).