From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.0 required=3.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 25316C43381 for ; Tue, 26 Feb 2019 18:25:03 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id E934B217F5 for ; Tue, 26 Feb 2019 18:25:02 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=netronome-com.20150623.gappssmtp.com header.i=@netronome-com.20150623.gappssmtp.com header.b="MM73NMQF" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729188AbfBZSZC (ORCPT ); Tue, 26 Feb 2019 13:25:02 -0500 Received: from mail-qk1-f196.google.com ([209.85.222.196]:38056 "EHLO mail-qk1-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729166AbfBZSZA (ORCPT ); Tue, 26 Feb 2019 13:25:00 -0500 Received: by mail-qk1-f196.google.com with SMTP id p15so8188896qkl.5 for ; Tue, 26 Feb 2019 10:24:59 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=netronome-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=U0AXrGPetmYo3f9cWhhitaVemLzqaF0r/xkuOTS1NZI=; b=MM73NMQF6jlDZikSl6xAAgMsuhhrI/CAbz/EZIzSZAG3PNm/VGCv0mDuapj+t6BqnT LFf0FNDIkStcG0xJDgGn9fsMTC+52o/yU+GVggdOD0Sv6YlAPDngncwkhq1MftuHyYzA jE2xV6+9GxE0CFC4+hz67Qnxr1lmICe4miDcS+D2/sNZ3DpMRf+as3b5vf0ycCmxmLSe HrpilVCZLnGGFCkkJxLez5U4kCOMYPVcedLbMvBnQ66TOjltQaONStAl0Dlz3LnukSzH HtfHen5YDl1a0KRaVZ+SCW+cAjK6b4OIGbIzpo3iGUKyO1vQ38iWhiUCI0eoadj3we7y dtkw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=U0AXrGPetmYo3f9cWhhitaVemLzqaF0r/xkuOTS1NZI=; b=ZPVksBxEsxPwj0GXJEObw82XzSf9Nup3VNhRGRy5z7wmu2QzDsy1a4Ej89CjeF8x+8 hQOPQglZsxJUZsrBSwP1yv/6YT8TpU0ARIpC+Y3DOOkw354wGOYjIf5Fh9Ok0LGZTWp8 uQ2XqKjp19ziytb2OF7LZty6npWNoap8xTAftv0uugf/VzEQt+gQsP6EekbRe3/8P1gd a34VfUo4f30ERJr6geH6ZOOIuC4XonydtUcC8dKejITpQB/ddG9KeqJ97rzzAak58QkB H7JxfPNm88A8Jyps7Xi6pD5MKOEfrO5f0aaI/tDEn3waMtIN+JMEuCyNK8TyOAw88hO5 k2Ow== X-Gm-Message-State: AHQUAuZiKOhiK5Mx7dzjtMiq1QqVTv8JuwTnIUZNRqR05i+kqwVst6OE sdlhpT3DQN78nRfiaXOIN8xVmg== X-Google-Smtp-Source: AHgI3IZZQgqzfQIqqTpx11P60u97k9bBBtYR+mwS76/89H8F4x+i0PNQq47mwO6iNPVNWvVRfKfAxQ== X-Received: by 2002:a37:a58b:: with SMTP id o133mr17633059qke.106.1551205499018; Tue, 26 Feb 2019 10:24:59 -0800 (PST) Received: from jkicinski-Precision-T1700.netronome.com ([66.60.152.14]) by smtp.gmail.com with ESMTPSA id u31sm9733892qth.15.2019.02.26.10.24.57 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 26 Feb 2019 10:24:58 -0800 (PST) From: Jakub Kicinski To: davem@davemloft.net, jiri@resnulli.us Cc: oss-drivers@netronome.com, netdev@vger.kernel.org, Jakub Kicinski Subject: [PATCH net-next 8/8] devlink: fix kdoc Date: Tue, 26 Feb 2019 10:24:36 -0800 Message-Id: <20190226182436.23811-9-jakub.kicinski@netronome.com> X-Mailer: git-send-email 2.19.2 In-Reply-To: <20190226182436.23811-1-jakub.kicinski@netronome.com> References: <20190226182436.23811-1-jakub.kicinski@netronome.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org devlink suffers from a few kdoc warnings: net/core/devlink.c:5292: warning: Function parameter or member 'dev' not described in 'devlink_register' net/core/devlink.c:5351: warning: Function parameter or member 'port_index' not described in 'devlink_port_register' net/core/devlink.c:5753: warning: Function parameter or member 'parent_resource_id' not described in 'devlink_resource_register' net/core/devlink.c:5753: warning: Function parameter or member 'size_params' not described in 'devlink_resource_register' net/core/devlink.c:5753: warning: Excess function parameter 'top_hierarchy' description in 'devlink_resource_register' net/core/devlink.c:5753: warning: Excess function parameter 'reload_required' description in 'devlink_resource_register' net/core/devlink.c:5753: warning: Excess function parameter 'parent_reosurce_id' description in 'devlink_resource_register' net/core/devlink.c:6451: warning: Function parameter or member 'region' not described in 'devlink_region_snapshot_create' net/core/devlink.c:6451: warning: Excess function parameter 'devlink_region' description in 'devlink_region_snapshot_create' Signed-off-by: Jakub Kicinski --- net/core/devlink.c | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/net/core/devlink.c b/net/core/devlink.c index b514be300839..cd3f466496d3 100644 --- a/net/core/devlink.c +++ b/net/core/devlink.c @@ -5287,6 +5287,7 @@ EXPORT_SYMBOL_GPL(devlink_alloc); * devlink_register - Register devlink instance * * @devlink: devlink + * @dev: parent device */ int devlink_register(struct devlink *devlink, struct device *dev) { @@ -5337,7 +5338,7 @@ EXPORT_SYMBOL_GPL(devlink_free); * * @devlink: devlink * @devlink_port: devlink port - * @port_index + * @port_index: driver-specific numerical identifier of the port * * Register devlink port with provided port index. User can use * any indexing, even hw-related one. devlink_port structure @@ -5736,13 +5737,10 @@ EXPORT_SYMBOL_GPL(devlink_dpipe_table_unregister); * * @devlink: devlink * @resource_name: resource's name - * @top_hierarchy: top hierarchy - * @reload_required: reload is required for new configuration to - * apply * @resource_size: resource's size * @resource_id: resource's id - * @parent_reosurce_id: resource's parent id - * @size params: size parameters + * @parent_resource_id: resource's parent id + * @size_params: size parameters */ int devlink_resource_register(struct devlink *devlink, const char *resource_name, @@ -6439,7 +6437,7 @@ EXPORT_SYMBOL_GPL(devlink_region_shapshot_id_get); * Multiple snapshots can be created on a region. * The @snapshot_id should be obtained using the getter function. * - * @devlink_region: devlink region of the snapshot + * @region: devlink region of the snapshot * @data_len: size of snapshot data * @data: snapshot data * @snapshot_id: snapshot id to be created -- 2.19.2