From patchwork Mon Jan 2 07:30:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 38016 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4e01:0:0:0:0:0 with SMTP id p1csp4055944wrt; Sun, 1 Jan 2023 23:47:09 -0800 (PST) X-Google-Smtp-Source: AMrXdXuVBJtBAWdfjvr4/lL2S6eQs0IeYwk4oTP3drgdyVz1EJtDoUb6lTZPpP6bet7lcJTeDYdP X-Received: by 2002:a05:6a21:99a4:b0:a3:94cd:1435 with SMTP id ve36-20020a056a2199a400b000a394cd1435mr66145029pzb.38.1672645628727; Sun, 01 Jan 2023 23:47:08 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1672645628; cv=none; d=google.com; s=arc-20160816; b=B6+qUjlzazC2Ca+BHCddSsnaJNNo59oetf3mEJulvA8dITKchGbYZ28Pi9F/zlK55M Acu89qx3aA/VXJQLto9mvc2raHMmYiHc1sH0V7wn4yJhxXewMRi796cUo58LsZVmiIkK 2Mn8KlJoIpSNeDmxrS0KBD0tOgZ2jIyjiOX/GUiAvDdn3IKx90HJ9CSL5KFn4GNXxVOf Kv0kAS8QNDexkISphEgV/xrmhDJa1gCfgQUyHmfydIB+I2yYRP4BIMxCtNsMhwJX3VZ/ sGarIOv1oSC/Z6AGVAX6+Rrozhj9bAqLIC1YZpSMdDf8DrIjzgO6khDr++9WHCLLMcvb zqRQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=bLWETpLjeuylqYkvPIWNbfGdf7cs1oR5lWW9NWB/8PQ=; b=zojGJmSgpw0BhD79PlQIPBwjkpuz54aVR1rWT4Wm/Q4bHA55jhpiEstYvn/F+A78nr Pqs6YNAaFifjcX7ot0ajXNIEKc0JU0/8YggsDYXEp+/PykRs4cpJ/aOxfeQISYJVwfMQ MwR/eCdAys53aTjEiM7jukl1vmfqIidyJJDeXqVbMKmfBw3lRxoIBb3YCOfej5yWNzhW Y9LlPGypyXpa8BElaApr21PmkjJJa1iKZgwQdYvPM8bSeE5R43w+U+e8J6cLZ3mYVxuJ RP9/53BEg/8Xo/hu3Hbjqg2bzi+237PhFklWrcEF/LaSgRk2cx9OgfSO0t9N0TtFl9gq GK2g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=d4wyv1yt; 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 Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id e2-20020a636902000000b0046f4696a544si28043855pgc.128.2023.01.01.23.46.52; Sun, 01 Jan 2023 23:47:08 -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=@infradead.org header.s=bombadil.20210309 header.b=d4wyv1yt; 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 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230072AbjABHad (ORCPT + 99 others); Mon, 2 Jan 2023 02:30:33 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36024 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229447AbjABHab (ORCPT ); Mon, 2 Jan 2023 02:30:31 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CC7BD111B; Sun, 1 Jan 2023 23:30:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=bLWETpLjeuylqYkvPIWNbfGdf7cs1oR5lWW9NWB/8PQ=; b=d4wyv1ytBKpwRGo0CvDxZ28J17 FeogQLlsYiP91AEnmE1VKJbO2gZRa6kp43Ek/fNS3Lzzgfa4/whJAeeTQw1XoQP5lJkV4AcpBzbWl Eq/X56N2wi/koae7+AfMB2F1xYlJFl5zAt7DmmKO2BVy65tjwydsRnQ2rfk57wMvllHPDVc61hXk2 6PfbT31wHKr9TAafrGNLIEM/6DN4xf383GNka8LzISIVJgiekCiA07JgBjH3TadODStEUpT4C/jzI YL+7K0ls1iABZei9+HOxPkuX4wwaevfcBl3jNvCNnVn1K/HAmmxKZ4A80P5G6brKf6HkLRouGO9Rm pzx1uGSg==; Received: from [2601:1c2:d80:3110::a2e7] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1pCFHA-009DSK-Ul; Mon, 02 Jan 2023 07:30:29 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Dan Williams , Herbert Xu , "David S. Miller" , linux-crypto@vger.kernel.org Subject: [PATCH] async_tx: fix kernel-doc notation warnings Date: Sun, 1 Jan 2023 23:30:28 -0800 Message-Id: <20230102073028.28870-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.39.0 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE autolearn=ham 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: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1753896062554414312?= X-GMAIL-MSGID: =?utf-8?q?1753896062554414312?= Fix W=1 kernel-doc warnings by adding "struct" keyword: crypto/async_tx/async_tx.c:136: warning: cannot understand function prototype: 'enum submit_disposition ' crypto/async_tx/async_pq.c:18: warning: cannot understand function prototype: 'struct page *pq_scribble_page; ' Also fix 2 function parameter descriptions. Signed-off-by: Randy Dunlap Cc: Dan Williams Cc: Herbert Xu Cc: "David S. Miller" Cc: linux-crypto@vger.kernel.org --- crypto/async_tx/async_pq.c | 4 ++-- crypto/async_tx/async_tx.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff -- a/crypto/async_tx/async_pq.c b/crypto/async_tx/async_pq.c --- a/crypto/async_tx/async_pq.c +++ b/crypto/async_tx/async_pq.c @@ -12,7 +12,7 @@ #include /** - * pq_scribble_page - space to hold throwaway P or Q buffer for + * struct pq_scribble_page - space to hold throwaway P or Q buffer for * synchronous gen_syndrome */ static struct page *pq_scribble_page; @@ -281,7 +281,7 @@ pq_val_chan(struct async_submit_ctl *sub /** * async_syndrome_val - asynchronously validate a raid6 syndrome * @blocks: source blocks from idx 0..disks-3, P @ disks-2 and Q @ disks-1 - * @offset: common offset into each block (src and dest) to start transaction + * @offsets: common offset into each block (src and dest) to start transaction * @disks: number of blocks (including missing P or Q, see below) * @len: length of operation in bytes * @pqres: on val failure SUM_CHECK_P_RESULT and/or SUM_CHECK_Q_RESULT are set diff -- a/crypto/async_tx/async_tx.c b/crypto/async_tx/async_tx.c --- a/crypto/async_tx/async_tx.c +++ b/crypto/async_tx/async_tx.c @@ -124,7 +124,7 @@ async_tx_channel_switch(struct dma_async /** - * submit_disposition - flags for routing an incoming operation + * enum submit_disposition - flags for routing an incoming operation * @ASYNC_TX_SUBMITTED: we were able to append the new operation under the lock * @ASYNC_TX_CHANNEL_SWITCH: when the lock is dropped schedule a channel switch * @ASYNC_TX_DIRECT_SUBMIT: when the lock is dropped submit directly @@ -258,7 +258,7 @@ EXPORT_SYMBOL_GPL(async_trigger_callback /** * async_tx_quiesce - ensure tx is complete and freeable upon return - * @tx - transaction to quiesce + * @tx: transaction to quiesce */ void async_tx_quiesce(struct dma_async_tx_descriptor **tx) {