Re: [RESEND PATCH v2 4/4] usb: doc: add document for USB3 debug port usage

2016-10-20 Thread Jani Nikula
On Thu, 20 Oct 2016, Lu Baolu wrote: > Hi Jani, > > On 10/19/2016 03:48 PM, Jani Nikula wrote: >> On Wed, 19 Oct 2016, Lu Baolu wrote: >>> Add Documentation/usb/usb3-debug-port.txt. This document includes >>> the user guide for USB3 debug port. >> If you're adding completely new files, please at

[PATCH] USB: update intro of documentation

2016-10-20 Thread Oliver Neukum
It does no good to mention The 2.4 kernel series and neglect USB 3.x and XHCI. Also with type C and micro/mini USB we better not talk about the shape of connectors. Signed-off-by: Oliver Neukum --- Documentation/DocBook/usb.tmpl | 68 +++--- 1 file changed, 30

[PATCH] Documentation: usb: the dumb conversion to Sphinx

2016-10-20 Thread Oliver Neukum
This just is the result of the conversion script and its addition to the index. Just the plain automatic conversion. Signed-off-by: Oliver Neukum --- Documentation/index.rst | 1 + Documentation/usb/conf.py | 5 + Documentation/usb/usb.rst | 750

Re: The downside of math::

2016-10-20 Thread Jani Nikula
On Thu, 20 Oct 2016, Mauro Carvalho Chehab wrote: > Hi Jon, > > Em Wed, 19 Oct 2016 17:02:46 -0600 > Jonathan Corbet escreveu: > >> Hey, Mauro, >> >> So I was a little surprised to find that the htmldocs build now breaks on >> one of my machines due to a lack of LaTeX. A bit of digging turned u

Re: [PATCH] Documentation: usb: the dumb conversion to Sphinx

2016-10-20 Thread Jani Nikula
On Thu, 20 Oct 2016, Oliver Neukum wrote: > This just is the result of the conversion script and its addition > to the index. Just the plain automatic conversion. How does this relate to [1]? Why does this not remove the .tmpl file? BR, Jani. [1] http://lkml.kernel.org/r/1476969300-9603-1-git-s

Re: The downside of math::

2016-10-20 Thread Markus Heiser
Am 20.10.2016 um 16:55 schrieb Jani Nikula : >> So, I really prefer not removing math support. > > I wonder if we could cook up a nice way to make the math:: usage > conditional on actually being able to render it. > > I would rather have the math:: directive produce just the preformatted > inde

Re: [PATCH] USB: update intro of documentation

2016-10-20 Thread Rami Rosen
Hi Oliver, Thanks for your patch. Typo: Should be "their" instead of " thei1r" in the following paragraph: > Device driver authors should make a point of doing disconnect > testing (while the device is active) with each different host > controller driver, to make sure drivers don't

Re: [PATCH] Documentation: usb: the dumb conversion to Sphinx

2016-10-20 Thread Oliver Neukum
On Thu, 2016-10-20 at 18:04 +0300, Jani Nikula wrote: > On Thu, 20 Oct 2016, Oliver Neukum wrote: Hi, > > This just is the result of the conversion script and its addition > > to the index. Just the plain automatic conversion. > > How does this relate to [1]? It is the second after that, as we

Re: [PATCH] Documentation: usb: the dumb conversion to Sphinx

2016-10-20 Thread Jonathan Corbet
On Thu, 20 Oct 2016 18:22:28 +0200 Oliver Neukum wrote: > > Why does this not remove the .tmpl file? > > 1. We might want to keep it > 2. It is an operation beyond the scope of this patch. I have to disagree with this part; the last thing we want is two copies of the documentation to get out

[PATCH] [linux-next] Doc: cciss: Fix a typo in cciss.txt

2016-10-20 Thread Masanari Iida
This patch fix a spelling typo in cciss.txt Signed-off-by: Masanari Iida --- Documentation/blockdev/cciss.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/blockdev/cciss.txt b/Documentation/blockdev/cciss.txt index b79d0a13e7cd..3a5477cc456e 100644 --- a/Docu

RE: [PATCH] [linux-next] Doc: cciss: Fix a typo in cciss.txt

2016-10-20 Thread Don Brace
> -Original Message- > From: Masanari Iida [mailto:standby2...@gmail.com] > Sent: Thursday, October 20, 2016 3:00 PM > To: Don Brace; cor...@lwn.net; linux-doc@vger.kernel.org; linux- > ker...@vger.kernel.org > Cc: Masanari Iida > Subject: [PATCH] [linux-next] Doc: cciss: Fix a typo in ccis

Re: [RESEND PATCH v2 4/4] usb: doc: add document for USB3 debug port usage

2016-10-20 Thread Lu Baolu
Hi, On 10/20/2016 04:30 PM, Jani Nikula wrote: > On Thu, 20 Oct 2016, Lu Baolu wrote: >> Hi Jani, >> >> On 10/19/2016 03:48 PM, Jani Nikula wrote: >>> On Wed, 19 Oct 2016, Lu Baolu wrote: Add Documentation/usb/usb3-debug-port.txt. This document includes the user guide for USB3 debug po

[PATCH v2 3/8] crypto: doc - fix source comments for Sphinx

2016-10-20 Thread Stephan Mueller
Update comments to avoid any complaints from Sphinx during compilation. Signed-off-by: Stephan Mueller --- include/crypto/aead.h | 14 +++--- include/crypto/hash.h | 2 +- include/crypto/skcipher.h | 4 ++-- include/linux/crypto.h| 4 ++-- 4 files changed, 12 insertions(+)

[PATCH v2 6/8] crypto: doc - remove crypto_alloc_ablkcipher

2016-10-20 Thread Stephan Mueller
Remove the documentation reference to crypto_alloc_ablkcipher as the API function call was removed. Signed-off-by: Stephan Mueller --- Documentation/crypto/api-skcipher.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/Documentation/crypto/api-skcipher.rst b/Documentation/crypto/api-skc

[PATCH v2 7/8] crypto: doc - clarify AEAD memory structure

2016-10-20 Thread Stephan Mueller
The previous description have been misleading and partially incorrect. Reported-by: Harsh Jain Signed-off-by: Stephan Mueller --- crypto/algif_aead.c | 14 ++ include/crypto/aead.h | 36 2 files changed, 14 insertions(+), 36 deletions(-) diff

[PATCH v2 1/8] crypto: doc - convert crypto API documentation to Sphinx

2016-10-20 Thread Stephan Mueller
With the conversion of the kernel crypto API DocBook to Sphinx, the monolithic document is broken up into individual documents. The documentation is unchanged with the exception of a slight reordering to keep the individual document parts self-contained. Signed-off-by: Stephan Mueller --- Docume

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

2016-10-20 Thread Stephan Mueller
Hi, the attached patch set converts the existing crypto API documentation from DocBook to Sphinx. The first two patch sets perform the conversion without changes to the content of the documentation. Starting with patch 3, fixes and enhancements are applied. A full review of the new kernel crypto

[PATCH v2 8/8] crypto: doc - optimize compilation

2016-10-20 Thread Stephan Mueller
The :functions: definition allows the specification of multiple function references which prevents parsing the header file multiple times. Reported-by: Jani Nikula Signed-off-by: Stephan Mueller --- Documentation/crypto/api-aead.rst | 51 +--- Documentation/crypto/api-akcipher.rst

[PATCH v2 2/8] crypto: doc - remove crypto API DocBook

2016-10-20 Thread Stephan Mueller
With the conversion of the documentation to Sphinx, the old DocBook is now stale. Signed-off-by: Stephan Mueller --- Documentation/DocBook/Makefile|2 +- Documentation/DocBook/crypto-API.tmpl | 2092 - 2 files changed, 1 insertion(+), 2093 deletions(-

[PATCH v2 5/8] crypto: doc - add KPP documentation

2016-10-20 Thread Stephan Mueller
Add the KPP API documentation to the kernel crypto API Sphinx documentation. This addition includes the documentation of the ECDH and DH helpers which are needed to create the approrpiate input data for the crypto_kpp_set_secret function. Signed-off-by: Stephan Mueller --- Documentation/crypto/a

[PATCH v2 4/8] crypto: doc - fix separation of cipher / req API

2016-10-20 Thread Stephan Mueller
Keep the cipher API and the request API function documentation in separate sections. Signed-off-by: Stephan Mueller --- Documentation/crypto/api-akcipher.rst | 24 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/crypto/api-akcipher.rst b/Do