Date:   Wed, 15 Mar 2023 16:35:22 -0700
From:   Dan Williams <dan.j.williams@intel.com>
To:     Randy Dunlap <rdunlap@infradead.org>,
        <linux-kernel@vger.kernel.org>
CC:     Randy Dunlap <rdunlap@infradead.org>,
        Dan Williams <dan.j.williams@intel.com>,
        Herbert Xu <herbert@gondor.apana.org.au>,
        "David S. Miller" <davem@davemloft.net>,
        <linux-crypto@vger.kernel.org>
Subject: RE: [PATCH v2] async_tx: fix kernel-doc notation warnings
Message-ID: <6412563addf9f_269929487@dwillia2-xfh.jf.intel.com.notmuch>
References: <20230314024734.9066-1-rdunlap@infradead.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20230314024734.9066-1-rdunlap@infradead.org>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?/GxNCAs+VfaiZ7vSJtFjrQzGuuef2/FZ/TMVf7WDaRUwQBQgdO8UqEKskKph?=
 =?us-ascii?Q?HTByahzBRaAHZXkE6iApdiItys/6s/ZKYSAq9cQeRmtk9m7hD+AcomJbGUuq?=
 =?us-ascii?Q?uIJRuC0N8DYYnSpNpTOgXldSivfdYTPLoaH+nz8wfLoKFpSyoeimNlFGys7s?=
 =?us-ascii?Q?3lrJxaMPJj/a0GAmha7M9r5lAJP3TG3SxILhshKzMmK8OkbePm0Qhx/T/B2P?=
 =?us-ascii?Q?jxN/7a7DUXcHwXnQujOo4vh0OA5b1IoEy+R3a3ExQCIHjoFFCmIX4byODITk?=
 =?us-ascii?Q?hLIWlAH88nUwACp29l4e+2o9HQJlrjxIzoXUkBatZGlqLMCLqhqunM/juWQH?=
 =?us-ascii?Q?V8tPr0gQ8mg4SCVuFLCI4OYDPni+A/Ab+4OCH4pvz3xpys8Qp09VjIPNwrUl?=
 =?us-ascii?Q?y4J+2Tv/ziYQ32Wz7O4zx6SvTqo+haNrX+s3TeIUwxGGTuZgkI29X6RnmwB2?=
 =?us-ascii?Q?ciMjEuIfucbV+SB3ZhBcdcosA6dmFBqom0BI7vi/mZu02qWSk4c0pFlGhh8j?=
 =?us-ascii?Q?ZfU0o5nWs1d0yY/37e40pkAKsZhUkD85Eia7Gosp9LVTnX7WYnt3XnVhJf0G?=
 =?us-ascii?Q?hHpF53n9TGiSZ7E1/YL/b3bf2q6qGxUbkZKp9eyGoQDaT/ivyg9UxgkjLPpi?=
 =?us-ascii?Q?q7/KPxrP4fmMtJ9c0GNoaGR1WzPAupSS14YS0VBABQRdqTTYXPF19SX9+YMO?=
 =?us-ascii?Q?4krqRbw8BfOgo0Yt+Ofy0Kcby91WeJmy0knANx4SqKnlkevVuzuzzcbRGWP9?=
 =?us-ascii?Q?wW0r9cqNMIYTdXKT+cyO5jZaF42ZOgvwebTI913Wh2gRgRX/J1bBYZvyiSX8?=
 =?us-ascii?Q?gYz0jgFUAd/7gZ5z+g06p5zY0UwqfqRJCkdbZV05no8ksX36aqpWh4DU33HK?=
 =?us-ascii?Q?5PUu7qfXDFSCHdGMEkz0KhasT8cv3/iL5pjlNT6GVDxsDm8IvEOZfLIieneK?=
 =?us-ascii?Q?LaMsIvAi87/77C+N/XB7o6fi6XgeBOuMMeMBZm/wWNFSa4WByoAr/I4EOGsy?=
 =?us-ascii?Q?uobiULtgue3jIkTq6gqxlAlzhQ9yDUTs/spIGSh51WJ56t+4idKDuRPtzbIF?=
 =?us-ascii?Q?r2FWpaLF6IGK+VSI2iW96OVrGGS7WNdmHxubmWN4UTSuO8dRMFXe7MnNolCz?=
 =?us-ascii?Q?fYSJP3dk3EjheBlU6wJRbEALAaavJPBj3Pgkun2dF8qKDlXNo0aoGVMpzn0p?=
 =?us-ascii?Q?1Gma9/nLm4Xcxm/hVkOWw+4WW0LaIKa4lU7E9QXXntXYTvcFGJWCtyobUU9/?=
 =?us-ascii?Q?OPXQ9nkEwWRvLTg0pAXwi/7yhXXcv3/oylCCuqjKIKjfGnEJVy1+MBBD/Ysh?=
 =?us-ascii?Q?RZw/vFg14aKuRlThC6zD08joU5kj70qYJpDLcp3keLvdqJSv07vFu3trH+7Y?=
 =?us-ascii?Q?/JjwacRtarUBWKrSWp0gFotf6Mr0CnWCW3FR/6YIOvJ6BHRXu9LClGgLsVZ7?=
 =?us-ascii?Q?Y6ot47aJKkiQTFQYPLlcKGgQqvVVgvoXgr+6T7bKI+W15Sj67ivSW3AtOcyO?=
 =?us-ascii?Q?7JY+8blzlPZYkJhK71EIArHQggYAn0WaWrIxIejvev3kofLP1IoDUZ7AEdrX?=
 =?us-ascii?Q?FRu/CdMZpC4BMvVbgw93N4tYDRPG0/yL/2C5egm0JCgc/ZpWuYdhy0F0iDqf?=
 =?us-ascii?Q?Tg=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 71145559-7295-4abb-c091-08db25adf40a
X-MS-Exchange-CrossTenant-AuthSource: PH8PR11MB8107.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Mar 2023 23:35:25.8505
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: igyuDtleOjmYaDb0/28Bb1bYNsfcvDkWuvaQSZHpVLYM+QqCcBSsaWu67Kv9UAmhdokZrh0X5OTdSkcs6gdJR0g4PZQEkSpvxYCG3l1Phas=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW3PR11MB4668
X-OriginatorOrg: intel.com
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Randy Dunlap wrote:
> Fix kernel-doc warnings by adding "struct" keyword or "enum" keyword.
> Also fix 2 function parameter descriptions.
> Change some functions and structs from kernel-doc /** notation
> to regular /* comment notation.
> 
> async_pq.c:18: warning: cannot understand function prototype: 'struct page *pq_scribble_page; '
> async_pq.c:18: error: Cannot parse struct or union!
> async_pq.c:40: warning: No description found for return value of 'do_async_gen_syndrome'
> async_pq.c:109: warning: Function parameter or member 'blocks' not described in 'do_sync_gen_syndrome'
> async_pq.c:109: warning: Function parameter or member 'offsets' not described in 'do_sync_gen_syndrome'
> async_pq.c:109: warning: Function parameter or member 'disks' not described in 'do_sync_gen_syndrome'
> async_pq.c:109: warning: Function parameter or member 'len' not described in 'do_sync_gen_syndrome'
> async_pq.c:109: warning: Function parameter or member 'submit' not described in 'do_sync_gen_syndrome'
> 
> async_tx.c:136: warning: cannot understand function prototype: 'enum submit_disposition '
> async_tx.c:264: warning: Function parameter or member 'tx' not described in 'async_tx_quiesce'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Dan Williams <dan.j.williams@intel.com>
> Cc: Herbert Xu <herbert@gondor.apana.org.au>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: linux-crypto@vger.kernel.org
> ---
> v2: fix more warnings

Looks good to me.

Reviewed-by: Dan Williams <dan.j.williams@intel.com>

Herbert, can you pick this up?