linux-kernel - [PATCH] async_tx: Fix some kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 11 Nov 2022 01:44:41 -0500
From:   Bo Liu <liubo03@...pur.com>
To:     <dan.j.williams@...el.com>, <herbert@...dor.apana.org.au>,
        <davem@...emloft.net>
CC:     <linux-crypto@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        Bo Liu <liubo03@...pur.com>
Subject: [PATCH] async_tx: Fix some kernel-doc warnings

Fixes the following W=1 kernel build warning(s):
  crypto/async_tx/async_tx.c:136: warning: cannot understand function prototype: 'enum submit_disposition '
  crypto/async_tx/async_tx.c:264: warning: Function parameter or member 'tx' not described in 'async_tx_quiesce'

Signed-off-by: Bo Liu <liubo03@...pur.com>
---
 crypto/async_tx/async_tx.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/crypto/async_tx/async_tx.c b/crypto/async_tx/async_tx.c
index 9256934312d7..8840731cefbb 100644
--- a/crypto/async_tx/async_tx.c
+++ b/crypto/async_tx/async_tx.c
@@ -33,7 +33,7 @@ static void __exit async_tx_exit(void)
 module_init(async_tx_init);
 module_exit(async_tx_exit);
 
-/**
+/*
  * __async_tx_find_channel - find a channel to carry out the operation or let
  *	the transaction execute synchronously
  * @submit: transaction dependency and submission modifiers
@@ -55,7 +55,7 @@ EXPORT_SYMBOL_GPL(__async_tx_find_channel);
 #endif
 
 
-/**
+/*
  * async_tx_channel_switch - queue an interrupt descriptor with a dependency
  * 	pre-attached.
  * @depend_tx: the operation that must finish before the new operation runs
@@ -123,7 +123,7 @@ async_tx_channel_switch(struct dma_async_tx_descriptor *depend_tx,
 }
 
 
-/**
+/*
  * 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
@@ -209,7 +209,7 @@ async_tx_submit(struct dma_chan *chan, struct dma_async_tx_descriptor *tx,
 }
 EXPORT_SYMBOL_GPL(async_tx_submit);
 
-/**
+/*
  * async_trigger_callback - schedules the callback function to be run
  * @submit: submission and completion parameters
  *
@@ -256,9 +256,9 @@ async_trigger_callback(struct async_submit_ctl *submit)
 }
 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)
 {
-- 
2.27.0