Re: [PATCH 21/36] fs: locks: Fix some troubles at kernel-doc comments

2017-05-13 Thread Mauro Carvalho Chehab
Hi Jeff, Em Fri, 12 May 2017 10:02:56 -0400 Jeff Layton escreveu: > On Fri, 2017-05-12 at 11:00 -0300, Mauro Carvalho Chehab wrote: > > There are a few syntax violations that cause outputs of > > a few comments to not be properly parsed in ReST format. > > > > No functional changes. > > > > Si

Re: [PATCH 03/36] docs-rst: convert kernel-locking to ReST

2017-05-13 Thread Mauro Carvalho Chehab
Em Fri, 12 May 2017 18:57:13 +0200 Markus Heiser escreveu: > Am 12.05.2017 um 15:59 schrieb Mauro Carvalho Chehab > : > > > Use pandoc to convert documentation to ReST by calling > > Documentation/sphinx/tmplcvt script. > > > > - Manually adjust tables with got broken by conversion > > > > Si

Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST

2017-05-13 Thread Mauro Carvalho Chehab
Em Fri, 12 May 2017 15:19:17 -0700 Darren Hart escreveu: > On Sat, May 13, 2017 at 12:11:09AM +0200, Peter Zijlstra wrote: > > On Fri, May 12, 2017 at 06:51:50PM -0300, Mauro Carvalho Chehab wrote: > > > > * Return: > > > > * * 0 - ready to wait > > > > * * 1 - acquired the lock > > > >

Re: [PATCH 01/36] docs-rst: convert kernel-hacking to ReST

2017-05-13 Thread Mauro Carvalho Chehab
Em Fri, 12 May 2017 18:35:29 +0200 Markus Heiser escreveu: > Am 12.05.2017 um 15:59 schrieb Mauro Carvalho Chehab > : > > > Use pandoc to convert documentation to ReST by calling > > Documentation/sphinx/tmplcvt script. > > > > - Manually adjusted to use ..note and ..warning > > - Minor fixes

[PATCH 2/5] docs-rst: convert mtdnand book to ReST

2017-05-13 Thread Mauro Carvalho Chehab
Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. The tables were manually adjusted to fit into 80 columns. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile |1 - Documentation/DocBook/mtdnand.tmpl | 1291 -

[PATCH 3/5] mtdnand.rst: Fix some typos and group the "::" with previous line

2017-05-13 Thread Mauro Carvalho Chehab
Typo: ored -> ordered While here, group the :: with the previous paragraph, in order to make it visually better when reading as a text file. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/mtdnand.rst | 24 +++- 1 file changed, 7 insertions(+), 17 d

[PATCH 5/5] docs-rst: convert sh book to ReST

2017-05-13 Thread Mauro Carvalho Chehab
Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile | 4 +- Documentation/DocBook/sh.tmpl | 105 - Documentation/conf.py | 2 + Do

[PATCH 4/5] mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings

2017-05-13 Thread Mauro Carvalho Chehab
./drivers/mtd/nand/nand_bbt.c:1: warning: no structured comments found ./include/linux/mtd/nand.h:785: ERROR: Unexpected indentation. ./drivers/mtd/nand/nand_base.c:449: WARNING: Definition list ends without a blank line; unexpected unindent. ./drivers/mtd/nand/nand_base.c:1161: ERROR: Unexpected

[PATCH 1/5] docs-rst: convert librs book to ReST

2017-05-13 Thread Mauro Carvalho Chehab
Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile | 2 +- Documentation/DocBook/librs.tmpl | 289 --- Documentation/core-api/index.rst | 1 +

[PATCH 0/5] Convert more books to ReST

2017-05-13 Thread Mauro Carvalho Chehab
This patch series convert the following books to ReST: - librs - mtdnand - sh And it is based on my previous series of conversion patches. After this series, there will be just one DocBook pending conversion: - lsm (Linux Security Modules) This book is very outdat

[PATCH 00/17] convert/reorganize Documentation/security/

2017-05-13 Thread Kees Cook
Hi, This ReSTifies everything under Documentation/security/, and reorganizes some of it (mainly the LSMs) under /admin-guide/ per Jon's request. Since /security/ is already being indexed under the kernel development portion of the sphinx index, I didn't move it, keeping only things that were direc

[PATCH 01/17] doc: ReSTify seccomp_filter.txt

2017-05-13 Thread Kees Cook
This updates seccomp_filter.txt for ReST markup, and moves it under the user-space API index, since it describes how application author can use seccomp. Signed-off-by: Kees Cook --- Documentation/userspace-api/index.rst | 1 + .../seccomp_filter.rst}| 1

[PATCH 15/17] doc: ReSTify keys-ecryptfs.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under keys security devel index. Cc: David Howells Cc: Tyler Hicks Signed-off-by: Kees Cook --- Documentation/security/00-INDEX | 2 -- .../security/{keys-ecryptfs.txt => keys/ecryptfs.rst} | 19 --- Documentation/securit

[PATCH 14/17] doc: ReSTify keys.txt

2017-05-13 Thread Kees Cook
This creates a new section in the security development index for kernel keys, and adjusts for ReST markup. Cc: David Howells Signed-off-by: Kees Cook --- Documentation/crypto/asymmetric-keys.txt | 2 +- Documentation/security/00-INDEX| 2 - Documentation/securi

[PATCH 16/17] doc: ReSTify keys-request-key.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under keys security devel index. Cc: David Howells Signed-off-by: Kees Cook --- Documentation/filesystems/nfs/idmapper.txt | 2 +- Documentation/networking/dns_resolver.txt | 2 +- Documentation/security/00-INDEX| 2 - Do

[PATCH 12/17] doc: ReSTify LoadPin.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under LSM admin guide. Signed-off-by: Kees Cook --- .../{security/LoadPin.txt => admin-guide/LSM/LoadPin.rst}| 12 Documentation/admin-guide/LSM/index.rst | 1 + MAINTAINERS

[PATCH 13/17] doc: ReSTify Smack.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under LSM admin guide. Cc: Casey Schaufler Signed-off-by: Kees Cook --- .../Smack.txt => admin-guide/LSM/Smack.rst}| 273 ++--- Documentation/admin-guide/LSM/index.rst| 1 + Documentation/security/00-INDEX

[PATCH 11/17] doc: ReSTify Yama.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under LSM admin guide. Signed-off-by: Kees Cook --- .../Yama.txt => admin-guide/LSM/Yama.rst} | 55 -- Documentation/admin-guide/LSM/index.rst| 1 + Documentation/security/00-INDEX| 2 - MAINTAINERS

[PATCH 17/17] doc: ReSTify keys-trusted-encrypted.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under keys security devel index. Cc: David Howells Cc: Mimi Zohar Signed-off-by: Kees Cook --- Documentation/security/00-INDEX| 4 --- Documentation/security/conf.py | 8 -- Documentation/security/keys/index.rst

[PATCH 09/17] doc: ReSTify apparmor.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under LSM admin guide. Cc: John Johansen Signed-off-by: Kees Cook --- .../apparmor.txt => admin-guide/LSM/apparmor.rst} | 36 ++ Documentation/admin-guide/LSM/index.rst| 1 + Documentation/security/00-INDEX|

[PATCH 07/17] doc: ReSTify and split LSM.txt

2017-05-13 Thread Kees Cook
The existing LSM.txt file covered both usage and development, so split this into two files, one under admin-guide and one under kernel development. Cc: James Morris Signed-off-by: Kees Cook --- .../LSM.txt => admin-guide/LSM/index.rst} | 22 ++ Documentation/admin-g

[PATCH 10/17] doc: ReSTify tomoyo.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under LSM admin guide. Cc: Tetsuo Handa Signed-off-by: Kees Cook --- Documentation/admin-guide/LSM/index.rst| 1 + .../tomoyo.txt => admin-guide/LSM/tomoyo.rst} | 22 -- Documentation/security/00-INDEX|

[PATCH 08/17] doc: ReSTify SELinux.txt

2017-05-13 Thread Kees Cook
Adjusts for ReST markup and moves under LSM admin guide. Cc: Paul Moore Signed-off-by: Kees Cook --- .../SELinux.txt => admin-guide/LSM/SELinux.rst}| 18 -- Documentation/admin-guide/LSM/index.rst| 5 + Documentation/security/00-INDEX

[PATCH 02/17] doc: ReSTify no_new_privs.txt

2017-05-13 Thread Kees Cook
This updates no_new_privs documentation to ReST markup and adds it to the user-space API documentation. Signed-off-by: Kees Cook --- Documentation/userspace-api/index.rst | 1 + .../no_new_privs.rst} | 44 -- 2 files changed, 26 inse

[PATCH 05/17] doc: ReSTify self-protection.txt

2017-05-13 Thread Kees Cook
This updates the credentials API documentation to ReST markup and moves it under the security subsection of kernel API documentation. Signed-off-by: Kees Cook --- Documentation/security/index.rst | 1 + .../{self-protection.txt => self-protection.rst} | 99 ++

[PATCH 06/17] doc: security: minor cleanups to build kernel-doc

2017-05-13 Thread Kees Cook
These fixes were needed to parse lsm_hooks.h kernel-doc. More work is needed, but this is the first step. Cc: Casey Schaufler Signed-off-by: Kees Cook --- include/linux/lsm_hooks.h | 25 - 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/include/linux/lsm_

[PATCH 03/17] doc: ReSTify IMA-templates.txt

2017-05-13 Thread Kees Cook
Adjust IMA-templates.txt for ReST markup and add to the index for security/, under the Kernel API Documentation. Cc: Mimi Zohar Signed-off-by: Kees Cook --- Documentation/security/00-INDEX| 2 - .../{IMA-templates.txt => IMA-templates.rst} | 46 --

[PATCH 04/17] doc: ReSTify credentials.txt

2017-05-13 Thread Kees Cook
This updates the credentials API documentation to ReST markup and moves it under the security subsection of kernel API documentation. Cc: David Howells Signed-off-by: Kees Cook --- Documentation/security/00-INDEX| 2 - .../security/{credentials.txt => credentials.rst} | 2

[PATCH V4] cfg80211: add request id to cfg80211_sched_scan_*() api

2017-05-13 Thread Markus Heiser
Hi Arend, I guess there is a typo in your kernel-doc comment [1]: modified include/net/cfg80211.h @@ -1666,6 +1666,7 @@ struct cfg80211_bss_select_adjust { * (others are filtered out). * If ommited, all results are passed. * @n_match_sets: number of match sets + * @results_wk

[PATCH] core-api: remove an unexpected unident

2017-05-13 Thread Markus Heiser
As complained by Sphinx: Documentation/core-api/assoc_array.rst:13: WARNING: Enumerated list ends without a blank line; unexpected unindent. This was already addressed, but not really fixed in 2ba90ccca7. Signed-off-by: Markus Heiser --- Documentation/core-api/assoc_array.rst | 5 -

[PATCH] doc-rst: fix inline emphasis in unshare.rst

2017-05-13 Thread Markus Heiser
The asterisk of the pointer is interpreted as a start tag for inline emphasis. Asterisks which are not Sphinx markup need to be quoted in rst-files. This fixes the Sphinx warning: Documentation/userspace-api/unshare.rst:108: WARNING: Inline emphasis start-string without end-string. Signed-off-by

[PATCH] doc-rst: fixed kernel-doc directives in usb/typec.rst

2017-05-13 Thread Markus Heiser
Even if this file is not yet included in any toctree, it is parsed by Sphinx since it is named '.rst'. This patch fixes the following two ERRORs from Sphinx build: Documentation/usb/typec.rst:116: ERROR: Error in "kernel-doc" directive: invalid option block. .. kernel-doc:: drivers/usb/typec/type

Re: [PATCH 09/17] doc: ReSTify apparmor.txt

2017-05-13 Thread John Johansen
On 05/13/2017 04:51 AM, Kees Cook wrote: > Adjusts for ReST markup and moves under LSM admin guide. > > Cc: John Johansen > Signed-off-by: Kees Cook Acked-by: John Johansen > --- > .../apparmor.txt => admin-guide/LSM/apparmor.rst} | 36 > ++ > Documentation/admin-guide/L