Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934375AbeAHP4d (ORCPT + 1 other); Mon, 8 Jan 2018 10:56:33 -0500 Received: from [128.1.224.119] ([128.1.224.119]:53500 "EHLO ringil.hmeau.com" rhost-flags-FAIL-FAIL-OK-OK) by vger.kernel.org with ESMTP id S933979AbeAHP4c (ORCPT ); Mon, 8 Jan 2018 10:56:32 -0500 Date: Tue, 9 Jan 2018 02:56:19 +1100 From: Herbert Xu To: Kamil Konieczny Cc: "Tobin C. Harding" , "David S. Miller" , Bartlomiej Zolnierkiewicz , linux-kernel@vger.kernel.org Subject: Re: [PATCH] crypto: clear htmldocs build warnings for crypto/hash Message-ID: <20180108155619.GA5350@gondor.apana.org.au> References: <1515279703-14070-1-git-send-email-me@tobin.cc> <724b85c9-f3df-15b2-7aa2-4089f232c155@partner.samsung.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <724b85c9-f3df-15b2-7aa2-4089f232c155@partner.samsung.com> User-Agent: Mutt/1.5.21 (2010-09-15) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Return-Path: On Mon, Jan 08, 2018 at 02:11:21PM +0100, Kamil Konieczny wrote: > > > On 07.01.2018 00:01, Tobin C. Harding wrote: > > SPHINX build emits multiple warnings of kind: > > > > warning: duplicate section name 'Note' > > > > (when building kernel via make target 'htmldocs') > > > > This is caused by repeated use of comments of form: > > > > * Note: soau soaeusoa uoe > > > > We can change the format without loss of clarity and clear the build > > warnings. > > > > Add '**[mandatory]**' or '**[optional]**' as kernel-doc field element > > description prefix > > > > This renders in HTML as (prefixes in bold) > > > > final > > [mandatory] Retrieve result from the driver. This function finalizes the > > transformation and retrieves the resulting hash from the driver and > > pushes it back to upper layers. No data processing happens at this > > point unless hardware requires it to finish the transformation (then > > the data buffered by the device driver is processed). > > > > Signed-off-by: Tobin C. Harding > > --- > > > > This patch begs the question why the other members of struct ahash_alg > > are not marked? Some are marked 'optional' some 'mandatory'. It would > > seem that if the marking were necessary for some members it is necessary > > for all to eliminate ambiguity? > > > > thanks > > import, export are optional No import/export must be implemented for all hashes. Cheers, -- Email: Herbert Xu Home Page: http://gondor.apana.org.au/~herbert/ PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt