[PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST

2019-06-18 Thread Puranjay Mohan
This converts the plain text documentation to reStructuredText format. No essential content change. Signed-off-by: Puranjay Mohan --- Documentation/platform/x86-laptop-drivers.rst | 23 +++ Documentation/platform/x86-laptop-drivers.txt | 18 --- 2 files changed, 23 in

Re: [PATCH 12/14] doc-rst: add ABI documentation to the admin-guide book

2019-06-18 Thread Jani Nikula
On Mon, 17 Jun 2019, Mauro Carvalho Chehab wrote: > Yeah, I guess it should be possible to do that. How a python script > can identify if it was called by Sphinx, or if it was called directly? if __name__ == '__main__': # run on the command-line, not imported BR, Jani. -- Jani Nikula,

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Dave Martin
On Mon, Jun 17, 2019 at 02:20:40PM +0200, Thomas Gleixner wrote: > On Mon, 17 Jun 2019, Florian Weimer wrote: > > * Dave Martin: > > > On Tue, Jun 11, 2019 at 12:31:34PM -0700, Yu-cheng Yu wrote: > > >> We can probably check PT_GNU_PROPERTY first, and fallback (based on > > >> ld-linux > > >> vers

Re: [PATCH v5 1/2] arm64: Define Documentation/arm64/tagged-address-abi.txt

2019-06-18 Thread Szabolcs Nagy
On 13/06/2019 16:51, Vincenzo Frascino wrote: > On arm64 the TCR_EL1.TBI0 bit has been always enabled hence > the userspace (EL0) is allowed to set a non-zero value in the > top byte but the resulting pointers are not allowed at the > user-kernel syscall ABI boundary. > > With the relaxed ABI prop

Re: [PATCH v4 19/28] docs: powerpc: convert docs to ReST and rename to *.rst

2019-06-18 Thread Michael Ellerman
Jonathan Corbet writes: > On Wed, 12 Jun 2019 14:52:55 -0300 > Mauro Carvalho Chehab wrote: > >> Convert docs to ReST and add them to the arch-specific >> book. >> >> The conversion here was trivial, as almost every file there >> was already using an elegant format close to ReST standard. >> >>

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Peter Zijlstra
On Tue, Jun 18, 2019 at 10:12:50AM +0100, Dave Martin wrote: > On Mon, Jun 17, 2019 at 02:20:40PM +0200, Thomas Gleixner wrote: > > On Mon, 17 Jun 2019, Florian Weimer wrote: > > > * Dave Martin: > > > > On Tue, Jun 11, 2019 at 12:31:34PM -0700, Yu-cheng Yu wrote: > > > >> We can probably check PT_

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Florian Weimer
* Peter Zijlstra: > I'm not sure I read Thomas' comment like that. In my reading keeping the > PT_NOTE fallback is exactly one of those 'fly workarounds'. By not > supporting PT_NOTE only the 'fine' people already shit^Hpping this out > of tree are affected, and we don't have to care about them at

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Peter Zijlstra
On Tue, Jun 18, 2019 at 02:47:00PM +0200, Florian Weimer wrote: > * Peter Zijlstra: > > > I'm not sure I read Thomas' comment like that. In my reading keeping the > > PT_NOTE fallback is exactly one of those 'fly workarounds'. By not > > supporting PT_NOTE only the 'fine' people already shit^Hppin

Re: [PATCH v5 1/2] arm64: Define Documentation/arm64/tagged-address-abi.txt

2019-06-18 Thread Kevin Brodsky
I'm happy with the ABI overall, but I think we need a few more tweaks. On 13/06/2019 16:51, Vincenzo Frascino wrote: On arm64 the TCR_EL1.TBI0 bit has been always enabled hence the userspace (EL0) is allowed to set a non-zero value in the top byte but the resulting pointers are not allowed at th

Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST

2019-06-18 Thread Jonathan Corbet
On Tue, 18 Jun 2019 07:41:58 +0200 Greg KH wrote: > On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: > > This converts the plain text documentation to reStructuredText format. > > No essential content change. > > > > Signed-off-by: Puranjay Mohan > > --- > > Documentation/platfo

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Dave Martin
On Tue, Jun 18, 2019 at 02:55:12PM +0200, Peter Zijlstra wrote: > On Tue, Jun 18, 2019 at 02:47:00PM +0200, Florian Weimer wrote: > > * Peter Zijlstra: > > > > > I'm not sure I read Thomas' comment like that. In my reading keeping the > > > PT_NOTE fallback is exactly one of those 'fly workarounds

Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST

2019-06-18 Thread Greg KH
On Tue, Jun 18, 2019 at 07:17:17AM -0600, Jonathan Corbet wrote: > On Tue, 18 Jun 2019 07:41:58 +0200 > Greg KH wrote: > > > On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: > > > This converts the plain text documentation to reStructuredText format. > > > No essential content chan

[PATCH] docs/vm: hwpoison.rst: Fix quote formatting

2019-06-18 Thread Valentin Schneider
The asterisks prepended to the quoted text currently get translated to bullet points, which gets increasingly confusing the smaller your screen is (when viewing the sphinx output, that is). Convert the whole quote to a literal block. Signed-off-by: Valentin Schneider --- Documentation/vm/hwpois

Re: [Linux-kernel-mentees] [PATCH] Documentation: platform: convert x86-laptop-drivers.txt to reST

2019-06-18 Thread Shuah Khan
On 6/18/19 7:39 AM, Greg KH wrote: On Tue, Jun 18, 2019 at 07:17:17AM -0600, Jonathan Corbet wrote: On Tue, 18 Jun 2019 07:41:58 +0200 Greg KH wrote: On Tue, Jun 18, 2019 at 11:02:27AM +0530, Puranjay Mohan wrote: This converts the plain text documentation to reStructuredText format. No esse

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Yu-cheng Yu
On Tue, 2019-06-18 at 14:32 +0100, Dave Martin wrote: > On Tue, Jun 18, 2019 at 02:55:12PM +0200, Peter Zijlstra wrote: > > On Tue, Jun 18, 2019 at 02:47:00PM +0200, Florian Weimer wrote: > > > * Peter Zijlstra: > > > > > > > I'm not sure I read Thomas' comment like that. In my reading keeping the

Re: [PATCH v4 2/2] fTPM: add documentation for ftpm driver

2019-06-18 Thread Randy Dunlap
On 5/30/19 8:27 AM, Sasha Levin wrote: > This patch adds basic documentation to describe the new fTPM driver. > > Signed-off-by: Sasha Levin > Signed-off-by: Sasha Levin (Microsoft) > --- > Documentation/security/tpm/index.rst| 1 + > Documentation/security/tpm/tpm_ftpm_tee.rst | 31 ++

Re: [PATCH] docs/vm: hwpoison.rst: Fix quote formatting

2019-06-18 Thread Jonathan Corbet
On Tue, 18 Jun 2019 15:56:05 +0100 Valentin Schneider wrote: > The asterisks prepended to the quoted text currently get translated to > bullet points, which gets increasingly confusing the smaller your > screen is (when viewing the sphinx output, that is). > > Convert the whole quote to a litera

Re: [PATCH v2] kbuild: add support for ensuring headers are self-contained

2019-06-18 Thread Masahiro Yamada
On Wed, Jun 5, 2019 at 2:26 AM Sam Ravnborg wrote: > > On Tue, Jun 04, 2019 at 03:42:48PM +0300, Jani Nikula wrote: > > Sometimes it's useful to be able to explicitly ensure certain headers > > remain self-contained, i.e. that they are compilable as standalone > > units, by including and/or forwar

Re: [PATCH 00/15] kbuild: refactor headers_install and support compile-test of UAPI headers

2019-06-18 Thread Masahiro Yamada
On Tue, Jun 4, 2019 at 7:15 PM Masahiro Yamada wrote: > > > Multiple people have suggested to compile-test UAPI headers. > > Currently, Kbuild provides simple sanity checks by headers_check > but they are not enough to catch bugs. > > The most recent patch I know is David Howells' work: > https://

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Florian Weimer
* Yu-cheng Yu: > The kernel looks at only ld-linux. Other applications are loaded by > ld-linux. > So the issues are limited to three versions of ld-linux's. Can we somehow > update those?? I assumed that it would also parse the main executable and make adjustments based on that. ld.so can c

Re: [PATCH] docs/vm: hwpoison.rst: Fix quote formatting

2019-06-18 Thread Valentin Schneider
On 18/06/2019 16:31, Jonathan Corbet wrote: > On Tue, 18 Jun 2019 15:56:05 +0100 > Valentin Schneider wrote: > >> The asterisks prepended to the quoted text currently get translated to >> bullet points, which gets increasingly confusing the smaller your >> screen is (when viewing the sphinx outpu

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Yu-cheng Yu
On Tue, 2019-06-18 at 17:49 +0200, Florian Weimer wrote: > * Yu-cheng Yu: > > > The kernel looks at only ld-linux. Other applications are loaded by ld- > > linux. > > So the issues are limited to three versions of ld-linux's. Can we somehow > > update those?? > > I assumed that it would also p

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Florian Weimer
* Yu-cheng Yu: >> I assumed that it would also parse the main executable and make >> adjustments based on that. > > Yes, Linux also looks at the main executable's header, but not its > NT_GNU_PROPERTY_TYPE_0 if there is a loader. > >> >> ld.so can certainly provide whatever the kernel needs. We

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Yu-cheng Yu
On Tue, 2019-06-18 at 18:05 +0200, Florian Weimer wrote: > * Yu-cheng Yu: > > > > I assumed that it would also parse the main executable and make > > > adjustments based on that. > > > > Yes, Linux also looks at the main executable's header, but not its > > NT_GNU_PROPERTY_TYPE_0 if there is a lo

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Dave Martin
On Tue, Jun 18, 2019 at 09:00:35AM -0700, Yu-cheng Yu wrote: > On Tue, 2019-06-18 at 18:05 +0200, Florian Weimer wrote: > > * Yu-cheng Yu: > > > > > > I assumed that it would also parse the main executable and make > > > > adjustments based on that. > > > > > > Yes, Linux also looks at the main e

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Florian Weimer
* Dave Martin: > On Tue, Jun 18, 2019 at 09:00:35AM -0700, Yu-cheng Yu wrote: >> On Tue, 2019-06-18 at 18:05 +0200, Florian Weimer wrote: >> > * Yu-cheng Yu: >> > >> > > > I assumed that it would also parse the main executable and make >> > > > adjustments based on that. >> > > >> > > Yes, Linux

Re: [PATCH v7 22/27] binfmt_elf: Extract .note.gnu.property from an ELF file

2019-06-18 Thread Dave Martin
On Tue, Jun 18, 2019 at 06:25:51PM +0200, Florian Weimer wrote: > * Dave Martin: > > > On Tue, Jun 18, 2019 at 09:00:35AM -0700, Yu-cheng Yu wrote: > >> On Tue, 2019-06-18 at 18:05 +0200, Florian Weimer wrote: > >> > * Yu-cheng Yu: > >> > > >> > > > I assumed that it would also parse the main exe

[PATCH 2/6] docs: trace: add a missing blank line

2019-06-18 Thread Mauro Carvalho Chehab
Sphinx expects a blank line after a literal block markup. Signed-off-by: Mauro Carvalho Chehab --- Documentation/trace/kprobetrace.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst index 3d162d432a3c..caa0a8ba081e 1

[PATCH 5/6] docs: signal: fix a kernel-doc markup

2019-06-18 Thread Mauro Carvalho Chehab
The kernel-doc parser doesn't handle expressions with %foo*. Instead, when an asterisk should be part of a constant, it uses an alternative notation: `foo*`. Signed-off-by: Mauro Carvalho Chehab --- kernel/signal.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kernel/signal

[PATCH 3/6] lib: list_sort.c: add a blank line to avoid kernel-doc warnings

2019-06-18 Thread Mauro Carvalho Chehab
In order for a list to be recognized as such, blank lines are required. Solve those Sphinx warnings: ./lib/list_sort.c:162: WARNING: Unexpected indentation. ./lib/list_sort.c:163: WARNING: Block quote ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab --- lib

[PATCH 4/6] time: hrtimer: use a bullet for the returns bullet list

2019-06-18 Thread Mauro Carvalho Chehab
That gets rid of this warning: ./kernel/time/hrtimer.c:1119: WARNING: Block quote ends without a blank line; unexpected unindent. and displays nicely both at the source code and at the produced documentation. Signed-off-by: Mauro Carvalho Chehab --- kernel/time/hrtimer.c | 7 ---

[PATCH 1/6] docs: trace: fix a broken label

2019-06-18 Thread Mauro Carvalho Chehab
Sphinx warnings about his: Documentation/trace/kprobetrace.rst:68: WARNING: undefined label: user_mem_access (if the link has no caption the label must precede a section header) The problem is quite simple: Sphinx wants a blank line after references. Signed-off-by: Mauro Carvalho Cheha

[PATCH 6/6] drivers: base/node.c: fixes a kernel-doc markups

2019-06-18 Thread Mauro Carvalho Chehab
There was a typo at the name of the vars inside the kernel-doc comment, causing those warnings: ./drivers/base/node.c:690: warning: Function parameter or member 'mem_nid' not described in 'register_memory_node_under_compute_node' ./drivers/base/node.c:690: warning: Function parame

[PATCH v2 6/6] drivers: base/node.c: fixes a kernel-doc markups

2019-06-18 Thread Mauro Carvalho Chehab
There was a typo at the name of the vars inside the kernel-doc comment, causing those warnings: ./drivers/base/node.c:690: warning: Function parameter or member 'mem_nid' not described in 'register_memory_node_under_compute_node' ./drivers/base/node.c:690: warning: Function parame

Re: [PATCH 2/6] docs: trace: add a missing blank line

2019-06-18 Thread Steven Rostedt
On Tue, 18 Jun 2019 15:51:18 -0300 Mauro Carvalho Chehab wrote: > Sphinx expects a blank line after a literal block markup. > > Signed-off-by: Mauro Carvalho Chehab For the two tracing patches (1 and 2). Acked-by: Steven Rostedt (VMware) -- Steve > --- > Documentation/trace/kprobetrace.rs

Re: [PATCH v4 00/28] Convert files to ReST - part 1

2019-06-18 Thread Mauro Carvalho Chehab
Em Fri, 14 Jun 2019 14:36:40 -0600 Jonathan Corbet escreveu: > On Wed, 12 Jun 2019 14:52:36 -0300 > Mauro Carvalho Chehab wrote: > > > This is mostly a rebase of the /33 series v3 I sent, on the top of the > > latest > > linux-next (next-20190612). > > > > Changes from v3: > > > > - dropped

Re: [PATCH] docs/vm: hwpoison.rst: Fix quote formatting

2019-06-18 Thread Jonathan Corbet
On Tue, 18 Jun 2019 16:51:06 +0100 Valentin Schneider wrote: > I'm afraid this was only a "drive-by" patch, as I just happened to skim > through this page on my phone while waiting for a meeting - I'm quite > clueless about page poisoning. No worries. Thanks for the patch; it makes things bette

[PATCH v2 25/29] docs: md: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the md documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Ca

[PATCH v2 12/29] docs: xen-tpmfront.txt: convert it to .rst

2019-06-18 Thread Mauro Carvalho Chehab
In order to be able to add this file to the security book, we need first to convert it to reST. While this is not part of any book, mark it as :orphan:, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab --- .../{xen-tpmfront.txt => xen-tpmfront.rst}| 103 ++-

[PATCH v2 03/29] docs: lp855x-driver.txt: convert to ReST and move to kernel-api

2019-06-18 Thread Mauro Carvalho Chehab
This small file seems to be an attempt to start documenting backlight drivers. It contains descriptions of the controls for the driver with could sound as an somewhat user-faced description, but it's main focus is to describe, instead, the data that should be passed via platform data and some driv

[PATCH v2 08/29] docs: early-userspace: convert docs to ReST and rename to *.rst

2019-06-18 Thread Mauro Carvalho Chehab
The two files there describes a Kernel API feature, used to support early userspace stuff. Prepare for moving them to the kernel API book by converting to ReST format. The conversion itself was quite trivial: just add/mark a few titles as such, add a literal block markup, add a table markup and a

[PATCH v2 09/29] docs: driver-model: convert docs to ReST and rename to *.rst

2019-06-18 Thread Mauro Carvalho Chehab
Convert the various documents at the driver-model, preparing them to be part of the driver-api book. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups

[PATCH v2 07/29] docs: pti_intel_mid.txt: convert it to pti_intel_mid.rst

2019-06-18 Thread Mauro Carvalho Chehab
Convert this small file to ReST format and rename it. Most of the conversion were related to adjusting whitespaces in order for each section to be properly parsed. While this is not part of any book, mark it as :orphan:, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab ---

[PATCH v2 24/29] docs: nfc: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the nfc documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro C

[PATCH v2 05/29] docs: cma/debugfs.txt: convert docs to ReST and rename to *.rst

2019-06-18 Thread Mauro Carvalho Chehab
The debugfs interface for CMA should be there together with other mm-related documents. Convert this small file to ReST and move it to its rightful place. The conversion is actually quite simple: just add a title for the document. In order to make it to look better for the audience, also mark the

[PATCH v2 28/29] docs: xtensa: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the xtensa documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Maur

[PATCH v2 13/29] docs: bus-devices: ti-gpmc.rst: convert it to ReST

2019-06-18 Thread Mauro Carvalho Chehab
In order to be able to add this file to a book, it needs first to be converted to ReST and renamed. While this is not part of any book, mark it as :orphan:, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab --- .../bus-devices/{ti-gpmc.txt => ti-gpmc.rst} | 159 +++

[PATCH v2 01/29] docs: connector: convert to ReST and rename to connector.rst

2019-06-18 Thread Mauro Carvalho Chehab
As it has some function definitions, move them to connector.h. The remaining conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let

[PATCH v2 20/29] docs: leds: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the leds documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro

[PATCH v2 00/29] Convert files to ReST - part 2

2019-06-18 Thread Mauro Carvalho Chehab
This is the second part of a series I wrote sometime ago where I manually convert lots of files to be properly parsed by Sphinx as ReST files. As it touches on lot of stuff, this series is based on today's linux-next, at tag next-20190617. The first version of this series had 57 patches. The fir

[PATCH v2 16/29] docs: rbtree.txt: fix Sphinx build warnings

2019-06-18 Thread Mauro Carvalho Chehab
Ths file is already at ReST format. Yet, some recent changes made it to produce a few warnings when building it with Sphinx. Those are trivially fixed by marking some literal blocks. Fix them before adding it to the docs building system. Signed-off-by: Mauro Carvalho Chehab --- Documentation/r

[PATCH v2 21/29] docs: laptops: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the laptops documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mau

[PATCH v2 19/29] docs: ia64: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the ia64 documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. There are two upper case file names. Rename them to lower case, as we're working to avoid upper case file names at Documentation. At its new index.rst,

[PATCH v2 04/29] docs: m68k: convert docs to ReST and rename to *.rst

2019-06-18 Thread Mauro Carvalho Chehab
Convert the m68k kernel-options.txt file to ReST. The conversion is trivial, as the document is already on a format close enough to ReST. Just some small adjustments were needed in order to make it both good for being parsed while keeping it on a good txt shape. At its new index.rst, let's add a

[PATCH v2 26/29] docs: mtd: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the mtd documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. It should be noticed that Sphinx doesn't handle very well URLs with dots in the middle. Thankfully, internally, the '.' char is translated to %2E, so we

[PATCH v2 02/29] docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst

2019-06-18 Thread Mauro Carvalho Chehab
This small text file describes the usage of parallel port LCD displays from userspace PoV. So, a good candidate for the admin guide. While this is not part of the admin-guide book, mark it as :orphan:, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab --- .../{lcd-panel-cgr

[PATCH v2 18/29] docs: accounting: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the accounting documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by:

[PATCH v2 17/29] docs: DMA-API-HOWTO.txt: fix an unmarked code block

2019-06-18 Thread Mauro Carvalho Chehab
When building with Sphinx, it would produce this warning: docs/Documentation/DMA-API-HOWTO.rst:222: WARNING: Definition list ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DMA-API-HOWTO.txt | 2 +- 1 file changed, 1 insertion(+), 1 de

[PATCH v2 29/29] docs: mmc: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the mmc documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro C

[PATCH v2 22/29] docs: iio: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the iio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro C

[PATCH v2 15/29] docs: phy: convert samsung-usb2.txt to ReST format

2019-06-18 Thread Mauro Carvalho Chehab
In order to merge it into a Sphinx book, we need first to convert to ReST. While this is not part of any book, mark it as :orphan:, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab --- .../{samsung-usb2.txt => samsung-usb2.rst}| 62 ++- MAINTAINERS

[PATCH v2 27/29] docs: nvdimm: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the nvdimm documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Maur

[PATCH v2 23/29] docs: namespaces: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the namespaces documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. There are two upper case file names. Rename them to lower case, as we're working to avoid upper case file names at Documentation. At its new inde

[PATCH v2 11/29] docs: memory-devices: convert ti-emif.txt to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Prepare this file to be moved to a kernel book by converting it to ReST format and renaming it to ti-emif.rst. While this is not part of any book, mark it as :orphan:, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab --- .../{ti-emif.txt => ti-emif.rst} | 27 +

[PATCH v2 14/29] docs: nvmem: convert docs to ReST and rename to *.rst

2019-06-18 Thread Mauro Carvalho Chehab
In order to be able to add it into a doc book, we need first convert it to ReST. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - mark literal blocks; - adjust title markups. While this is not part of any book, mark it as :orphan:, in order to

[PATCH v1 10/22] docs: security: move some books to it and update

2019-06-18 Thread Mauro Carvalho Chehab
The following files belong to security: Documentation/security/LSM.rst -> Documentation/security/lsm-development.rst Documentation/lsm.txt -> Documentation/security/lsm.rst Documentation/SAK.txt -> Documentation/security/sak.rst Documentation/siphash.txt -> Documentation/security/siphash.r

[PATCH v1 05/22] docs: rapidio: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the rapidio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mau

[PATCH v1 19/22] docs: driver-api: add remaining converted dirs to it

2019-06-18 Thread Mauro Carvalho Chehab
There are a number of driver-specific descriptions that contain a mix of userspace and kernelspace documentation. Just like we did with other similar subsystems, add them at the driver-api groupset, but don't move the directories. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst

[PATCH v1 18/22] docs: admin-guide: move sysctl directory to it

2019-06-18 Thread Mauro Carvalho Chehab
The stuff under sysctl describes /sys interface from userspace point of view. So, add it to the admin-guide and remove the :orphan: from its index file. Signed-off-by: Mauro Carvalho Chehab --- CREDITS | 2 +- Documentation/admin-guide/index.rst

[PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api

2019-06-18 Thread Mauro Carvalho Chehab
While there are a mix of things here, most of the stuff were written from Kernel developer's PoV. So, add them to the driver-api book. A follow up for this patch would be to move documents from there that are specific to sysadmins, adding them to the admin-guide. Signed-off-by: Mauro Carvalho Che

[PATCH v1 08/22] docs: sysctl: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the /proc/sys/ documentation files to ReST, using the README file as a template for an index.rst, adding the other files there via TOC markup. Despite being written on different times with different styles, try to make them somewhat coherent with a similar look and feel, ensuring that they'

[PATCH v1 22/22] admin-guide: add kdump documentation into it

2019-06-18 Thread Mauro Carvalho Chehab
The Kdump documentation describes procedures with admins use in order to solve issues on their systems. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/bug-hunting.rst| 4 ++-- Documentation/admin-guide/index.rst | 1 + Documentation/{ => admin-gui

[PATCH v1 04/22] docs: thermal: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the thermal documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mau

[PATCH v1 03/22] docs: ioctl: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the iio documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. The cdrom.txt and hdio.txt have their own particular syntax. In order to speedup the conversion, I used a small ancillary perl script: my $d;

[PATCH v1 13/22] docs: x86: move two x86-specific files to x86 arch dir

2019-06-18 Thread Mauro Carvalho Chehab
Those two docs belong to the x86 architecture. Signed-off-by: Mauro Carvalho Chehab --- Documentation/x86/index.rst| 2 ++ Documentation/{Intel-IOMMU.rst => x86/intel-iommu.rst} | 1 - Documentation/{ => x86}/intel_txt.rst | 1 - MAINTAINERS

[PATCH v1 09/22] docs: block: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the block documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro

[PATCH v1 06/22] docs: blockdev: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the blockdev documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. The drbd sub-directory contains some graphs and data flows. Add those too to the documentation. At its new index.rst, let's add a :orphan: while th

[PATCH v1 20/22] docs: extcon: move it to acpi dir and convert it to ReST

2019-06-18 Thread Mauro Carvalho Chehab
The intel-int3496.txt file is a documentation for an ACPI driver. There's no reason to keep it on a separate directory. So, instead of keeping it on some random location, move it to a sub-directory inside the ACPI documentation dir. For now, keep it with .txt extension, in order to avoid Sphinx

[PATCH v1 02/22] docs: ioctl-number.txt: convert it to ReST format

2019-06-18 Thread Mauro Carvalho Chehab
The conversion itself is simple: add a markup for the title of this file and add markups for both tables. Yet, the big table here with IOCTL numbers is badly formatted: on several lines, the "Include File" column has some values that are bigger than the reserved space there. Also, on several plac

[PATCH v1 07/22] docs: perf: convert to ReST

2019-06-18 Thread Mauro Carvalho Chehab
Rename the perf documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro

[PATCH v1 00/22] Convert files to ReST - part 3

2019-06-18 Thread Mauro Carvalho Chehab
This is the third part of a series I wrote sometime ago where I manually convert lots of files to be properly parsed by Sphinx as ReST files. As it touches on lot of stuff, this series is based on today's linux-next, at tag next-20190617. The first version of this series had 57 patches. The firs

[PATCH v1 21/22] docs: admin-guide: add laptops documentation

2019-06-18 Thread Mauro Carvalho Chehab
The docs under Documentation/laptops contain users specific information. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/testing/sysfs-block-device | 2 +- Documentation/ABI/testing/sysfs-platform-asus-laptop | 2 +- Documentation/admin-guide/index.rst

[PATCH v1 15/22] docs: driver-api: add a chapter for memory-related API

2019-06-18 Thread Mauro Carvalho Chehab
There are some DMA files under the main dir. Move them to the new chapter and add an index file for them. Signed-off-by: Mauro Carvalho Chehab --- Documentation/PCI/pci.rst| 6 +++--- Documentation/block/biodoc.rst | 2 +- .../driver-api/bus-virt-phys-

[PATCH v1 17/22] docs: add arch doc directories to the index

2019-06-18 Thread Mauro Carvalho Chehab
Now that several arch documents were converted to ReST, add their indexes to Documentation/index.rst and remove the :orphan: from them. Signed-off-by: Mauro Carvalho Chehab --- Documentation/arm/index.rst| 2 -- Documentation/arm64/index.rst | 2 -- Documentation/ia64/index.rst | 2 --

[PATCH v1 16/22] docs: driver-api: add xilinx driver API documentation

2019-06-18 Thread Mauro Carvalho Chehab
The current file there (emmi) provides a description of the driver uAPI and kAPI. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/index.rst | 1 + Documentation/{ => driver-api}/xilinx/eemi.rst | 0 Documentation/{ => driver-api}/xilinx/index.rst | 1 - 3 files ch

Re: [PATCH v2 02/29] docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst

2019-06-18 Thread Miguel Ojeda
On Tue, Jun 18, 2019 at 10:56 PM Mauro Carvalho Chehab wrote: > > This small text file describes the usage of parallel port LCD > displays from userspace PoV. So, a good candidate for the > admin guide. > > While this is not part of the admin-guide book, mark it as > :orphan:, in order to avoid bu

Re: [PATCH v2 02/29] docs: lcd-panel-cgram.txt: convert docs to ReST and rename to *.rst

2019-06-18 Thread Mauro Carvalho Chehab
Em Tue, 18 Jun 2019 23:14:01 +0200 Miguel Ojeda escreveu: > On Tue, Jun 18, 2019 at 10:56 PM Mauro Carvalho Chehab > wrote: > > > > This small text file describes the usage of parallel port LCD > > displays from userspace PoV. So, a good candidate for the > > admin guide. > > > > While this is n

Re: [PATCH v4 23/28] docs: target: convert docs to ReST and rename to *.rst

2019-06-18 Thread Martin K. Petersen
Mauro, > Convert the TCM docs to ReST format and add them to the > bookset. Looks good to me. Acked-by: Martin K. Petersen -- Martin K. Petersen Oracle Linux Engineering

[PATCH] docs: fb: Add TER16x32 to the available font names

2019-06-18 Thread Takashi Iwai
The new font is available since recently. Signed-off-by: Takashi Iwai --- Documentation/fb/fbcon.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/fb/fbcon.rst b/Documentation/fb/fbcon.rst index cfb9f7c38f18..1da65b9000de 100644 --- a/Documentation/fb/fbcon.rs

Re: [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api

2019-06-18 Thread Felipe Balbi
Mauro Carvalho Chehab writes: > While there are a mix of things here, most of the stuff > were written from Kernel developer's PoV. So, add them to > the driver-api book. > > A follow up for this patch would be to move documents from > there that are specific to sysadmins, adding them to the > ad

Re: [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api

2019-06-18 Thread Greg Kroah-Hartman
On Tue, Jun 18, 2019 at 06:05:38PM -0300, Mauro Carvalho Chehab wrote: > While there are a mix of things here, most of the stuff > were written from Kernel developer's PoV. So, add them to > the driver-api book. > > A follow up for this patch would be to move documents from > there that are specif

Re: [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api

2019-06-18 Thread Greg Kroah-Hartman
On Tue, Jun 18, 2019 at 06:05:38PM -0300, Mauro Carvalho Chehab wrote: > While there are a mix of things here, most of the stuff > were written from Kernel developer's PoV. So, add them to > the driver-api book. > > A follow up for this patch would be to move documents from > there that are specif