Re: [PATCH 03/22] docs: crypto: convert asymmetric-keys.txt to ReST

2020-06-19 Thread Jonathan Corbet
On Mon, 15 Jun 2020 08:50:08 +0200 Mauro Carvalho Chehab wrote: > This file is almost compatible with ReST. Just minor changes > were needed: > > - Adjust document and titles markups; > - Adjust numbered list markups; > - Add a comments markup for the Contents section; > - Add markups for litera

Re: [PATCH 0/3] Clean up crypto documentation

2019-06-25 Thread Jonathan Corbet
On Tue, 25 Jun 2019 13:33:27 + Gary R Hook wrote: > > It's been "valid" since I wrote it...it's just not upstream yet :) I > > expect it to be in 5.3, though. So the best way to refer to a kernel > > function, going forward, is just function() with no markup needed. > > So I'm unclear: >

Re: [PATCH 0/3] Clean up crypto documentation

2019-06-24 Thread Jonathan Corbet
On Mon, 24 Jun 2019 13:29:42 -0700 Joe Perches wrote: > > Finally, would you prefer a v2 of the patch set? Happy to do > > whatever is preferred, of course. > > Whatever Jonathan decides is fine with me. > Mine was just a plea to avoid unnecessarily > making the source text harder to read as >

Re: [PATCH 00/18] Fix some build warnings/errors with Sphinx

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:36 -0300 Mauro Carvalho Chehab wrote: > I decided to give a try with Sphinx last stable version > (1.17.4), and noticed several issues. The worse one was > with the networking book: a non-standard footnote there > with [*] instead of a number causes it to break PDF build

Re: [PATCH 03/18] docs: */index.rst: Add newer documents to their respective index.rst

2018-05-08 Thread Jonathan Corbet
On Mon, 7 May 2018 06:35:39 -0300 Mauro Carvalho Chehab wrote: > A number of new docs were added, but they're currently not on > the index.rst from the session they're supposed to be, causing > Sphinx warnings. > > Add them. > > Signed-off-by: Mauro Carvalho Chehab I've applied this one, tha

Re: [PATCH v6 1/5] lib: Update LZ4 compressor module

2017-01-31 Thread Jonathan Corbet
On Fri, 27 Jan 2017 23:02:00 +0100 Sven Schmidt <4ssch...@informatik.uni-hamburg.de> wrote: I have one quick question... > /* > + * LZ4_compress_default() > + * Compresses 'sourceSize' bytes from buffer 'source' > + * into already allocated 'dest' buffer of size 'maxOutputSize'. > + * Comp

Re: [PATCH v2 0/8] Conversion crypto API documentation to Sphinx

2016-12-13 Thread Jonathan Corbet
On Tue, 13 Dec 2016 23:06:14 +0100 Stephan Müller wrote: > I am sorry, then I may have misunderstood you. > > I would think that Herbert agreed that you push the entire patch set through > your tree, including the documentation changes to the crypto header files. > > I just did a patch on the

Re: [PATCH v2 0/8] Conversion crypto API documentation to Sphinx

2016-12-13 Thread Jonathan Corbet
On Tue, 13 Dec 2016 22:25:07 +0100 Stephan Müller wrote: > Considering that a large batch of documentation updates just landed in Linus' > tree, I am wondering why the crypto API documentation update is not among it. Well, I'd asked if I could run the documentation-specific parts through docs-n

Re: [PATCH v2 0/8] Conversion crypto API documentation to Sphinx

2016-10-23 Thread Jonathan Corbet
On Fri, 21 Oct 2016 04:53:45 +0200 Stephan Mueller wrote: > the attached patch set converts the existing crypto API documentation > from DocBook to Sphinx. This looks generally good to me - thanks for doing it! Is there any chance of running the Documentation/ parts through the docs tree? Docu

Re: [PATCH] doc: crypto: warning cleanup

2015-08-24 Thread Jonathan Corbet
On Mon, 24 Aug 2015 06:51:35 +0200 Stephan Mueller wrote: > This one is already in the cryptodev-2.6 kernel. > > From now on, I will always CC the linux-doc mailing list on patches > pertaining > the crypto documentation so that you can see the patches too. Ah, OK, I should have peeked at lin

[PATCH] doc: crypto: warning cleanup

2015-08-23 Thread Jonathan Corbet
Fix up a missing field description and a misdirected doc inclusion to make a couple of warnings go away. Signed-off-by: Jonathan Corbet --- Documentation/DocBook/crypto-API.tmpl | 2 +- include/crypto/aead.h | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a

Re: [PATCH v2 01/11] crypto: Documentation - crypto API high level spec

2014-11-03 Thread Jonathan Corbet
On Mon, 03 Nov 2014 15:18:29 +0100 Stephan Mueller wrote: > > 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? See Documentation

Re: [PATCH v2 01/11] crypto: Documentation - crypto API high level spec

2014-11-03 Thread Jonathan Corbet
On Sun, 02 Nov 2014 21:35:11 +0100 Stephan Mueller wrote: > The design of the kernel crypto API as well as hints to program with > the kernel crypto API are given. Cool to see this, thanks. Please forgive me if I go into full grumpy editor mode here. There's a lot of good information here, but