lkml.org 
[lkml]   [2014]   [Nov]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v2 01/11] crypto: Documentation - crypto API high level spec
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.


\
 
 \ /
  Last update: 2014-11-09 04:21    [W:0.101 / U:0.428 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site