[PATCH] doc-rst: reST-directive kernel-cmd parse with tabs

2016-10-18 Thread Markus Heiser
Add a 'tab-width' option to the kernel-cmd, and convert whitespace (tabs) well. The default 'tab-width' is 8. This is also a bugfix, since without this patch, tabs in command's output are not handled. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/

[PATCH] kernel-cmd and tabs

2016-10-18 Thread Markus Heiser
://www.mail-archive.com/linux-doc@vger.kernel.org/msg06828.html Markus Heiser (1): doc-rst: reST-directive kernel-cmd parse with tabs Documentation/sphinx/kernel_cmd.py | 17 + 1 file changed, 13 insertions(+), 4 deletions(-) -- 2.7.4 -- To unsubscribe from this list: send

Re: [PATCH 00/32] Create an User's manual and improve development-process book

2016-10-17 Thread Markus Heiser
Hi Jon, Am 18.10.2016 um 00:43 schrieb Jonathan Corbet : > I've only been able to take a quick look at these - I'm buried fairly deep > at the moment. A few superficial thoughts. > > On Mon, 17 Oct 2016 14:55:37 -0200 > Mauro Carvalho Chehab wrote: >

Re: sequence diagrams in rst documentation

2016-10-21 Thread Markus Heiser
Am 21.10.2016 um 15:04 schrieb Johannes Berg : >> I had the same conclusion for math:: directives pulling in latex >> dependency [1]. Hopefully Markus can help here. > > Yeah, good one. > > Maybe it's actually simple? Depending on where sphinx will look for > plugins

Re: [PATCH] doc-rst: tidy up Sphinx conf.py

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 09:56 schrieb Jani Nikula : >> * set minimal Sphinx version (needs_sphinx=1.2) > > This change is not cleanup. Cleanups and functional changes must be > separate patches. Ah, thanks for the hint .. I will separate the following 4 changes * drop no

Re: [PATCH v3 01/37] Documentation/applying-patches.txt: fix a bad external link

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > We can't use :ref: for external links. > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/applying-patches.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > >

[PATCH] doc-rst: make dev-tools folder buildable stand-alone

2016-10-24 Thread Markus Heiser
Add minimal conf.py and moved dev-tools/tools.rst to dev-tools/index.rst makes the dev-tools folder buildable stand-alone. To build only this folder run:: make SPHINXDIRS=dev-tools htmldocs Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/dev-tools/c

Re: [PATCH v3 28/37] Documentation/CodeOfConflict: convert to ReST

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > Fix ReST notation for a bullet item > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/CodeOfConflict | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff

Re: [PATCH v3 02/37] Documentation/adding-syscalls.txt: convert it to ReST markup

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > Convert adding-syscalls.txt to ReST markup and add it to the > development-process book: > > - add extra lines to make Sphinx to correctly parse paragraphs; > - use quote blocks for examples; > - use monotonic

Re: [PATCH v3 21/37] Documentation/ramoops.txt: convert it to ReST format

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > - Fix document title; > - use quote blocks where needed; > - use monotonic fonts for config options and file names; > - adjust whitespaces and blank lines; > - add it to the user's book. > > Signed-off-by: Mauro

Re: [PATCH v3 06/37] Documentation/binfmt_misc.txt: convert it to ReST markup

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > - Fix identation for the document title; > - use monotonic fonts for commands, paths, etc; > - use quote blocks where needed; > - adjust spaces to properly format paragraphs; > - add it to the user book. > >

Re: [PATCH v3 19/37] Documentation/oops-tracing.txt: convert to ReST markup

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > - Add a document title; > - use .. note:: markup; > - use quote blocks where needed; > - use monotonic fonts for config options and file names; > - adjust whitespaces and blank lines; > - replace _foo_ by **foo**;

Re: [PATCH v3 06/37] Documentation/binfmt_misc.txt: convert it to ReST markup

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 17:00 schrieb Jani Nikula <jani.nik...@linux.intel.com>: > On Mon, 24 Oct 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> again, sorry for nitpicking, IMO a blank line after each list item >> would make it more readable. > > I t

Re: [PATCH v3 33/37] docs-rst: create an user's manual book

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters > on an user's manual book. > > As we'll be numbering the user's manual, remove the manual > numbering from SecurityBugs. > > Signed-off-by: Mauro

Re: [PATCH v3 35/37] doc: re-add CodingStyle and SubmittingPatches

2016-10-24 Thread Markus Heiser
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab : > Those files got moved to Documentation/process, but as they're very > well known files, add pointers to their new locations. > > PS.: I opted to not merge this patch with the previous one > in order to make the

Re: [PATCH v2 16/37] Documentation/module-signing.txt: convert to ReST markup

2016-10-19 Thread Markus Heiser
Am 19.10.2016 um 11:33 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Wed, 19 Oct 2016 06:58:12 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> just a small suggestion of mine >> >> .. CONTENTS >> >

Re: sequence diagrams in rst documentation

2016-10-19 Thread Markus Heiser
Am 18.10.2016 um 16:52 schrieb Jani Nikula : >> *Only* adding the PNG would be awful, I'd have to keep track of the >> corresponding source elsewhere, and perhaps couldn't even GPL it >> because then I couldn't distribute the PNG without corresponding >> source... >>

miss some documentation on https://www.kernel.org/doc/

2016-10-19 Thread Markus Heiser
Hi kernel.org maintainers, sorry for my silly question: I miss the documentation of the reST (sphinx) content [1] on https://www.kernel.org/doc/ Since the DocBook files migrated to reST (sphinx) increase the "htmldocs" at [3] are decreasing. I suppose you build HTML of the DocBook content of [3]

Re: [PATCH] Documentation/sphinx: rename kernel-doc.py to kerneldoc.py

2016-10-19 Thread Markus Heiser
e-and-module-names > > Reported-by: Markus Heiser <markus.hei...@darmarit.de> > Signed-off-by: Jani Nikula <jani.nik...@intel.com> Wow! .. you are fast ;-) / Thanks! --M-- -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message

Re: [PATCH 1/4] doc-rst: reST-directive kernel-cmd / include contentent from scripts

2016-10-18 Thread Markus Heiser
Am 18.10.2016 um 08:07 schrieb Jani Nikula : > If you're going to insist on getting kernel-cmd upstream (and I haven't > changed my opinion on that) please at least have the sense to have just > *one* perl script to parse MAINTAINERS, not many. The one script should > be

[RFC PATCH v2] docs-rst: automatically convert Graphviz and SVG images

2016-11-27 Thread Markus Heiser
is not available, the DOT language is inserted as literal-include. * SVG to PDF: * CairoSVG (http://cairosvg.org) if installed or alternatively * ``convert(1)``: ImageMagick (https://www.imagemagick.org) Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/c

[RFC PATCH] doc-rst: automatically convert Graphviz and SVG images

2016-11-27 Thread Markus Heiser
is not available, the DOT language is inserted as literal-include. * SVG to PDF: * CairoSVG (http://cairosvg.org) if installed or alternatively * ``convert(1)``: ImageMagick (https://www.imagemagick.org) Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/c

[RFC PATCH] doc-rst: convert SVG and graphiz (.dot) files

2016-11-27 Thread Markus Heiser
anks. -- Markus -- [1] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg07870.html Markus Heiser (1): docs-rst: automatically convert Graphviz and SVG images Documentation/conf.py | 2 +- Documentation/doc-guide/hello.dot | 3 + Documentation/doc-guide/sphinx.rst |

Re: [RFC PATCH v2] docs-rst: automatically convert Graphviz and SVG images

2016-11-28 Thread Markus Heiser
Hi Jon, you forgot to reply ML (and other CC) ... so I will do it here. Am 27.11.2016 um 18:54 schrieb Jonathan Corbet <cor...@lwn.net>: > On Sun, 27 Nov 2016 16:25:43 +0100 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> Replacement for the sphinx ``figure

Re: [PATCH 0/3] Improve Kernel documentation guide

2016-11-20 Thread Markus Heiser
Am 19.11.2016 um 19:22 schrieb Mauro Carvalho Chehab : >> What are the chances of just making the rst doc be the definitive one >> and putting a pointer into pod2rst? > > Not sure what exactly you want. IMO, it is useful to be able to > run the script with --man or

Re: [PATCH] doc-rst: make cleandocs misses a fair number of files

2016-11-01 Thread Markus Heiser
Am 01.11.2016 um 08:39 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 01 Nov 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Removes intermediate files: >> >> - Documentation/DocBook/.*.xml.cmd >> - Documentation/.../*.pyc >>

[PATCH] doc-rst: make cleandocs misses a fair number of files

2016-11-01 Thread Markus Heiser
/sphinx. References: http://lkml.kernel.org/r/camuhmdvxqph7-9xj+ye_pgoa+-fe0969cskoehyh3uubycr...@mail.gmail.com Reported-by: Geert Uytterhoeven <ge...@linux-m68k.org> Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/DocBook/Makefile | 1 + Documentation/Mak

[PATCH v2] doc-rst: make cleandocs misses a fair number of files

2016-11-01 Thread Markus Heiser
Removes intermediate 'Documentation/DocBook/.*.xml.cmd' files Changes since v1: - Reduce the patch to DocBook cleandocs References: http://lkml.kernel.org/r/CA+r1Zhjr5SCVAroREBv84t9bxDVu5jVJ_Fu=bbvdgnnabdq...@mail.gmail.com Reported-by: Jim Davis <jim.ep...@gmail.com> Signed-off-by:

Re: [PATCH 4/3] Documentation/sphinx: change pdflatex interaction mode to batchmode

2016-11-02 Thread Markus Heiser
Am 02.11.2016 um 12:41 schrieb Jani Nikula <jani.nik...@intel.com>: > Radically reduce the noise on stdout. The full build logs will still be > available under Documentatio/output/latex/*.log. Tested-by: Markus Heiser <markus.hei...@darmarit.de> Thanks! -- Markus -- -- T

Re: [PATCH 1/3] Documentation/sphinx: let the user specify PDFLATEX and LATEXOPTS

2016-11-02 Thread Markus Heiser
Am 02.11.2016 um 10:40 schrieb Jani Nikula : > Refer to xelatex and latex options via variables. This allows the user > to override the pdflatex and latex options to use on the make command > line for experimenting. As a side effect, this makes the makefile a bit > tidier.

Re: [PATCH RFC 0/4] Fix PDF build errors

2016-11-02 Thread Markus Heiser
Am 02.11.2016 um 17:47 schrieb Mauro Carvalho Chehab <mche...@infradead.org>: > Em Wed, 2 Nov 2016 17:08:08 +0100 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 02.11.2016 um 12:14 schrieb Jani Nikula <jani.nik...@linux.intel.com>: >>

Re: [PATCH 2/3] Documentation/sphinx: make it possible to build latexdocs without pdflatex

2016-11-02 Thread Markus Heiser
e can't > build pdfdocs anyway. Tested-by: Markus Heiser <markus.hei...@darmarit.de> --Markus -- -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html

Re: Proposing help for documentation

2016-11-02 Thread Markus Heiser
Am 02.11.2016 um 11:41 schrieb Jani Nikula : > On Wed, 02 Nov 2016, Luis de Bethencourt wrote: >> I also offer my help, let me know if you see anything I can do. > > Luis, Patrice, anyone else out there willing to help: here's a list of >

Re: [Kernel.org Helpdesk #31693] miss some documentation on https://www.kernel.org/doc/

2016-10-27 Thread Markus Heiser
Am 27.10.2016 um 23:12 schrieb Konstantin Ryabitsev via RT : > On 2016-10-19 10:41:43, markus.hei...@darmarit.de wrote: >> Hi kernel.org maintainers, >> >> sorry for my silly question: I miss the documentation of the >> reST (sphinx) content [1] on

Re: [RFC PATCH] parse-headers.pl: add documentation for this script

2016-10-28 Thread Markus Heiser
Am 28.10.2016 um 10:45 schrieb Mauro Carvalho Chehab : > Provide a man page for parse-headers.pl, describing > how to use it. Our posts have been overlapping, but It seems as we have the same thoughts ;-) -- Markus -- -- To unsubscribe from this list: send the line

Re: ABI conversion to ReST - Was: Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-28 Thread Markus Heiser
Am 28.10.2016 um 08:54 schrieb Greg Kroah-Hartman : > On Thu, Oct 27, 2016 at 10:34:05PM -0200, Mauro Carvalho Chehab wrote: >> As defined at Documentation/ABI/README, this is actually a database >> with those fields: >> >> What, Date, KernelVersion, Contact,

Re: Was: Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-31 Thread Markus Heiser
Am 28.10.2016 um 14:37 schrieb Mauro Carvalho Chehab : > On a separate matter: any news with regards to the man pages > Sphinx extension? I have one extension active in my POC: https://h2626237.stratoserver.net/kernel/ follow the "man" links. There you will also find

Re: [PATCH 5/3] Documentation/sphinx: fix make SPHINXDIRS="dirs" pdfdocs for more than one dir

2016-11-02 Thread Markus Heiser
Am 02.11.2016 um 15:45 schrieb Jani Nikula <jani.nik...@intel.com>: > From: Markus Heiser <markus.hei...@darmarit.de> > > Add missing semicolon to fix pdf build with more than one SPHINXDIRS > directory specified. For example make SPHINXDIRS="gpu media" pdfdo

Re: make pdfdocs fails with v4.9-rc3

2016-11-02 Thread Markus Heiser
Am 01.11.2016 um 23:11 schrieb Jim Davis : > On Mon, Oct 31, 2016 at 3:41 PM, Mauro Carvalho Chehab > wrote: >> Em Mon, 31 Oct 2016 16:40:02 -0600 >> Mauro Carvalho Chehab escreveu: >> >>> Em Mon, 31 Oct 2016 15:04:42 -0700

Re: [PATCH RFC 1/4] docs-rst: fix PDF build errors

2016-11-02 Thread Markus Heiser
Am 01.11.2016 um 23:44 schrieb Mauro Carvalho Chehab : > PDF build on Kernel 4.9-rc? returns an error. This is > because we're re-defining a command too late. Move > such redefinition to LaTeX preamble. > > Tested by building the documentation on interactive mode: >

Re: [PATCH RFC 0/4] Fix PDF build errors

2016-11-02 Thread Markus Heiser
Am 02.11.2016 um 12:14 schrieb Jani Nikula : > On Wed, 02 Nov 2016, Mauro Carvalho Chehab wrote: >> This series address a series of errors during PDF generation from >> media documentation. >> >> Please notice that patch 2 carries on a PDF

Re: ABI conversion to ReST - Was: Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-28 Thread Markus Heiser
Am 28.10.2016 um 14:55 schrieb Jonathan Corbet <cor...@lwn.net>: > On Fri, 28 Oct 2016 11:07:15 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> My conclusion of this and other discussions on the linux-doc ML is; we >> have the situation, where

Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-11 Thread Markus Heiser
Am 11.10.2016 um 17:34 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 11 Oct 2016, Mauro Carvalho Chehab <mche...@infradead.org> wrote: >> Em Tue, 11 Oct 2016 09:26:48 +0200 >> Markus Heiser <markus.hei...@darmarit.de> escreveu: >> >>

Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-12 Thread Markus Heiser
Am 11.10.2016 um 18:45 schrieb Mauro Carvalho Chehab : > If we allow such scripts (and we do since day zero, due to > kernel-doc), then there are 3 options: > > 1) use a single python script to run the scripts needed in the > build process (e. g. merging kernel-cmd

Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-11 Thread Markus Heiser
Am 07.10.2016 um 07:56 schrieb Jani Nikula : > On Thu, 06 Oct 2016, Mauro Carvalho Chehab wrote: >> Em Thu, 06 Oct 2016 17:21:36 +0300 >> Jani Nikula escreveu: >>> We've seen what happens when we make it easy to add random

Re: [PATCH 3/7] crypto: doc - fix source comments for Sphinx

2016-10-16 Thread Markus Heiser
Am 16.10.2016 um 15:03 schrieb Stephan Mueller <smuel...@chronox.de>: > Am Sonntag, 16. Oktober 2016, 14:56:49 CEST schrieb Markus Heiser: > > Hi Markus, > ... > >> compared to DocBook, with sphinx you can use (have to use) the reST markup >> in source cod

Re: [PATCH 3/7] crypto: doc - fix source comments for Sphinx

2016-10-16 Thread Markus Heiser
Am 16.10.2016 um 05:18 schrieb 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 +- >

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

2016-10-16 Thread Markus Heiser
Am 16.10.2016 um 05:22 schrieb 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

Re: SPHINX: no structured comments

2016-10-15 Thread Markus Heiser
Am 15.10.2016 um 17:05 schrieb Stephan Mueller : > Hi, > > I am converting the kernel crypto API DocBook into Sphinx. The conversion is > complete, but I am having difficulties finding the cause for the following > notification obtained during the Sphinx compilation: > >

Re: [PATCH] doc: Explain light-handed markup preference a bit better

2016-11-29 Thread Markus Heiser
Am 29.11.2016 um 10:23 schrieb Daniel Vetter : > We already had a super-short blurb, but worth extending it I think: > We're still pretty far away from anything like a consensus, but > there's clearly a lot of people who prefer an as-light as possible > approach to

[RFC PATCH v3 1/1] docs-rst: automatically convert Graphviz and SVG images

2016-12-07 Thread Markus Heiser
) code. digraph foo { "bar" -> "baz"; } The *render* directive is a concept to integrate *render* markups and languages, yet supported markups: * DOT: render embedded Graphviz's **DOC** * SVG: render embedded Scalable Vector Graphics (**SVG**) Signe

Re: Warnings for documentation of private elements of a structure.

2017-01-02 Thread Markus Heiser
Am 02.01.2017 um 10:33 schrieb Jani Nikula <jani.nik...@linux.intel.com>: > On Mon, 02 Jan 2017, Markus Heiser <markus.hei...@darmarit.de> wrote: >> IMO we should no longer investigate in the kernel_doc perl script, which >> is at it ends. Instead we should merge

Re: Warnings for documentation of private elements of a structure.

2017-01-02 Thread Markus Heiser
Am 01.01.2017 um 15:05 schrieb Jonathan Cameron : > Hi All, > > I have very little idea how the internals of the kernel-doc processing > code work, but was wondering if it would be possible to suppress warnings > of the type: > > ./include/linux/iio/buffer.h:142: warning:

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

2017-03-30 Thread Markus Heiser
Am 30.03.2017 um 10:21 schrieb Jani Nikula <jani.nik...@intel.com>: > On Thu, 30 Mar 2017, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Hi Mauro, >> >> Am 29.03.2017 um 20:54 schrieb Mauro Carvalho Chehab >> <mche...@s-opensource.com>:

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

2017-03-30 Thread Markus Heiser
Am 30.03.2017 um 13:17 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > If it helps ... dbxml2rst also supports single file conversion ... I updated: > > > https://github.com/return42/sphkerneldoc/tree/master/Documentation/books_migrated > > There you fin

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

2017-03-30 Thread Markus Heiser
Hi Mauro, Am 29.03.2017 um 20:54 schrieb Mauro Carvalho Chehab : > As we're moving out of DocBook, let's convert the remaining > USB docbooks to ReST. > > The transformation itself on this patch is a no-brainer > conversion using pandoc. right, its a no-brainer ;-)

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

2017-03-30 Thread Markus Heiser
Am 30.03.2017 um 12:12 schrieb Mauro Carvalho Chehab : >>> At this point I'd just go with what Mauro has. It's here now, as >>> patches. We've seen from the GPU documentation that polishing the >>> one-time initial conversion is, after a point, wasted effort. Having the

Re: [PATCH 1/2] Documentation/sphinx: kerneldoc: add "unused-functions"

2017-03-31 Thread Markus Heiser
Am 31.03.2017 um 09:16 schrieb Johannes Berg : > From: Johannes Berg > > When adding functions one by one into documentation, in order to > order/group things properly, it's easy to miss things. Allow use > of the kernel-doc directive with

Re: doc build requirements

2017-03-31 Thread Markus Heiser
s changed and I can try again? :) no ;) yes, you are right and we have improved it; since .. -- doc-4.11-images db6ccf23e8ba40fc2e8914ec9c0eb950df71d9fe Author: Markus Heiser <markus.hei...@darmarit.de> AuthorDate: Mon Mar 6 14:09:27 2017 +0100 docs-rst: automatically convert Graphv

Re: [PATCH 216/216] Use sphinx.version_info directly instead of parsing

2017-03-20 Thread Markus Heiser
Am 20.03.2017 um 16:11 schrieb Jani Nikula : >> # Get Sphinx version >> -major, minor, patch = map(int, sphinx.__version__.split(".")) >> +major, minor, patch, _, _ = sphinx.version_info Thanks! ... alternative, use only first three items of the tuple. More stable,

Re: [PATCH v2 00/11] Documentation: Add ABI to the admin guide

2017-04-21 Thread Markus Heiser
Am 21.04.2017 um 01:21 schrieb Mauro Carvalho Chehab : > - I'm not a python programmer ;-) I just took Markus "generic" kernel-cmd > code, hardcoding there a call to the script. > > With (a lot of) time, I would likely be able to find a solution to add > the entire

Re: [PATCH] docs: conf.py: increase recursion limit

2017-04-13 Thread Markus Heiser
On 13.04.2017 15:29, Mauro Carvalho Chehab wrote: Em Thu, 13 Apr 2017 14:55:03 +0200 Markus Heiser <markus.hei...@darmarit.de> escreveu: On 13.04.2017 12:42, Mauro Carvalho Chehab wrote: The default recursion limit is not good enough to handle complex books. I'm sometimes rec

Re: [PATCH] docs: conf.py: increase recursion limit

2017-04-13 Thread Markus Heiser
On 13.04.2017 12:42, Mauro Carvalho Chehab wrote: The default recursion limit is not good enough to handle complex books. I'm sometimes receiving this error message: sphinx.errors.SphinxParallelError: RecursionError: maximum recursion depth exceeded while pickling an object or

Re: [PATCH] docs: conf.py: increase recursion limit

2017-04-13 Thread Markus Heiser
Am 13.04.2017 um 15:29 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Thu, 13 Apr 2017 14:55:03 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> On 13.04.2017 12:42, Mauro Carvalho Chehab wrote: >>> The default recursio

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-03 Thread Markus Heiser
FYI >>> Yes, its only about "docutils>=0.11" in Sphinx 1.3 dependencies. >>> In Sphinx 1.5 the error: >>> >>> https://github.com/sphinx-doc/sphinx/issues/3212 >>> >>> is fixed: >>> >>> https://github.com/tk0miya/sphinx/commit/73663f63672f22304810ce6bb9787490ad250127 >>> >>> But this will

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
> Am 02.03.2017 um 16:49 schrieb Mauro Carvalho Chehab > : > >>> You can test it with virtualenv >>> https://virtualenv.pypa.io/en/stable/userguide/ >>> >>> In short: >>> >>> $ cd kernel-src >>> $ virtualenv myenv >>> $ source myenv/bin/activate >>> $ pip install

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
> Am 02.03.2017 um 17:29 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Thu, 2 Mar 2017 17:13:25 +0100 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >>> Am 02.03.2017 um 16:49 schrieb Mauro Carvalho Chehab >>> <

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-06 Thread Markus Heiser
Am 06.03.2017 um 11:12 schrieb Daniel Vetter : > Just to avoid confusion: Markus chatted a bit in private, and he > volunteered to take over, and fix the few issues that need to be fixed in > his original patch: > - drop the convertsvg python fallback, since we need convert

Re: [PATCH] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
> Am 02.03.2017 um 20:34 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Thu, 2 Mar 2017 20:06:39 +0100 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Hi Mauro, >> >>> Tested here with the enclosed patch. &g

Re: [PATCH] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
>> Btw, PDF conversion is also not working: >> >> >> File "/d00/kernel/Documentation/sphinx/kfigure.py", line 241, in svg2pdf >>cmd = [convert_cmd, svg_fname, pdf_fname] >> >> NameError: name 'convert_cmd' is not defined >> >> And including SVG files for HTML output also seems to be

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
> Am 02.03.2017 um 20:09 schrieb Mauro Carvalho Chehab > : ... >> >> Yes, its only about "docutils>=0.11" in Sphinx 1.3 dependencies. >> In Sphinx 1.5 the error: >> >> https://github.com/sphinx-doc/sphinx/issues/3212 >> >> is fixed: >> >> >>

Re: [PATCH] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
Hi Mauro, > Tested here with the enclosed patch. great, big step forward making /media/Makefile smaller ... thanks a lot > It crashed: > Exception occurred: > File "/devel/v4l/patchwork/Documentation/sphinx/kfigure.py", line 222, in > dot2format >sys.stderr.write(err) > TypeError:

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
> Am 02.03.2017 um 19:20 schrieb Jonathan Corbet <cor...@lwn.net>: > > On Thu, 2 Mar 2017 19:16:47 +0100 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> This is very easy, if we use a requiremts.txt file where we >> stick the versions and run the

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > > From: Markus Heiser <markus.hei...@darmarit.de> > > This patch brings scalable figure, image handling and a concept to > embed *render* markups: > > * DOT (http://www.graphviz.org) > * SVG > > For image

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
Am 02.03.2017 um 16:11 schrieb Daniel Vetter <dan...@ffwll.ch>: > On Thu, Mar 02, 2017 at 03:58:36PM +0100, Markus Heiser wrote: >> Hi Daniel, Laurent >> >> Am 02.03.2017 um 15:14 schrieb Laurent Pinchart >> <laurent.pinch...@ideasonboard.com>: >>

Re: [PATCH 2/6] docs-rst: automatically convert Graphviz and SVG images

2017-03-02 Thread Markus Heiser
Hi Daniel, Laurent Am 02.03.2017 um 15:14 schrieb Laurent Pinchart : > Hi Daniel, > > On Thursday 02 Mar 2017 14:54:32 Daniel Vetter wrote: >> On Thu, Mar 2, 2017 at 1:26 PM, Laurent Pinchart wrote: >>> Hi Daniel, >>> >>> Thank you for the patch. >>> >>>

[PATCH] docs: fix minimal sphinx version in conf.py

2017-08-14 Thread Markus Heiser
according to what Documentation/doc-guide/sphinx.rst says:: The ReST markups currently used by the Documentation/ files are meant to be built with ``Sphinx`` version 1.3 or upper. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/conf.py | 2 +- 1 file chan

media/v4l-drivers/imx.rst: WARNING: document isn't included in any toctree

2017-08-14 Thread Markus Heiser
Hi Steve, Mauro, when I generate documentation from Jon's docs-next, I get this warning: checking consistency... Documentation/media/v4l-drivers/imx.rst: WARNING: document isn't included in any toctree Is there already something on its way upstream or did you missed adding imx.rst to

Re: docs build questions

2017-08-14 Thread Markus Heiser
> Am 14.08.2017 um 09:45 schrieb Jani Nikula <jani.nik...@linux.intel.com>: > > On Mon, 14 Aug 2017, Markus Heiser <markus.hei...@darmarit.de> wrote: >> see "Sphinx Install" Documentation/doc-guide/sphinx.rst (ATM in Jon's >> docs-n

Re: docs build questions

2017-08-14 Thread Markus Heiser
Hi Randy, > Am 13.08.2017 um 19:29 schrieb Randy Dunlap : > > Hi, > > [on linux v4.13-rc4] > >> sphinx-build --version > Sphinx (sphinx-build) 1.2.3 see "Sphinx Install" Documentation/doc-guide/sphinx.rst (ATM in Jon's docs-next) The ReST markups currently used by the

[PATCH] docs: fix nested numbering in the TOC

2017-08-14 Thread Markus Heiser
-funcs.rst is just a C typo, so lets remove it. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/input/joydev/index.rst | 1 - Documentation/media/uapi/cec/cec-funcs.rst | 1 - 2 files changed, 2 deletions(-) diff --git a/Documentation/input/joydev/index.

Re: [PATCH] [PATCH v6] docs-rst: automatically convert Graphviz and SVG images

2017-07-14 Thread Markus Heiser
> Am 13.07.2017 um 22:50 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Mon, 6 Mar 2017 14:09:27 +0100 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> This patch brings scalable figure, image handling and a concept to >

Re: [PATCH 0/5] Add a script to check for Sphinx install requirements

2017-07-17 Thread Markus Heiser
> Am 17.07.2017 um 00:08 schrieb Mauro Carvalho Chehab > : > > [1] There's an unrelated bug with the Kernel's sphinx extension > kimage: when parsing GraphViz graphs, it uses "-Tpdf" argument, > in order to generate a PDF image. That doesn't work on some > distros, as

Re: [PATCH 0/5] Add a script to check for Sphinx install requirements

2017-07-17 Thread Markus Heiser
> Am 17.07.2017 um 12:09 schrieb Mauro Carvalho Chehab > : > >> >> Anyway, I guess we should modify kfigure.py to check if PDF is >> available, falling back to SVG, using ImageMagick to convert >> from SVG to PDF. > > Ok, I discovered that, on Fedora, support for

Re: [PATCH 2/6] docs-rst: update Sphinx install instructions

2017-07-14 Thread Markus Heiser
> Am 14.07.2017 um 17:44 schrieb Jonathan Corbet : > > On Fri, 14 Jul 2017 08:08:19 -0300 > Mauro Carvalho Chehab wrote: > >> +Please see :ref:`sphinx_install` at the doc-guide for details about >> +Sphinx requirements. > > One small comment here:

Re: [PATCH RFC] scripts/sphinx-pre-install: add a script to check Sphinx install

2017-07-15 Thread Markus Heiser
> Am 15.07.2017 um 04:21 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Fri, 14 Jul 2017 19:35:59 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >>> Am 14.07.2017 um 18:49 schrieb Mauro Carvalho Chehab >>> <

Re: [PATCH 0/5] Add a script to check for Sphinx install requirements

2017-07-18 Thread Markus Heiser
> Am 17.07.2017 um 12:57 schrieb Mauro Carvalho Chehab > : > > So, we need a way for kfigure to fallback when distros don't > have such feature. Hm .. I'am not very happy to implement where distros packaging fail. But .. if there is really a need for, I will do so.

Re: [PATCH 3/5] sphinx-pre-install: use a requirements file

2017-07-17 Thread Markus Heiser
> Am 17.07.2017 um 00:08 schrieb Mauro Carvalho Chehab > : > > Instead of using 3 commands to install a virtualenv, use > a single one, reading the requirements from this file: > > Documentation/sphinx/requirements.txt > > Signed-off-by: Mauro Carvalho Chehab

Re: [PATCH RFC] scripts/sphinx-pre-install: add a script to check Sphinx install

2017-07-16 Thread Markus Heiser
Hy Mauro, thanks a lot for your RFC, your patch consolidate a lot of knowledge around Sphinx build requirements and brings a huge value I will no longer miss. I tested v6 of this patch on ubuntu and there is only some conceptual bikeshedding I can do. > Am 15.07.2017 um 14:49 schrieb Mauro

Re: [PATCH] scripts/kernel-doc: handle DECLARE_HASHTABLE

2017-07-01 Thread Markus Heiser
> Am 01.07.2017 um 04:09 schrieb Jakub Kicinski : > > DECLARE_HASHTABLE needs similar handling to DECLARE_BITMAP > because otherwise kernel-doc assumes the member name is the > second, not first macro parameter. > > Signed-off-by: Jakub Kicinski

[PATCH] Docs: add 'lintdocs' target with basic sanity checks

2017-07-04 Thread Markus Heiser
From: Markus Heiser <markus.hei...@darmarit.de> The 'lintdocs' produces no output. The input is only parsed and checked for consistency. This is useful for basic sanity checks [1]. The 'lintdocs' target uses Sphinx's 'dummy' builder. For this at least Sphinx 1.4 is needed [2]. Sphi

Re: [PULL] Docs for 4.13

2017-07-04 Thread Markus Heiser
Hi Jon, > Am 04.07.2017 um 06:32 schrieb Linus Torvalds : [...] > At the same time, lots of people run a lot of builds, and while I'd > love to see warnings about docs failures, I am *not* willing to slow > down my usual build enormously. I run "male allmodconfig"

Re: [PATCH 1/2] docs RDT theme: fix bottom margin of lists items

2017-07-03 Thread Markus Heiser
Hi Jon, sorry for my noise .. did you received the two patches? -- Markus -- > Am 17.06.2017 um 10:17 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > List items with two ore more blocks are not well rendered. E.g. the gap > between last block (l1-b2) of t

Re: [PATCH 0/5] Make PDF builds work again

2017-07-06 Thread Markus Heiser
> Am 05.07.2017 um 23:22 schrieb Jim Davis : > > On Mon, Jul 3, 2017 at 5:44 AM, Jonathan Corbet wrote: >> On Mon, 3 Jul 2017 10:25:38 +0200 >> Daniel Vetter wrote: >> >>> Only now stumbled over the full thread, but the drm patch is

Re: [PATCH] Docs: add 'lintdocs' target with basic sanity checks

2017-07-06 Thread Markus Heiser
> Am 05.07.2017 um 23:14 schrieb Jim Davis <jim.ep...@gmail.com>: > > On Tue, Jul 4, 2017 at 12:39 AM, Markus Heiser > <markus.hei...@darmarit.de> wrote: >> From: Markus Heiser <markus.hei...@darmarit.de> >> >> The 'lintdocs' produces

Re: [PATCH] kernel-doc parser mishandles declarations split into lines

2017-07-06 Thread Markus Heiser
> Am 03.07.2017 um 10:22 schrieb Daniel Vetter <dan...@ffwll.ch>: > > On Fri, Jun 16, 2017 at 09:27:48PM +0200, Markus Heiser wrote: >> R--- >> scripts/kernel-doc | 4 >> 1 file changed, 4 insertions(+) >> >> diff --git a/scripts/kernel-doc b

Re: [PATCH v2 00/53] Get rid of Docbook

2017-07-06 Thread Markus Heiser
> Am 05.07.2017 um 23:45 schrieb Jim Davis <jim.ep...@gmail.com>: > > On Fri, Jun 16, 2017 at 7:03 AM, Markus Heiser > <markus.hei...@darmarit.de> wrote: >> > >> docproc and some lines in the Makefile & .gitignore >> >> ./scripts/do

Re: patch "doc-rst: fixed kernel-doc directives in usb/typec.rst" added to usb-linus

2017-05-17 Thread Markus Heiser
he week.) > > The patch will hopefully also be merged in Linus's tree for the > next -rc kernel release. > > If you have any questions about this process, please let me know. > > > From 5383fae76b8224a8f0465be6ab9c7a645042951a Mon Sep 17 00:00:00 2001 > From: Markus He

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

2017-05-12 Thread Markus Heiser
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 > > Signed-off-by: Mauro Carvalho Chehab

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

2017-05-12 Thread Markus Heiser
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 for it to be parsed without errors > - Use

<    1   2   3   4   >