Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751334AbaKICyd (ORCPT ); Sat, 8 Nov 2014 21:54:33 -0500 Received: from mho-02-ewr.mailhop.org ([204.13.248.72]:63449 "EHLO mho-02-ewr.mailhop.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751173AbaKICyb (ORCPT ); Sat, 8 Nov 2014 21:54:31 -0500 X-Mail-Handler: Dyn Standard SMTP by Dyn X-Originating-IP: 96.249.243.124 X-Report-Abuse-To: abuse@dyndns.com (see http://www.dyndns.com/services/sendlabs/outbound_abuse.html for abuse reporting information) X-MHO-User: U2FsdGVkX1/atcxELiioSKiwuq1+Af7fXqEDiKvqAsY= X-DKIM: OpenDKIM Filter v2.0.1 titan 7D3C8615378 Date: Sat, 8 Nov 2014 21:54:20 -0500 From: Jason Cooper To: Stephan Mueller Cc: Jonathan Corbet , Herbert Xu , "David S. Miller" , Marek Vasut , Grant Likely , Geert Uytterhoeven , Linux Kernel Developers List , linux-crypto@vger.kernel.org Subject: Re: [PATCH v2 01/11] crypto: Documentation - crypto API high level spec Message-ID: <20141109025420.GN3698@titan.lakedaemon.net> References: <6375771.bx7QqLJLuR@tachyon.chronox.de> <4163724.RCMDlx8dmE@tachyon.chronox.de> <20141103083439.635f5cb6@lwn.net> <4303532.NGaUQ44sQJ@tachyon.chronox.de> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <4303532.NGaUQ44sQJ@tachyon.chronox.de> User-Agent: Mutt/1.5.20 (2009-06-14) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Stephan, On Mon, Nov 03, 2014 at 03:18:29PM +0100, Stephan Mueller wrote: > Am Montag, 3. November 2014, 08:34:39 schrieb Jonathan Corbet: > > These are all useful. But I wonder if it would be worth the effort to turn > > this inti a proper docbook document that automatically has everything > > together in one place? > > How do you suggest that is done? The API comments in the header file follow > the Doxygen style. Note, Jason Cooper raised the concern that an API > documentation separate from the code will surely deviate from the code > relatively fast (although I do not really fear that as the kernel crypto API > seems to be quite stable over the last years). Agreed. My primary concern was adding it in such a way which facilitates maintenance and keeping it in sync with the code. But as you say, the crypto API doesn't change much. thx, Jason. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/