| Message ID | 20230129132618.1361421-1-j.neuschaefer@gmx.net |
|---|---|
| State | New |
| Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:adf:eb09:0:0:0:0:0 with SMTP id s9csp1746415wrn;
Sun, 29 Jan 2023 05:36:43 -0800 (PST)
X-Google-Smtp-Source:
AK7set+ykXo1w5mdixrbZ/7RGiNxATfLTkBfjnQtRhdkdzBzGzI4FV1usKznJI3JDmccVdLYjrc0
X-Received: by 2002:a05:6a21:6d9b:b0:bc:5d69:754f with SMTP id
wl27-20020a056a216d9b00b000bc5d69754fmr10594507pzb.18.1674999403601;
Sun, 29 Jan 2023 05:36:43 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1674999403; cv=none;
d=google.com; s=arc-20160816;
b=J04KRIsFXwc0O1cVEiUImltpFVFux2v3JshGVKvEXRL3itA1to4DAh8zuTbVq6iSwo
MsJNff27A+LaqSyokOQdBFle0UhhWVzQZSmf9evq+yaGK0SfbsizApxcosuoGk7Hidmz
igr0ZFzI8EarCUtynybCEn2kggEGatfzQvJ6hZY0fnwl2WG2kV6WYXCA4nqFPAS2i7vt
7K8ZvhhPM3M04FE1ckFJB7vMJJfQd8lo0LXixRiEhdc55AIZx84xzZ5Vv0qtVWZi4sfh
AVzaCLO+Lz8FR6M4/LYyPqIw3Tfo+HjHvRFSmjRKvwJEY15J5gYR5fjboF0rqrernX7e
qSWw==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=list-id:precedence:ui-outboundreport:content-transfer-encoding
:mime-version:message-id:date:subject:cc:to:from:dkim-signature;
bh=iIrf/aNdbeza6tzcHDT7SdlwfQHfh+Ya7vn+DqBOQgc=;
b=HaZbfq00JDZjqDwH1dD9gCnhce/EJKat1kBlGdhmIyjKpBwnh4zep9a/q8r419HXNY
amsbpSXL0A8Alx+/szmS6G0Ewja1UwItJQ2NQ50pVRMCOyuJsAasH6sxy03+rQIMcSom
Nq0G9OYR+OwPucrdxOwt7LS68yf/x8X/OyGyOewdOll47HwyzgGAZu179M13ZHgowSps
y6bMIQOauZ+C7Ntk+i6qmecSwH4NrsFL44JnOdnOi+PaQjvkj7ljGHmA6qAs1TjbrVYU
x8uESLejXqjHLpQst2koqPyPFBx3U1OYPpVy7hONu1d89TINwlzgb4LDoRzJW2R92Iiq
cSKQ==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@gmx.net header.s=s31663417 header.b=WsuuQRcw;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmx.net
Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20])
by mx.google.com with ESMTP id
q78-20020a632a51000000b004791644f520si10011362pgq.437.2023.01.29.05.36.30;
Sun, 29 Jan 2023 05:36:43 -0800 (PST)
Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
client-ip=2620:137:e000::1:20;
Authentication-Results: mx.google.com;
dkim=pass header.i=@gmx.net header.s=s31663417 header.b=WsuuQRcw;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmx.net
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
id S234991AbjA2N0h (ORCPT <rfc822;n2h9z4@gmail.com> + 99 others);
Sun, 29 Jan 2023 08:26:37 -0500
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52342 "EHLO
lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
with ESMTP id S229990AbjA2N0f (ORCPT
<rfc822;linux-kernel@vger.kernel.org>);
Sun, 29 Jan 2023 08:26:35 -0500
Received: from mout.gmx.net (mout.gmx.net [212.227.17.21])
by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1FCCB1A4AB;
Sun, 29 Jan 2023 05:26:33 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=s31663417;
t=1674998783; bh=Q38jMOkyWKuY/IpUMNAkzzPVXDAh+9+tfSo0XYhWNbY=;
h=X-UI-Sender-Class:From:To:Cc:Subject:Date;
b=WsuuQRcwAyRTxn/Ci+eBs6DlpQl9lqZoYI7wOFJAxV/aMtjRchMPzPDr+vhe3MGwo
YV8OZw1AYt3Wzgzzq++rQqtRfkJPQU9FYPJ6x4K1gLouoUyLJuTB+yS8w0dabNcVM6
rFeE5c9MwMTt6VM7yHCE5iRYHWD9tTNCnTXKeFB9jEpYtrHJserkZ5nRfNxt+MR8IB
VufOPITZKWO53VveMJo1VrTQY2p0NmRPxA4LUBGxgeryslFzwskKGEbM/OLQuynJ4Y
gaGKFk3ROg+ez9XssidbXAwNUSEaE5GSLpqOh0+QMOlaweIA25u9ngmGW5CMqj4JXG
xEzHlTshDgYYA==
X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a
Received: from probook ([95.223.44.193]) by mail.gmx.net (mrgmx104
[212.227.17.168]) with ESMTPSA (Nemesis) id 1MD9XF-1pVA6g0ZAf-0099Fv; Sun, 29
Jan 2023 14:26:23 +0100
From: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>
To: netdev@vger.kernel.org
Cc: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>,
"David S. Miller" <davem@davemloft.net>, Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
linux-kernel@vger.kernel.org
Subject: [PATCH] net: Add kerneldoc comment to napi_complete_done
Date: Sun, 29 Jan 2023 14:26:18 +0100
Message-Id: <20230129132618.1361421-1-j.neuschaefer@gmx.net>
X-Mailer: git-send-email 2.39.0
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
X-Provags-ID: V03:K1:QiC9h5jojdZvzGtSfUVkexs965laYcCfzf2bsW2PJpmdr2c7w6I
i11be65HERuHkzytqsUz9guku7VZy2W2bLzNtORAvwwwB6SFa+cubMHB6NiR7N88H6y7hxD
wv0f9JoTik44rQX7gJ6HP1SfB2916gjJI5lHNyxFMR6Gf7gawT/Nq+BPU4BEWJdrwWhVa/D
pmAOn3WYwMXvAXZvpQGKQ==
UI-OutboundReport: notjunk:1;M01:P0:iJySu1Rp10g=;8+B9zMuSrQRw8DXU7ruOAwdHFub
bEbsnG6DRaK29GidFPnBl6nukhaCgkq1kiqHp1Me6nwNCxNKmwgGwWHlGKWvg15EmdGA4I54m
AEaRXwy1mbkdjt9g2HIicuJL8/SpKOnfVbTZM8IZtdv93U4/kwJDYfVm2zLf6I4tiPRT+52up
e1+FTh4o6RM9apNAy13+k5dOFV/gxEh2aG73NiWyE8lRhAyWpkXviRPPZaCC7kbUqFsJEeBTd
uySh16CXLsnxfkIP2rvViFx+DfEYxUu/OzGUke+aZ8f5uN5AiNORUwoYRt/rCPrCVeiEA00Vu
kUzrRqi0A+dqYqPolMJXsNe3f6IsOebpf0Y0lLHbPSnGt9biiBwlbPDzNuWlKLJdLxLv5IX0l
SmqrBPE6MIxnm2BpznAcn0MfZ8CnnJxIreSo8EBueMhF//Lu+7fnI7/4yJneSjHx4+jmMVHYl
RDKVu1VAcyKsEcyLktcX4sYjpOHIcEtsR/+5OCXLuXzohWoj9IP33tr3b3K3eqACy+FPXaUeW
vY+/5kT801RhengEYaLutu9PDPwn9ckDPN5eIjd2kQF/ZsSDnoSq8Z1tMXJu2iRYZFnDmwW9o
IeboZ9uxUCJ0rujyboFLSo+2vXadnlnjgQL4tSd/a1qxsQ4VOloXiY39cbcGdIAelq8blgZsR
1Hx3gs3wqBO4n/eWQ7E7PtngUEljOWVcGEGW7VcUhmR+cRzQ0rJC1DikWemiFssV0m8OKKLUn
G67fFg3Gl3mL2L2O6uz8UuTtqDQO8zJIeVeGun3X3F6RgFAwcoV82Qzmqnv4IDnzlLu6wzgzd
YGMqA+xoEnOKTGpXf7N2iJU8Me6q+aQwCImT8G278jGgUhKAMYsTP3rcmF6S6nSrp8SckbcfF
m/ai4CmFqgFX+EalRIDE5O2QLGhCBNPOaUXDMdVEYUJ252nwpeBWW4s5RegB15DCtOzq8MIhA
71J74X7FJjDJ21eaCFGOugsp+jA=
X-Spam-Status: No, score=0.5 required=5.0 tests=BAYES_00,DKIM_SIGNED,
DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,
RCVD_IN_MSPIKE_H2,RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS autolearn=no
autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?=
X-GMAIL-THRID: =?utf-8?q?1756364174744501407?=
X-GMAIL-MSGID: =?utf-8?q?1756364174744501407?=
|
| Series |
net: Add kerneldoc comment to napi_complete_done
|
|
Commit Message
Jonathan Neuschäfer
Jan. 29, 2023, 1:26 p.m. UTC
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(+)
--
2.39.0
Comments
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.
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
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