Re: [PATCH] docs: maintainer: discourage taking conversations off-list

2024-07-12 Thread Mauro Carvalho Chehab
Em Fri, 12 Jul 2024 09:42:07 -0600 Shuah Khan escreveu: > On 7/12/24 09:25, Mark Brown wrote: > > On Fri, Jul 12, 2024 at 07:49:03AM -0700, Jakub Kicinski wrote: > > > >> +Open development > >> + > >> + > >> +Discussions about user reported issues, and development of new code >

Re: [PATCH] docs: maintainer: discourage taking conversations off-list

2024-07-13 Thread Mauro Carvalho Chehab
Em Fri, 12 Jul 2024 16:45:04 -0700 Jakub Kicinski escreveu: > On Fri, 12 Jul 2024 20:11:56 +0200 Mauro Carvalho Chehab wrote: > > Not sure what this somewhat obscure message wants to accomplish. > > > > It is quite common to have developers and maintainers discussing >

Re: [PATCH] docs: maintainer: discourage taking conversations off-list

2024-07-13 Thread Mauro Carvalho Chehab
Em Fri, 12 Jul 2024 17:05:58 -0700 Jakub Kicinski escreveu: > On Fri, 12 Jul 2024 11:43:14 -0700 Dan Williams wrote: > > This reads as a vague ambiguous quasi-threat with no actionable way to > > enforce it. In contrast, successful maintainers already have a sense of > > the benefits of pushing d

Re: [PATCH] docs: maintainer: discourage taking conversations off-list

2024-07-13 Thread Mauro Carvalho Chehab
Em Sat, 13 Jul 2024 17:19:56 +0300 Laurent Pinchart escreveu: > On Sat, Jul 13, 2024 at 10:13:28AM +0200, Mauro Carvalho Chehab wrote: > > Em Fri, 12 Jul 2024 17:05:58 -0700 Jakub Kicinski escreveu: > > > On Fri, 12 Jul 2024 11:43:14 -0700 Dan Williams wrote: > > &

Re: [PATCH] docs: maintainer: discourage taking conversations off-list

2024-07-13 Thread Mauro Carvalho Chehab
Em Sat, 13 Jul 2024 09:28:31 -0500 Carlos Bilbao escreveu: > On 7/12/24 09:49, Jakub Kicinski wrote: > > > Multiple vendors seem to prefer taking discussions off list, and > > ask contributors to work with them privately rather than just send > > patches to the list. I'd imagine this is because

Re: [PATCH] docs: submitting-patches: Advertise b4

2024-09-03 Thread Mauro Carvalho Chehab
Em Tue, 03 Sep 2024 23:42:04 +0100 Mark Brown escreveu: > b4 is now widely used and is quite helpful for a lot of the things that > submitting-patches covers, let's advertise it to submitters to try to make > their lives easier and reduce the number of procedural issues maintainers > see. > > Si

Re: [PATCH 24/43] docs: leds: convert to ReST

2019-07-06 Thread Mauro Carvalho Chehab
Em Fri, 28 Jun 2019 21:01:40 +0200 Jacek Anaszewski escreveu: > Hi Mauro, > > On 6/28/19 2:20 PM, Mauro Carvalho Chehab wrote: > > Rename the leds documentation files to ReST, add an > > index for them and adjust in order to produce a nice html > > output

Re: [PATCH 01/43] docs: infiniband: convert docs to ReST and rename to *.rst

2019-07-06 Thread Mauro Carvalho Chehab
Em Wed, 3 Jul 2019 15:06:41 -0300 Jason Gunthorpe escreveu: > On Fri, Jun 28, 2019 at 09:19:57AM -0300, Mauro Carvalho Chehab wrote: > > The InfiniBand docs are plain text with no markups. > > So, all we needed to do were to add the title markups and > > some markup

Re: [PATCH 35/39] docs: infiniband: add it to the driver-api bookset

2019-07-06 Thread Mauro Carvalho Chehab
Em Wed, 3 Jul 2019 15:08:02 -0300 Jason Gunthorpe escreveu: > On Fri, Jun 28, 2019 at 09:30:28AM -0300, Mauro Carvalho Chehab wrote: > > While this contains some uAPI stuff, it was intended to be > > read by a kernel doc. So, let's not move it to a different > > dir, bu

Re: [PATCH 39/39] docs: gpio: add sysfs interface to the admin-guide

2019-07-06 Thread Mauro Carvalho Chehab
Em Wed, 3 Jul 2019 10:44:38 +0200 Linus Walleij escreveu: > On Fri, Jun 28, 2019 at 2:30 PM Mauro Carvalho Chehab > wrote: > > > While this is stated as obsoleted, the sysfs interface described > > there is still valid, and belongs to the admin-guide. > > > &

[PATCH] docs: automarkup.py: ignore exceptions when seeking for xrefs

2019-07-06 Thread Mauro Carvalho Chehab
NoUri This happens because not all references will belong to a single PDF/LaTeX document. Better to just ignore those than breaking Sphinx build. Fixes: d74b0d31ddde ("Docs: An initial automarkup extension for sphinx") Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/

Re: [PATCH] docs: automarkup.py: ignore exceptions when seeking for xrefs

2019-07-08 Thread Mauro Carvalho Chehab
Em Mon, 8 Jul 2019 09:23:36 -0600 Jonathan Corbet escreveu: > On Sat, 6 Jul 2019 13:28:42 -0300 > Mauro Carvalho Chehab wrote: > > > When using the automarkup extension with: > > make pdfdocs > > > > without passing an specific book, the code will raise

[PATCH] docs: pdf: add all Documentation/*/index.rst to PDF output

2019-07-09 Thread Mauro Carvalho Chehab
seek for all Documentation/*/index.rst. If the index is not yet at latex_documents, it includes using a reasonable default. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 15 +++ 1 file changed, 15 insertions(+) diff --git a/Documentation/conf.py b/Documentation

[PATCH] docs: don't use nested tables

2019-07-09 Thread Mauro Carvalho Chehab
ented. s390/debugging390:: nested tables are not yet implemented. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/laptops/sonypi.rst | 26 +-- .../admin-guide/laptops/toshiba_haps.rst | 8 +++--- Documentation/driver-api/nvdimm/btt.rst

Re: [Patch V2] Documentation: coresight: covert txt to rst

2019-07-09 Thread Mauro Carvalho Chehab
Em Tue, 9 Jul 2019 23:41:58 +0700 Phong Tran escreveu: > as doc-guide of kernel documentation, use Sphinx tool to > generate the html/pdf... files. > > This changes the plan text txt to rst format. > > Signed-off-by: Phong Tran > --- > ChangeLog: > V2: > * Add coresight-cpu-debug > * Upda

[PATCH 1/5] docs: don't use nested tables

2019-07-09 Thread Mauro Carvalho Chehab
ented. s390/debugging390:: nested tables are not yet implemented. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/laptops/sonypi.rst | 26 +-- .../admin-guide/laptops/toshiba_haps.rst | 8 +++--- Documentation/driver-api/nvdimm/btt.rst

[PATCH 2/5] docs: arm: fix a breakage with pdf output

2019-07-09 Thread Mauro Carvalho Chehab
Add an extra blank line, as otherwise XeLaTex will complain with: ! LaTeX Error: Too deeply nested. Signed-off-by: Mauro Carvalho Chehab --- Documentation/arm/spear/overview.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/arm/spear/overview.rst b/Documentation

[PATCH 5/5] docs: conf.py: add CJK package needed by translations

2019-07-09 Thread Mauro Carvalho Chehab
In order to be able to output Asian symbols with XeLaTeX, we need the xeCJK package, and a default font for CJK symbols. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 4 1 file changed, 4 insertions(+) diff --git a/Documentation/conf.py b/Documentation/conf.py index

[PATCH 0/5] PDF output fixes

2019-07-09 Thread Mauro Carvalho Chehab
fonts support to XeLaTeX. This patch series is at: https://git.linuxtv.org/mchehab/experimental.git/log/?h=extra_fixes_v1 And it is on the top of the ReST conversions that IMO should be sent at the end of this merge window. Mauro Carvalho Chehab (5): docs: don't use nested tables

[PATCH 3/5] docs: block: fix pdf output

2019-07-09 Thread Mauro Carvalho Chehab
Add an extra blank line and use a markup for the enumberated list, in order to make it possible to build the block book on pdf format. Signed-off-by: Mauro Carvalho Chehab --- Documentation/block/biodoc.rst | 9 + 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a

[PATCH 4/5] docs: kbuild: fix build with pdf and fix some minor issues

2019-07-09 Thread Mauro Carvalho Chehab
The tag ".. include" should be replaced by ".. literalinclude" at issues.rst, otherwise it causes TeX to crash due to excessive usage of stack with Sphinx 2.0. While here, solve a few minor issues at the kbuild book output by adding extra blank lines. Signed-off-by: M

Re: [PATCH v2] Documentation: filesystems: Convert ufs.txt to reStructuredText format

2019-07-10 Thread Mauro Carvalho Chehab
Em Tue, 9 Jul 2019 20:42:42 -0700 Shobhit Kukreti escreveu: > This converts the plain text documentation of ufs.txt to reStructuredText > format. > Added to documentation build process and verified with make htmldocs > > Signed-off-by: Shobhit Kukreti > --- > Changes in v2: > 1. Removed

Re: [PATCH v2] Documentation: filesystems: Convert jfs.txt to

2019-07-10 Thread Mauro Carvalho Chehab
Em Tue, 9 Jul 2019 20:25:25 -0700 Shobhit Kukreti escreveu: > This converts the plain text documentation of jfs.txt to reStructuredText > format. > Added to documentation build process and verified with make htmldocs > > Signed-off-by: Shobhit Kukreti > --- > Changes in v2: > 1. Remov

Re: [Patch V3] Documentation: coresight: covert txt to rst

2019-07-10 Thread Mauro Carvalho Chehab
Em Wed, 10 Jul 2019 09:05:30 +0700 Phong Tran escreveu: > as doc-guide of kernel documentation, use Sphinx tool to > generate the html/pdf... files. > > This changes the plan text txt to rst format. > > Signed-off-by: Phong Tran > --- > ChangeLog: > V2: review points from Mathieu, Jonathan >

Re: [PATCH v2 1/3] Documentation: kvm: Convert cpuid.txt to .rst

2019-07-10 Thread Mauro Carvalho Chehab
linuxtv.org/mchehab/experimental.git/commit/?h=convert_rst_renames_next_v3&id=90330aba498e6d9d5258322d0006b3968e9a65a9 (please notice that this is not the upstream docs branch, so you need to re-submit the patch to the ML) With the rebase, for this 3 patch series: Reviewed-by: Mauro Carvalho Chehab >

Re: [PATCH v3] Documentation: filesystems: Convert jfs.txt to

2019-07-10 Thread Mauro Carvalho Chehab
Em Wed, 10 Jul 2019 08:29:01 -0700 Shobhit Kukreti escreveu: > This converts the plain text documentation of jfs.txt to reStructuredText > format. Added to documentation build process and verified with > make htmldocs > > Signed-off-by: Shobhit Kukreti Reviewed-by: Mauro

Re: [PATCH v3] Documentation: filesystems: Convert ufs.txt to reStructuredText format

2019-07-10 Thread Mauro Carvalho Chehab
Em Wed, 10 Jul 2019 08:31:23 -0700 Shobhit Kukreti escreveu: > This converts the plain text documentation of ufs.txt to > reStructuredText format. Added to documentation build process > and verified with make htmldocs > > Signed-off-by: Shobhit Kukreti Reviewed-by: Mauro

Re: [Patch V4] Documentation: coresight: covert txt to rst

2019-07-10 Thread Mauro Carvalho Chehab
But looking at the patch itself: Reviewed-by: Mauro Carvalho Chehab > --- > ChangeLog: > V2: review points from Mathieu, Jonathan > * Add coresight-cpu-debug > * Update MAINTAINERS file > * Avoid use markup as much as posible > V3: review points from Mauro > * add

Re: [PATCH 5/5] docs: conf.py: add CJK package needed by translations

2019-07-12 Thread Mauro Carvalho Chehab
Em Fri, 12 Jul 2019 14:12:40 -0600 Jonathan Corbet escreveu: > On Tue, 9 Jul 2019 15:33:23 -0300 > Mauro Carvalho Chehab wrote: > > > In order to be able to output Asian symbols with XeLaTeX, we > > need the xeCJK package, and a default font for CJK symbols. > >

Re: [PATCH 0/5] PDF output fixes

2019-07-12 Thread Mauro Carvalho Chehab
Em Fri, 12 Jul 2019 14:19:21 -0600 Jonathan Corbet escreveu: > On Tue, 9 Jul 2019 15:33:18 -0300 > Mauro Carvalho Chehab wrote: > > > In order to be able to build all PDF books, besides the two patches I > > already sent: > > > > docs: pdf: add all Docume

Re: [PATCH 0/5] PDF output fixes

2019-07-12 Thread Mauro Carvalho Chehab
Em Fri, 12 Jul 2019 19:27:05 -0300 Mauro Carvalho Chehab escreveu: > Em Fri, 12 Jul 2019 14:19:21 -0600 > Jonathan Corbet escreveu: > > > On Tue, 9 Jul 2019 15:33:18 -0300 > > Mauro Carvalho Chehab wrote: > > > > > In order to be able to build all

[PATCH] scripts/sphinx-pre-install: fix script for RHEL/CentOS

2019-07-13 Thread Mauro Carvalho Chehab
There's a missing parenthesis at the script, with causes it to fail to detect non-Fedora releases (e. g. RHEL/CentOS). Tested with Centos 7.6.1810. Signed-off-by: Mauro Carvalho Chehab --- scripts/sphinx-pre-install | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sc

[PATCH 2/8] scripts/sphinx-pre-install: fix script for RHEL/CentOS

2019-07-14 Thread Mauro Carvalho Chehab
There's a missing parenthesis at the script, with causes it to fail to detect non-Fedora releases (e. g. RHEL/CentOS). Tested with Centos 7.6.1810. Signed-off-by: Mauro Carvalho Chehab --- scripts/sphinx-pre-install | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sc

[PATCH 4/8] scripts/sphinx-pre-install: fix latexmk dependencies

2019-07-14 Thread Mauro Carvalho Chehab
The name of the package with carries latexmk is different on two distros: - On OpenSUSE, latexmk is packaged as "texlive-latexmk-bin" - On Mageia, latexmk is packaged at "texlive-collection-basic" Signed-off-by: Mauro Carvalho Chehab --- scripts/sphinx-pre-install | 4 +++

[PATCH 1/8] docs: conf.py: only use CJK if the font is available

2019-07-14 Thread Mauro Carvalho Chehab
. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 13 +++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index fa0a42b47e62..a8fe845832bc 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -16,6

[PATCH 6/8] scripts/sphinx-pre-install: seek for Noto CJK fonts for pdf output

2019-07-14 Thread Mauro Carvalho Chehab
The translations guide need Noto CJK fonts. So, add a logic that would suggest its install for distros. It also fix a few other issues while testing the script with several distributions. Signed-off-by: Mauro Carvalho Chehab --- scripts/sphinx-pre-install | 29 + 1

[PATCH 7/8] docs: load_config.py: avoid needing a conf.py just due to LaTeX docs

2019-07-14 Thread Mauro Carvalho Chehab
latex_documents var, just adjusting the path to be relative ones. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/load_config.py | 25 +++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/Documentation/sphinx/load_config.py b/Documentation/sphinx

[PATCH 5/8] scripts/sphinx-pre-install: cleanup Gentoo checks

2019-07-14 Thread Mauro Carvalho Chehab
On Gentoo, the portage changes for ImageMagick to work are always suggested, even if already applied. While the two extra commands should be harmless, add a check to avoid reporting it without need. Signed-off-by: Mauro Carvalho Chehab --- scripts/sphinx-pre-install | 15 +-- 1 file

[PATCH 0/8] docs: some improvements when producing PDF files

2019-07-14 Thread Mauro Carvalho Chehab
py with would enable extra nitpick options if one wants that. - Jon, Please let me know if you prefer if I submit those together with the big pile of doc files I have, or if you prefer adding (some of?) them on your tree after the merge window. Regards, Mauro Mauro Carvalho Chehab (8): do

[PATCH 3/8] scripts/sphinx-pre-install: don't use LaTeX with CentOS 7

2019-07-14 Thread Mauro Carvalho Chehab
There aren't enough texlive packages for LaTeX-based builds to work on CentOS/RHEL <= 7. Signed-off-by: Mauro Carvalho Chehab --- scripts/sphinx-pre-install | 68 -- 1 file changed, 50 insertions(+), 18 deletions(-) diff --git a/scripts/sphinx-pre-i

[PATCH 8/8] docs: remove extra conf.py files

2019-07-14 Thread Mauro Carvalho Chehab
Now that the latex_documents are handled automatically, we can remove those extra conf.py files. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/conf.py | 10 -- Documentation/core-api/conf.py | 10 -- Documentation/crypto/conf.py | 10

[PATCH v2 7/8] docs: load_config.py: avoid needing a conf.py just due to LaTeX docs

2019-07-15 Thread Mauro Carvalho Chehab
latex_documents var, just adjusting the path to be relative ones. Signed-off-by: Mauro Carvalho Chehab --- v2: make SPHINXDIRS="foo" htmldocs now works without needing a per-subdir conf.py. diff --git a/Documentation/sphinx/load_config.py b/Documentation/sphinx/load_config.py index 30

[PATCH] docs: fix broken doc links due to renames

2019-07-15 Thread Mauro Carvalho Chehab
Some files got renamed but the patch was incomplete, as it forgot to update the documentation reference accordingly. Signed-off-by: Mauro Carvalho Chehab --- This patch is against current linus/master branch. Documentation/RCU/rculist_nulls.txt | 2 +- Documentation

[GIT PULL for v5.3-rc1] docs: addition of a large set of files to the documentation body

2019-07-16 Thread Mauro Carvalho Chehab
fetch changes up to 168869492e7009b6861b615f1d030c99bc805e83: docs: kbuild: fix build with pdf and fix some minor issues (2019-07-15 11:03:04 -0300) docs conversion for v5.3-rc1 ---- Mauro

[PATCH 06/14] docs: conf.py: only use CJK if the font is available

2019-07-16 Thread Mauro Carvalho Chehab
. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 13 +++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index fa0a42b47e62..a8fe845832bc 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -16,6

[PATCH 04/14] docs: pdf: add all Documentation/*/index.rst to PDF output

2019-07-16 Thread Mauro Carvalho Chehab
seek for all Documentation/*/index.rst. If the index is not yet at latex_documents, it includes using a reasonable default. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 15 +++ 1 file changed, 15 insertions(+) diff --git a/Documentation/conf.py b/Documentation

[PATCH 14/14] docs: virtual: add it to the documentation body

2019-07-16 Thread Mauro Carvalho Chehab
As files are getting converted to ReST, add them to the documentation body. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + Documentation/virtual/kvm/index.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/Documentation/index.rst b/Documentation

[PATCH 12/14] docs: load_config.py: avoid needing a conf.py just due to LaTeX docs

2019-07-16 Thread Mauro Carvalho Chehab
latex_documents var, just adjusting the path to be relative ones. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/load_config.py | 27 ++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/Documentation/sphinx/load_config.py b/Documentation/sphinx

[PATCH 05/14] docs: conf.py: add CJK package needed by translations

2019-07-16 Thread Mauro Carvalho Chehab
In order to be able to output Asian symbols with XeLaTeX, we need the xeCJK package, and a default font for CJK symbols. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 4 1 file changed, 4 insertions(+) diff --git a/Documentation/conf.py b/Documentation/conf.py index

[PATCH 02/14] docs: power: add it to to the main documentation index

2019-07-16 Thread Mauro Carvalho Chehab
: the docs there contain a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on its own directory, while the docs there are not properly classified. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + Documentation/power/index.rst | 2 +- 2 files chang

[PATCH 01/14] docs: powerpc: convert docs to ReST and rename to *.rst

2019-07-16 Thread Mauro Carvalho Chehab
file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab Acked-by: Andrew Donnellan # cxl --- Documentation/PCI/pci-error-recovery.rst | 5 +- Documentation/index.rst | 1 + .../{bootwrapper.txt => bootwrapper.rst} | 28 +++- .../{cpu

[PATCH 00/14] pending doc patches for 5.3-rc

2019-07-16 Thread Mauro Carvalho Chehab
m linux-next: https://git.linuxtv.org/mchehab/experimental.git/commit/?id=b1b5dc7d7bbfbbfdace2a248c6458301c6e34100 Mauro Carvalho Chehab (14): docs: powerpc: convert docs to ReST and rename to *.rst docs: power: add it to to the main documentation index docs: fix broken doc references due to ren

[PATCH 13/14] docs: remove extra conf.py files

2019-07-16 Thread Mauro Carvalho Chehab
Now that the latex_documents are handled automatically, we can remove those extra conf.py files. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/conf.py | 10 -- Documentation/core-api/conf.py | 10 -- Documentation/crypto/conf.py | 10

[PATCH] docs: fs: convert porting to ReST

2019-07-17 Thread Mauro Carvalho Chehab
text file while also produce a good html output after being parsed. Signed-off-by: Mauro Carvalho Chehab --- This patch is against next-20190717 Documentation/filesystems/porting | 686 - Documentation/filesystems/porting.rst | 841 ++ fs/orangefs

[PATCH v3 11/20] docs: kernel_abi.py: Handle with a lazy Sphinx parser

2019-07-17 Thread Mauro Carvalho Chehab
Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 39 -- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py index efa338e18764..a417026ed690 100644 --- a/Documentation/sphinx

[PATCH v3 20/20] docs: Kconfig/Makefile: add a check for broken ABI files

2019-07-17 Thread Mauro Carvalho Chehab
-pci-devices-aer_stats#21: What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_fatal' doesn't have a description Signed-off-by: Mauro Carvalho Chehab --- Documentation/Kconfig | 10 ++ Documentation/Makefile | 5 + lib/Kconfig.debug | 2 ++ scrip

[PATCH v3 08/20] docs: kernel_abi.py: Update copyrights

2019-07-17 Thread Mauro Carvalho Chehab
As Markus doesn't want to maintain ths file, update it to put me as its maintainer. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/s

[PATCH v3 17/20] docs: ABI: create a 2-depth index for ABI

2019-07-17 Thread Mauro Carvalho Chehab
That helps to identify what ABI files are adding titles. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/abi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/admin-guide/abi.rst b/Documentation/admin-guide/abi.rst index 3b9645c77469

[PATCH v3 09/20] docs: kernel_abi.py: add a SPDX header file

2019-07-17 Thread Mauro Carvalho Chehab
This file is released under GPL v2. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py index ef91b1e1ff4b..5d43cac73d0a 100644 --- a

[PATCH v3 05/20] docs: kernel_abi.py: add a script to parse ABI documentation

2019-07-17 Thread Mauro Carvalho Chehab
The ABI documentation is special: it is not plain text files, but, instead, files with an strict format, as specified by Documentation/ABI/README. Add a parser for it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 155 + 1 file

[PATCH v3 16/20] docs: ABI: make it parse ABI/stable as ReST-compatible files

2019-07-17 Thread Mauro Carvalho Chehab
: Mauro Carvalho Chehab --- Documentation/admin-guide/abi-stable.rst | 1 + Documentation/sphinx/kernel_abi.py | 8 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Documentation/admin-guide/abi-stable.rst b/Documentation/admin-guide/abi-stable.rst index 7495d7a35048

[PATCH v3 06/20] docs: kernel_abi.py: fix UTF-8 support

2019-07-17 Thread Mauro Carvalho Chehab
The parser breaks with UTF-8 characters with Sphinx 1.4. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 20 +++- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py

[PATCH v3 04/20] docs: kernellog.py: add support for info()

2019-07-17 Thread Mauro Carvalho Chehab
An extension may want to just inform about something. So, add support for it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernellog.py | 6 +- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Documentation/sphinx/kernellog.py b/Documentation/sphinx

[PATCH v3 07/20] docs: kernel_abi.py: make it compatible with Sphinx 1.7+

2019-07-17 Thread Mauro Carvalho Chehab
The same way kerneldoc.py needed changes to work with newer Sphinx, this script needs the same changes. While here, reorganize the include order to match kerneldoc.py. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 39 +- 1 file

[PATCH v3 10/20] docs: kernel_abi.py: use --enable-lineno for get_abi.pl

2019-07-17 Thread Mauro Carvalho Chehab
should be noticed that it the line which will be reported is the line where the "What:" definition is, and not the line with actually has an error. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 18 ++ 1 file changed, 14 insertions(+), 4

[PATCH v3 18/20] docs: ABI: don't escape ReST-incompatible chars from obsolete and removed

2019-07-17 Thread Mauro Carvalho Chehab
With just a single fix, the contents there can be parsed properly without the need to escape any ReST incompatible stuff. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/obsolete/sysfs-gpio | 2 ++ Documentation/admin-guide/abi-obsolete.rst | 1 + Documentation/admin-guide/abi

[PATCH v3 12/20] docs: add ABI documentation to the admin-guide book

2019-07-17 Thread Mauro Carvalho Chehab
As we don't want a generic Sphinx extension to execute commands, change the one proposed to Markus to call the abi_book.pl script. Use a script to parse the Documentation/ABI directory and output it at the admin-guide. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guid

[PATCH v3 19/20] docs: abi-testing.rst: enable --rst-sources when building docs

2019-07-17 Thread Mauro Carvalho Chehab
Now that ABI/testing documents were fixed, add --rst-sources to the ABI/testing too. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/abi-testing.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/admin-guide/abi-testing.rst b/Documentation/admin-guide/abi

[PATCH v4 08/15] docs: kernel_abi.py: allow passing ABI files in a transparent way

2019-07-17 Thread Mauro Carvalho Chehab
As get-abi.pl supports an ABI file that it is ReST compliant, add an option to kernel-abi.py to allow using the transparent mode of the tool. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 8 ++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a

[PATCH v4 03/15] docs: kernellog.py: add support for info()

2019-07-17 Thread Mauro Carvalho Chehab
An extension may want to just inform about something. So, add support for it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernellog.py | 6 +- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Documentation/sphinx/kernellog.py b/Documentation/sphinx

[PATCH v4 06/15] docs: kernel_abi.py: make it compatible with Sphinx 1.7+

2019-07-17 Thread Mauro Carvalho Chehab
The same way kerneldoc.py needed changes to work with newer Sphinx, this script needs the same changes. While here, reorganize the include order to match kerneldoc.py. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 39 +- 1 file

[PATCH v4 14/15] docs: ABI: obsolete, removed: don't escape ReST-incompatible chars

2019-07-17 Thread Mauro Carvalho Chehab
With just a single fix, the contents there can be parsed properly without the need to escape any ReST incompatible stuff. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/obsolete/sysfs-gpio | 2 ++ Documentation/admin-guide/abi-obsolete.rst | 1 + Documentation/admin-guide/abi

[PATCH v4 10/15] docs: add ABI documentation to the admin-guide book

2019-07-17 Thread Mauro Carvalho Chehab
As we don't want a generic Sphinx extension to execute commands, change the one proposed to Markus to call the abi_book.pl script. Use a script to parse the Documentation/ABI directory and output it at the admin-guide. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guid

[PATCH v4 12/15] docs: ABI: stable: make files ReST compatible

2019-07-17 Thread Mauro Carvalho Chehab
Several entries at the stable ABI files won't parse if we pass them directly to the ReST output. Adjust them, in order to allow adding their contents as-is at the stable ABI book. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/firewire-cdev| 4 + Documentatio

[PATCH v4 09/15] docs: kernel_abi.py: Sphinx has a lazy parser... workaround it

2019-07-17 Thread Mauro Carvalho Chehab
Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 39 -- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py index 30cac84e18f5..6d2f56500197 100644 --- a/Documentation/sphinx

[PATCH v4 15/15] docs: Kconfig/Makefile: add a check for broken ABI files

2019-07-17 Thread Mauro Carvalho Chehab
-pci-devices-aer_stats#21: What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_fatal' doesn't have a description Signed-off-by: Mauro Carvalho Chehab --- Documentation/Kconfig | 10 ++ Documentation/Makefile | 5 + lib/Kconfig.debug | 2 ++ scrip

[PATCH v4 04/15] docs: kernel_abi.py: add a script to parse ABI documentation

2019-07-17 Thread Mauro Carvalho Chehab
The ABI documentation is special: it is not plain text files, but, instead, files with an strict format, as specified by Documentation/ABI/README. Add a parser for it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 158 + 1 file

[PATCH v4 05/15] docs: kernel_abi.py: fix UTF-8 support

2019-07-17 Thread Mauro Carvalho Chehab
The parser breaks with UTF-8 characters with Sphinx 1.4. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 17 + 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py

[PATCH v4 07/15] docs: kernel_abi.py: use --enable-lineno for get_abi.pl

2019-07-17 Thread Mauro Carvalho Chehab
should be noticed that it the line which will be reported is the line where the "What:" definition is, and not the line with actually has an error. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 18 ++ 1 file changed, 14 insertions(+), 4

Re: [PATCH v3 06/20] docs: kernel_abi.py: fix UTF-8 support

2019-07-17 Thread Mauro Carvalho Chehab
Em Wed, 17 Jul 2019 13:44:40 +0200 Markus Heiser escreveu: > Hi Mauro, > > just nitpicking .. > > Am 17.07.19 um 13:05 schrieb Mauro Carvalho Chehab: > > The parser breaks with UTF-8 characters with Sphinx 1.4. > > > > Signed-off-by: Mauro Carvalho Chehab &

Using rst2pdf for PDF output - Was: Re: [PATCH 0/5] PDF output fixes

2019-07-18 Thread Mauro Carvalho Chehab
Em Sat, 13 Jul 2019 00:41:25 -0300 Mauro Carvalho Chehab escreveu: > Em Fri, 12 Jul 2019 19:27:05 -0300 > Mauro Carvalho Chehab escreveu: > > > Em Fri, 12 Jul 2019 14:19:21 -0600 > > Jonathan Corbet escreveu: > > > > > Can't you just make rst2pdf w

Re: Using rst2pdf for PDF output - Was: Re: [PATCH 0/5] PDF output fixes

2019-07-18 Thread Mauro Carvalho Chehab
Em Thu, 18 Jul 2019 19:56:57 +0200 Markus Heiser escreveu: > Am 18.07.19 um 19:46 schrieb Mauro Carvalho Chehab: > > Em Sat, 13 Jul 2019 00:41:25 -0300 > > Mauro Carvalho Chehab escreveu: > > > >> Em Fri, 12 Jul 2019 19:27:05 -0300 > >> Mauro Carvalho

[PATCH 05/22] docs: ipmb: place it at driver-api and convert to ReST

2019-07-22 Thread Mauro Carvalho Chehab
No new doc should be added at the main Documentation/ directory. Instead, new docs should be added as ReST files, within the Kernel documentation body. Fixes: 51bd6f291583 ("Add support for IPMB driver") Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/index.rst | 1

[PATCH 20/22] docs: net: convert two README files to ReST format

2019-07-22 Thread Mauro Carvalho Chehab
mark those two files with :orphan:, in order to supress a build warning. Signed-off-by: Mauro Carvalho Chehab --- .../networking/caif/{README => caif.rst} | 88 +-- .../{README => mac80211_hwsim.rst}| 28 -- MAINTAINERS

[PATCH 03/22] docs: w1: convert to ReST and add to the kAPI group of docs

2019-07-22 Thread Mauro Carvalho Chehab
The 1wire documentation was written with w1 developers in mind, so, it makes sense to add it together with the driver-api set. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/sysfs-bus-w1 | 2 +- .../ABI/stable/sysfs-driver-w1_ds28e04| 4 +- .../ABI/stable

[PATCH 17/22] docs: mips: add to the documentation body as ReST

2019-07-22 Thread Mauro Carvalho Chehab
Manually convert the AU1xxx_IDE.README file to ReST and add to a MIPS book as part of the main documentation body. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + .../{AU1xxx_IDE.README => au1xxx_ide.rst} | 89 +++ Documentat

[PATCH 09/22] docs: parisc: convert to ReST and add to documentation body

2019-07-22 Thread Mauro Carvalho Chehab
Manually convert the two PA-RISC documents to ReST, adding them to the Linux documentation body. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + .../parisc/{debugging => debugging.rst} | 7 +++ Documentation/parisc/index.

[PATCH 00/22] ReST conversion of text files without .txt extension

2019-07-22 Thread Mauro Carvalho Chehab
nversion, all ending with .txt. >From those, ~40 files are already at ReST format - the ones at >Documentation/*.txt - except for a couple of files there. So, there's around 320 files left to be converted after this series, with gives me hope that we may finally finish the conversion this

[PATCH 04/22] docs: spi: convert to ReST and add it to the kABI bookset

2019-07-22 Thread Mauro Carvalho Chehab
While there's one file there with briefily describes the uAPI, the documentation was written just like most subsystems: focused on kernel developers. So, add it together with driver-api books. Signed-off-by: Mauro Carvalho Chehab Acked-by: Jonathan Cameron # for iio --- Documentation/inde

[PATCH 10/22] docs: openrisc: convert to ReST and add to documentation body

2019-07-22 Thread Mauro Carvalho Chehab
Manually convert the two openRisc documents to ReST, adding them to the Linux documentation body. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + Documentation/openrisc/index.rst | 18 + .../openrisc/{README

[PATCH 16/22] docs: wimax: convert to ReST and add to admin-guide

2019-07-22 Thread Mauro Carvalho Chehab
Manually convert wimax documentation to ReST and add theit to the Kernel doc body, inside the admin-guide. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/index.rst | 1 + .../wimax/i2400m.rst} | 145 ++ Documentation/admin

[PATCH 01/22] docs: convert markdown documents to ReST

2019-07-22 Thread Mauro Carvalho Chehab
The documentation standard is ReST and not markdown. Signed-off-by: Mauro Carvalho Chehab Acked-by: Rob Herring --- Documentation/devicetree/writing-schema.md| 130 --- Documentation/devicetree/writing-schema.rst | 153 ++ ...entication.md => ub

[PATCH 18/22] docs: hwmon: pxe1610: convert to ReST format and add to the index

2019-07-22 Thread Mauro Carvalho Chehab
This document was recently introduced. Convert it to ReST just like the other hwmon documents, adding it to the hwmon index. Signed-off-by: Mauro Carvalho Chehab --- Documentation/hwmon/index.rst| 1 + Documentation/hwmon/{pxe1610 => pxe1610.rst} | 33 +++-

[PATCH 07/22] docs: admin-guide: add auxdisplay files to it after conversion to ReST

2019-07-22 Thread Mauro Carvalho Chehab
Those two files describe userspace-faced information. While part of it might fit on uAPI, it sounds to me that the admin guide is the best place for them. Signed-off-by: Mauro Carvalho Chehab --- .../admin-guide/auxdisplay/cfag12864b.rst | 98 .../admin-guide/auxdisplay

[PATCH 13/22] docs: fs: convert docs without extension to ReST

2019-07-22 Thread Mauro Carvalho Chehab
rt of the fs documentation. Signed-off-by: Mauro Carvalho Chehab --- ...irectory-locking => directory-locking.rst} | 40 ++- Documentation/filesystems/index.rst | 2 + .../filesystems/{Locking => locking.rst} | 257 -- .../nfs/{Exporting =>

[PATCH 06/22] docs: packing: move it to core-api book and adjust markups

2019-07-22 Thread Mauro Carvalho Chehab
("lib: Add support for generic packing operations") Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Vladimir Oltean Tested-by: Vladimir Oltean Reviewed-by: Mike Rapoport --- Documentation/core-api/index.rst | 1 + .../{packing.txt => core-api/packing.

[PATCH 19/22] docs: nios2: add it to the main Documentation body

2019-07-22 Thread Mauro Carvalho Chehab
Rename and add the nios2 documentation to the documentation body. The nios2 document is already on an ReST compatible format. All it needs is that the title of the document to be promoted one level. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1

[PATCH 12/22] docs: fs: cifs: convert to ReST and add to admin-guide book

2019-07-22 Thread Mauro Carvalho Chehab
style, while making it to look more like the other Kernel documents. Most of the conversion here is trivial. The most complex one was the README file (which was renamed to usage.rst). Signed-off-by: Mauro Carvalho Chehab --- .../AUTHORS => admin-guide/cifs/authors.rst} | 64 +- .../CHANGES

[PATCH 08/22] docs: README.buddha: convert to ReST and add to m68k book

2019-07-22 Thread Mauro Carvalho Chehab
Adjust the file for it to be properly parsed by Sphinx, adding it to the index of the book it belongs. Signed-off-by: Mauro Carvalho Chehab --- .../m68k/{README.buddha => buddha-driver.rst} | 95 +-- Documentation/m68k/index.rst | 1 + 2 files changed,

[PATCH 11/22] docs: isdn: convert to ReST and add to kAPI bookset

2019-07-22 Thread Mauro Carvalho Chehab
, just adding a pointer to it at the kAPI section, as the documentation was written with the Kernel developers in mind. Signed-off-by: Mauro Carvalho Chehab --- Documentation/index.rst | 1 + .../isdn/{README.avmb1 => avmb1.rst} | 231 -- Documentation/i

  1   2   3   4   5   6   7   8   9   10   >