From patchwork Wed Jul 8 12:01:57 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 235094 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp371511ilg; Wed, 8 Jul 2020 05:04:38 -0700 (PDT) X-Google-Smtp-Source: ABdhPJx28ZEFyTmnE/dJZQ0WVdqS7W84ZXpJsp6B3qI/twpV9uJMVDNgxMEPOVp0RT58W/mAzCg+ X-Received: by 2002:a17:906:46d1:: with SMTP id k17mr50788866ejs.446.1594209878270; Wed, 08 Jul 2020 05:04:38 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594209878; cv=none; d=google.com; s=arc-20160816; b=N38sgYoPmrdOPglwIQbGfwW7crJQTgOceU1ScTPwGz7aiYBKXgS/saDLn3klIOtIJZ Fw0Cs9VgMdsvRLaKEv6krjPLqEapsbDBtZ65PtTYz1PHM0YnQJrbZ/HlLQ7xOpW61yMJ TPkCIQA/VEZbHkMwXzzEH6oW4qWwrZ/J6Rumfm2hF4gMwe2cbupNyHZq5L6puDrF1xRc 1Z0338Wi6lLJ50LWHsnQ0DTvMRV9orYRNle59u+IspHVQ8ZEAVeWWx6d4TxznGgUp/GA n11skL7Mq0ybvhmuBw6aXy6zaz1D+Ta77bUOVTu+z4GHcdlTJqvoFABguLc0+golK+D0 HftQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=DmqYn8cL7eqDFwNGfmdwoQHTEQPwopRMh0yPN6WNGOc=; b=f1u7nn8HQJV/Z695T0N1Cs+Ww2ZcCR3sOcBVUaqXrzbuS5ceH11O35JZNCTIvgOQBy WcttIjzFb15Df4VTN6hMPXM4ImBxT8POKQSWs/pPJ0hwEbAv5XY8q4v6udX9qkJztqr/ zyw6DLNJjk/tlhSrA0I46bbtUNxe3NYqJI7fh+5ofcuY3EMIrF4YBz/REr0Qz6fkMnem T4WPnM6+Gh4AySUpO04bKFeOnMGMLt6VXdhBnN3yhRv+dtC/hmff7oAhq6bnj2qk1V1P b2nc4MBTxHuNLUUH+W7NTj/qZPdbqBNskJFT3aGbUthotLeAS1Bq3XdwPU7BODtZSm71 ADMw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=ZX89HUHj; spf=pass (google.com: domain of linux-scsi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-scsi-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id r20si16829765edw.577.2020.07.08.05.04.37 for ; Wed, 08 Jul 2020 05:04:38 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-scsi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=ZX89HUHj; spf=pass (google.com: domain of linux-scsi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-scsi-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729223AbgGHMEg (ORCPT ); Wed, 8 Jul 2020 08:04:36 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55364 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729015AbgGHMCf (ORCPT ); Wed, 8 Jul 2020 08:02:35 -0400 Received: from mail-wm1-x344.google.com (mail-wm1-x344.google.com [IPv6:2a00:1450:4864:20::344]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5549CC08E6DC for ; Wed, 8 Jul 2020 05:02:35 -0700 (PDT) Received: by mail-wm1-x344.google.com with SMTP id o2so2739867wmh.2 for ; Wed, 08 Jul 2020 05:02:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=DmqYn8cL7eqDFwNGfmdwoQHTEQPwopRMh0yPN6WNGOc=; b=ZX89HUHjMyHzb2heKm0iH8q120RxpXZ4NY/Lixv0Rryknk//WXNKNL878jlcUlwD49 lChMvRvyp2d4ylLHijtfBzHUSke+nLv3JvqjaILPjmI2/osr42fXXhHvW1otnkJ//5RA PsmBBT+QTvIFVvrk6MZ/OMKKCDmePDjOMzzRIEM2w2nSM5MDwDhq587PwePzFNlLq90y pr72HLxGR9a4GcvhyFNTSlEoiEbzmLNGJiR8kUBognvguyqVNiUwe1IGf5sIePxRdAmb zLsoOx2hSbEay1tc3FINUEu1HVft+fIYuN3V3iskbFPP4x79ZLD63clZdzhZP0IR3wMt MPLA== 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=DmqYn8cL7eqDFwNGfmdwoQHTEQPwopRMh0yPN6WNGOc=; b=NUSpuJep/c9nGoZiSJb8IKuwmVc7BshbUi+ES/KmCx46zcyR+9wulXRMTXcpav/AkM Jp3WZOWu7yeM5AxQHztGgZeN/rop0C5W+Dyy3K+niWnG1hIP3vm3uP6Sv1ffySAGkPsU JYI5/eWwEI5iDP6EtdoQ3cm5iaQr/oArq25xPOvKS2smpYVhwdygKdSu6KLJ2vX1/glN ZQ6nk5pEUEo2J2hV7foNGDyaHENmddZW+p3w6igwGbvRbgvWajhU4tUYtMdi35c3Xqmw YwLtl6wAgZnj/dqz58sxZFOgMjHIIt2RqOd6qhiHQWXuaUGZN5ZkHqmuYJaMqPXko52d /sCQ== X-Gm-Message-State: AOAM531NIiILzETVlro5uSYiIrh4LdF3zaMpory1s5U+4guS2D6dSOhP W862RdiQnZh4yzmcXgd434ESAQ== X-Received: by 2002:a1c:6788:: with SMTP id b130mr9412333wmc.100.1594209753955; Wed, 08 Jul 2020 05:02:33 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.206]) by smtp.gmail.com with ESMTPSA id m62sm3964997wmm.42.2020.07.08.05.02.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Jul 2020 05:02:33 -0700 (PDT) From: Lee Jones To: jejb@linux.ibm.com, martin.petersen@oracle.com Cc: linux-kernel@vger.kernel.org, linux-scsi@vger.kernel.org, Lee Jones , Hannes Reinecke Subject: [PATCH 06/30] scsi: fcoe: fcoe_transport: Correct some kernel-doc issues Date: Wed, 8 Jul 2020 13:01:57 +0100 Message-Id: <20200708120221.3386672-7-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200708120221.3386672-1-lee.jones@linaro.org> References: <20200708120221.3386672-1-lee.jones@linaro.org> MIME-Version: 1.0 Sender: linux-scsi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org Mainly due to misdocumentation or bitrotted descriptions. Fixes the following W=1 kernel build warning(s): drivers/scsi/fcoe/fcoe_transport.c:396: warning: Function parameter or member 'skb' not described in 'fcoe_check_wait_queue' drivers/scsi/fcoe/fcoe_transport.c:447: warning: Function parameter or member 't' not described in 'fcoe_queue_timer' drivers/scsi/fcoe/fcoe_transport.c:447: warning: Excess function parameter 'lport' description in 'fcoe_queue_timer' drivers/scsi/fcoe/fcoe_transport.c:682: warning: Function parameter or member 'netdev' not described in 'fcoe_netdev_map_lookup' Cc: Hannes Reinecke Signed-off-by: Lee Jones --- drivers/scsi/fcoe/fcoe_transport.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) -- 2.25.1 diff --git a/drivers/scsi/fcoe/fcoe_transport.c b/drivers/scsi/fcoe/fcoe_transport.c index a20ddc301c89e..6e187d0e71fd2 100644 --- a/drivers/scsi/fcoe/fcoe_transport.c +++ b/drivers/scsi/fcoe/fcoe_transport.c @@ -382,6 +382,7 @@ EXPORT_SYMBOL_GPL(fcoe_clean_pending_queue); /** * fcoe_check_wait_queue() - Attempt to clear the transmit backlog * @lport: The local port whose backlog is to be cleared + * @skb: The received FIP packet * * This empties the wait_queue, dequeues the head of the wait_queue queue * and calls fcoe_start_io() for each packet. If all skb have been @@ -439,7 +440,7 @@ EXPORT_SYMBOL_GPL(fcoe_check_wait_queue); /** * fcoe_queue_timer() - The fcoe queue timer - * @lport: The local port + * @t: Timer context use to obtain the FCoE port * * Calls fcoe_check_wait_queue on timeout */ @@ -672,6 +673,7 @@ static void fcoe_del_netdev_mapping(struct net_device *netdev) /** * fcoe_netdev_map_lookup - find the fcoe transport that matches the netdev on which * it was created + * @netdev: The net device that the FCoE interface is on * * Returns : ptr to the fcoe transport that supports this netdev or NULL * if not found.