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

2019-07-17 Thread Markus Heiser
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 --- Documentation/sphinx/kernel_abi.py | 20 +++- 1 file changed, 7 insertions(+), 13 deletions(-)

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

2019-07-18 Thread Markus Heiser
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 Chehab escreveu: Em Fri, 12 Jul 2019 14:19:21 -0600 Jonathan Corbet escreveu: Can't you just make rst2pdf work inste

Re: [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts

2019-09-06 Thread Markus Heiser
In practice the python needs "-*- coding: utf-8 -*- to be in one of the first two lines. The SPDX tag in practice has to be in one of the first 15 lines: ap.add_argument('-m', '--maxlines', type=int, default=15, help='Maximum number of lines to scan in a file. Default 1

Re: [PATCH] docs: license-rules.txt: cover SPDX headers on Python scripts

2019-09-06 Thread Markus Heiser
Am 05.09.19 um 16:17 schrieb Greg Kroah-Hartman: On Thu, Sep 05, 2019 at 06:57:01AM -0600, Jonathan Corbet wrote: On Thu, 5 Sep 2019 06:23:13 -0300 Mauro Carvalho Chehab wrote: Python's PEP-263 [1] dictates that an script that needs to default to UTF-8 encoding has to follow this rule:

Re: [PATCH 0/6] Address issues with SPDX requirements and PEP-263

2019-09-07 Thread Markus Heiser
Am 07.09.19 um 15:34 schrieb Jonathan Corbet: On Thu, 5 Sep 2019 16:57:47 -0300 Mauro Carvalho Chehab wrote: The description at Documentation/process/license-rules.rst is very strict with regards to the position where the SPDX tags should be. In the past several developers and maintainers

Re: [PATCH 0/6] Address issues with SPDX requirements and PEP-263

2019-09-07 Thread Markus Heiser
Am 07.09.19 um 18:22 schrieb Mauro Carvalho Chehab: Em Sat, 7 Sep 2019 16:36:36 +0200 Markus Heiser escreveu: Am 07.09.19 um 15:34 schrieb Jonathan Corbet: On Thu, 5 Sep 2019 16:57:47 -0300 Mauro Carvalho Chehab wrote: The description at Documentation/process/license-rules.rst is

Re: [PATCH 0/6] Address issues with SPDX requirements and PEP-263

2019-09-07 Thread Markus Heiser
Am 07.09.19 um 20:04 schrieb Mauro Carvalho Chehab: Em Sat, 7 Sep 2019 19:33:06 +0200 Markus Heiser escreveu: An (uncatched) exception is thrown, when writing UTF-8 to a stream which do not support UTF-8 .. this is not a crash, it mostly indicates that the developper makes some wrong

Re: undefined label

2019-03-07 Thread Markus Heiser
Am 07.03.19 um 10:17 schrieb Tobin C. Harding: Hi Jon, I hit that undefined label warning again today. Then just now I was sitting enjoying a quite scotch and the reason came to me. It is caused by building part of the docs instead of the whole tree i.e. using make SPHINXDIRS=admin-gu

Re: [PATCH 7/9] docs: Remove unknown 'hint' directive

2019-03-08 Thread Markus Heiser
Am 08.03.19 um 04:51 schrieb Randy Dunlap: On 3/7/19 1:11 PM, Tobin C. Harding wrote: Current RST file contains an unknown directive causing Sphinx to emit ERROR: Unexpected indentation. Use normal language construct instead. Signed-off-by: Tobin C. Harding This is a good idea.

Re: [PATCH 0/9] docs: Fix various build warnings/errors

2019-03-08 Thread Markus Heiser
Am 07.03.19 um 22:11 schrieb Tobin C. Harding: Hi, I had a few hours to spare so I thought I'd clear some Sphinx build warnings/errors. There isn't anything too controversial here. The only interesting thing I hit was in patch 7 (docs: Remove unknown 'hint' directive), I couldn't work out if

Re: undefined label

2019-03-08 Thread Markus Heiser
Hi Tobin, Am 07.03.19 um 21:30 schrieb Tobin C. Harding: On Thu, Mar 07, 2019 at 10:58:07AM +0100, Markus Heiser wrote: [...] If there is any interest in, I can implement a RFC for this. Cool! I think this would be super useful, I for one like using SPHINXDIRS when developing docs

Re: [PATCH 0/9] docs: Fix various build warnings/errors

2019-03-09 Thread Markus Heiser
Am 08.03.19 um 21:16 schrieb Tobin C. Harding: Hi Tobin, the problem was a missing empty line (see my comment on this patch). The reST primer from sphinx-doc is always a good reference for the daily work http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives T

Re: undefined label

2019-03-12 Thread Markus Heiser
Am 11.03.19 um 18:30 schrieb Jonathan Corbet: On Fri, 08 Mar 2019 14:17:47 +0200 Jani Nikula wrote: >> To close such cross-books links we can use intersphinx [1] and map to e.g. >> >>intersphinx_mapping = { >>'kernel': ('https://www.kernel.org/doc/html/latest/', None)} T

Re: [PATCH RFC 0/2] docs: Deal with some Sphinx deprecation warnings

2019-05-22 Thread Markus Heiser
22.05.19 um 12:19 schrieb Mauro Carvalho Chehab: Em Wed, 22 May 2019 10:36:45 +0300 Jani Nikula escreveu: On Tue, 21 May 2019, Jonathan Corbet wrote: The Sphinx folks are deprecating some interfaces in the upcoming 2.0 release; one immediate result of that is a bunch of warnings that show up

Re: [PATCH] linux: README: reduced README size by 1 byte by removing unnecessary space character

2019-06-07 Thread Markus Heiser
Am 07.06.19 um 07:59 schrieb Alex: From: Aaron A Montoya On line 9 of the README there is an unnecessary extra space character, after the period, that adds 1 byte of size to the file. By removing the unnecessary space, Linux downloads will be 1 byte smaller and therefor be faster to download

Re: [PATCH v3 00/33] Convert files to ReST - part 1

2019-06-09 Thread Markus Heiser
Am 09.06.19 um 11:16 schrieb Heiko Carstens: Will there be a web page (e.g. kernel.org), which contains always the latest upstream version? You are looking for the HTML docs on kernel.org? https://www.kernel.org/doc/html/latest/ -- Markus --

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

2019-06-14 Thread Markus Heiser
Am 14.06.19 um 15:42 schrieb Jani Nikula: On Thu, 13 Jun 2019, Mauro Carvalho Chehab wrote: From: 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/

Re: [PATCH 14/14] docs: sphinx/kernel_abi.py: fix UTF-8 support

2019-06-16 Thread Markus Heiser
Am 14.06.19 um 18:25 schrieb Mauro Carvalho Chehab: Em Fri, 14 Jun 2019 18:18:37 +0200 Greg Kroah-Hartman escreveu: On Thu, Jun 13, 2019 at 11:04:20PM -0300, Mauro Carvalho Chehab wrote: The parser breaks with UTF-8 characters with Sphinx 1.4. Signed-off-by: Mauro Carvalho Chehab --- Do

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

2019-06-16 Thread Markus Heiser
Am 14.06.19 um 16:15 schrieb Jonathan Corbet: On Fri, 14 Jun 2019 16:10:31 +0200 Markus Heiser wrote: I agree with Jani. No matter how the decision ends, since I can't help here, I'd rather not show up in the copyright. Is there something specific you are asking us to do here?

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

2019-06-17 Thread Markus Heiser
Am 17.06.19 um 11:11 schrieb Mauro Carvalho Chehab: Em Sun, 16 Jun 2019 18:04:01 +0200 Markus Heiser escreveu: Am 14.06.19 um 16:15 schrieb Jonathan Corbet: On Fri, 14 Jun 2019 16:10:31 +0200 Markus Heiser wrote: I agree with Jani. No matter how the decision ends, since I can't

Re: [PATCH] mac80211: fix documentation warnings

2017-01-13 Thread Markus Heiser
Am 13.01.2017 um 11:12 schrieb Johannes Berg : > From: Johannes Berg > > For a few restructured text warnings in mac80211, making the > documentation warning-free (for now). Again, this required > adding trailing whitespace to keep multiple paragraphs in a > parameter description together. > >

Re: [PATCH] kernel-doc: Handle returning pointers to pointers

2017-01-23 Thread Markus Heiser
ter, > unsigned long start) ' > > Indeed, the regexes only handled a single '*', not one-or-more. Hi Matthew ! short answer: Thanks a lot Acked-by: Markus Heiser to be more verbose: what I have tested and what I recommend ... I maintain my own stack of "

Re: [PATCH 0/5] kernel-doc tweaks and cleanup of rST vs. non-rST backends

2017-01-23 Thread Markus Heiser
Am 04.01.2017 um 23:06 schrieb Jonathan Corbet : > On Mon, 2 Jan 2017 16:22:22 +0100 > Paolo Bonzini wrote: > >> these patches are the result of my experiments with using kernel-doc >> for QEMU's documentation. Patches 1 and 2 should be relatively >> straightforward, as they are simple bugfix

Re: [PATCH 0/5] kernel-doc tweaks and cleanup of rST vs. non-rST backends

2017-01-23 Thread Markus Heiser
Am 23.01.2017 um 14:58 schrieb Paolo Bonzini : >> >> Hi Paolo ! >> >> Sorry for my late reply, I'am testing patch 2: >> >> https://www.mail-archive.com/linux-doc@vger.kernel.org/msg08503.html >> >> but I can't find any changes in the reST output (even not in >> include/linux/log2.h >> you me

Re: [PATCH] kernel-doc: Handle returning pointers to pointers

2017-01-23 Thread Markus Heiser
Am 23.01.2017 um 16:24 schrieb Jonathan Corbet : > On Mon, 23 Jan 2017 15:14:51 + > Matthew Wilcox wrote: > >>> I maintain my own stack of "linuxdoc" with a python version >>> of the kernel-doc script (hosted on github). It uses the same >>> regexes as the perl version (using a python rewri

[RFC PATCH v1 0/6] pure python kernel-doc parser and more

2017-01-24 Thread Markus Heiser
g/msg09002.html Markus Heiser (6): kernel-doc: pure python kernel-doc parser (preparation) kernel-doc: replace kernel-doc perl parser with a pure python one (WIP) kernel-doc: add kerneldoc-lint command kernel-doc: insert TODOs on kernel-doc errors kernel-doc: add kerneldoc-src2rst command

[RFC PATCH v1 6/6] kernel-doc: add man page builder (target mandocs)

2017-01-24 Thread Markus Heiser
int ... After the whole doctree is build by sphinx-build it is stored in the env and the builder takes place. These *invisible* 'kernel_doc_man' nodes will be ignored by all builders (html, pdf etc.) except the 'kernel-doc-man' builder. The later p

[RFC PATCH v1 5/6] kernel-doc: add kerneldoc-src2rst command

2017-01-24 Thread Markus Heiser
If you don't want this, use option '--threads=n'. [1] https://h2626237.stratoserver.net/kernel/linux_src_doc/index.html [2] https://docs.python.org/3.6/library/multiprocessing.html Signed-off-by: Markus Heiser --- Documentation/sphinx/src2rst.py | 229 +++

[RFC PATCH v1 1/6] kernel-doc: pure python kernel-doc parser (preparation)

2017-01-24 Thread Markus Heiser
th [1]. As an alternative to this patch we can add an external dependence which can be installed from PyPi with 'pip install fspath' see [2] (but I guess we won't more external dependencies). [1] https://pypi.python.org/pypi/fspath/ {2] https://return42.github.io/fspath/ Signed-o

[RFC PATCH v1 3/6] kernel-doc: add kerneldoc-lint command

2017-01-24 Thread Markus Heiser
tor()) Latter is also a small example of how-to implement kernel-doc applications with the kernel-doc parser architecture. [1] https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#writing-kernel-doc-comments Signed-off-by: Markus Heiser --- Docu

[RFC PATCH v1 4/6] kernel-doc: insert TODOs on kernel-doc errors

2017-01-24 Thread Markus Heiser
are to many errors (false positives) and it needs some discussion. Take this as a starting point. [1] http://www.sphinx-doc.org/en/stable/ext/todo.html [2] http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/scripts/kernel-doc#n3073 Signed-off-by: Markus Heiser --- Documentation/

Re: [PATCH] kernel-doc: Handle returning pointers to pointers

2017-01-24 Thread Markus Heiser
Am 24.01.2017 um 16:35 schrieb Matthew Wilcox : > From: Markus Heiser [mailto:markus.hei...@darmarit.de] >> Am 23.01.2017 um 16:24 schrieb Jonathan Corbet : >>> Markus, would you consider sending out a new patch set for review? >> >> Yes, I send RFC soon ... >

Re: [RFC PATCH v1 2/6] kernel-doc: replace kernel-doc perl parser with a pure python one (WIP)

2017-01-24 Thread Markus Heiser
Hi Jon, hi Daniel ! Am 25.01.2017 um 07:37 schrieb Daniel Vetter : >> Again, quick comments... >> >> - I would *much* rather evolve our existing Sphinx extension in the >> direction we want it to go than to just replace it wholesale. >> Replacement is the wrong approach for a few reasons, in

Re: [RFC PATCH v1 3/6] kernel-doc: add kerneldoc-lint command

2017-01-25 Thread Markus Heiser
Am 25.01.2017 um 09:21 schrieb Jani Nikula : > Yes, see below. It's simplistic and it has an external dependency, but > it got the job done. And it does not depend on Sphinx; it's just a > kernel-doc and rst lint, not Sphinx lint. Whether that's a good or a bad > thing is debatable. > > Anyway, I

Re: [RFC PATCH v1 2/6] kernel-doc: replace kernel-doc perl parser with a pure python one (WIP)

2017-01-25 Thread Markus Heiser
Am 25.01.2017 um 11:24 schrieb Jani Nikula : > Markus, thanks for your work on this. Thanks for your comments! > Excuse me for my bluntness, but I think changing everything in a single > commit, or even a few commits, is strictly not acceptable. OK, I understand. > When I changed *small* thin

Re: [RFC PATCH v1 2/6] kernel-doc: replace kernel-doc perl parser with a pure python one (WIP)

2017-01-26 Thread Markus Heiser
Am 25.01.2017 um 21:59 schrieb Jani Nikula : >> But the problem I see here is, that the perl script generates a >> reST output which I can't use. As an example we can take a look at >> the man-page builder I shipped in the series. > > Sorry, I still don't understand *why* you can't use the same

Re: [RFC PATCH v1 2/6] kernel-doc: replace kernel-doc perl parser with a pure python one (WIP)

2017-01-27 Thread Markus Heiser
Am 26.01.2017 um 20:26 schrieb Jani Nikula : > On Thu, 26 Jan 2017, Jonathan Corbet wrote: >> Give me a new kerneldoc that passes those tests, and I'll happily >> merge it. (I have some sympathy with the idea that we should look >> into other parsers, but I would not hold up a new kerneldoc tha

Re: [PATCH 1/3] doc-rst: Break shell command sequences on failure

2017-01-31 Thread Markus Heiser
Fixes: 606b9ac81a63 ("doc-rst: generic way to build only sphinx sub-folders") > Fixes: cd21379b1698 ("doc-rst: generic way to build PDF of sub-folders") > Signed-off-by: Ben Hutchings Tested-by: Markus Heiser Thanks a lot! -- Markus -- -- To unsubscribe from this list

Re: [PATCH 2/3] doc-rst: Delete output of failed dot-SVG conversion

2017-01-31 Thread Markus Heiser
Am 31.01.2017 um 08:36 schrieb Jani Nikula : > On Tue, 31 Jan 2017, Ben Hutchings wrote: >> As we use redirection to create the SVG file, even a failed conversion >> will create the file and 'make' will consider it up-to-date if the >> build is retried. We should delete it in case of failure. >

Re: [PATCH 3/3] doc-rst: Fix recursive make invocation from macros

2017-01-31 Thread Markus Heiser
Am 31.01.2017 um 01:18 schrieb Ben Hutchings : > In any case where we recurse but don't mention $(MAKE) literally in > the recipe, we need to add a '+' at the start of the command to ensure > that parallel makes and various other options work properly. Tested-by: Mark

[PATCH] doc-rst: fixed cleandoc target when used with O=dir

2017-01-31 Thread Markus Heiser
x:100: recipe for target 'cleandocs' failed Signed-off-by: Markus Heiser --- Documentation/Makefile.sphinx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx index e14d82a..be1936e 100644 --- a/Documentation/Makefi

Re: [PATCH 2/3] doc-rst: Delete output of failed dot-SVG conversion

2017-01-31 Thread Markus Heiser
Am 31.01.2017 um 11:41 schrieb Mauro Carvalho Chehab : > Em Tue, 31 Jan 2017 09:44:10 +0100 > Markus Heiser escreveu: > >> BTW, my 'convert' (ImageMagick) is very slow and CPU consuming: >> >> GENPDF Documentation/media/uapi/v4l/selection.svg >&g

Re: error in `make pdfdocs`

2017-02-08 Thread Markus Heiser
Am 08.02.2017 um 22:17 schrieb 慕冬亮 : > Hi all, > > when I `make pdfdocs`, I encountered one error in the following: > > --- > $ make pdfdocs > HOSTCC scripts/

Re: making documentation targets on v4.10 with Fedora 25

2017-02-23 Thread Markus Heiser
On 23.02.2017 20:44, Jim Davis wrote: On Thu, Feb 23, 2017 at 2:59 AM, Jani Nikula wrote: On Mon, 20 Feb 2017, Jim Davis wrote: For the Sphinx targets, htmldocs, pdfdocs, epubdocs, and cleandocs failed. cleandocs works without the O= argument, and arguably the O= thing isn't very useful wi

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

2017-03-02 Thread Markus Heiser
Am 02.03.2017 um 08:12 schrieb Daniel Vetter : > On Wed, Mar 01, 2017 at 12:56:36PM -0300, Gabriel Krisman Bertazi wrote: >> Daniel Vetter writes: >> >> Hi Daniel, >> >>> +if dst_fname: >>> +name = dst_fname[len(out_dir) + 1:] >>> +# the builder needs not to copy one more t

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. >>> >>> With this applied, I get >>> >>> make

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 : > 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 >> : >> >>> Hi Daniel, >>> >>> On Thursday

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 'Sphinx==1.3.1' >>> $ make .

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 > : > > Em Thu, 2 Mar 2017 17:13:25 +0100 > Markus Heiser escreveu: > >>> Am 02.03.2017 um 16:49 schrieb Mauro Carvalho Chehab >>> : >>> >>>>> You can test it with virtu

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 : > > On Thu, 2 Mar 2017 19:16:47 +0100 > Markus Heiser wrote: > >> This is very easy, if we use a requiremts.txt file where we >> stick the versions and run the sphinx in this build in a >> virtualenv which is

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: wri

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: >> >> >> https://github.com/tk0miya/sphinx/commit/73663f

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 > : > > Em Thu, 2 Mar 2017 20:06:39 +0100 > Markus Heiser escreveu: > >> Hi Mauro, >> >>> Tested here with the enclosed patch. >> >> great, big step forward making /media/Makefi

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
schrieb Daniel Vetter : > > From: Markus Heiser > > This patch brings scalable figure, image handling and a concept to > embed *render* markups: > > * DOT (http://www.graphviz.org) > * SVG > > For image handling use the 'image' replacement:: > >

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 ne

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

2017-03-06 Thread Markus Heiser
vger.kernel.org/msg09828.html [2] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg09821.html Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Cc: Jani Nikula Cc: Mauro Carvalho Chehab Cc: Markus Heiser Cc: Laurent Pinchart Signed-off-by: Daniel Vetter (v2 - v5) Signed-off-by:

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&I 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 anyway > - relative

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, if there is a version with onl

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 ;-) I'am not very happy with this

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 : > On Thu, 30 Mar 2017, Markus Heiser wrote: >> 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 &

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 >>> documentation in rst at

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 : > > If it helps ... dbxml2rst also supports single file conversion ... I updated: > > > https://github.com/return42/sphkerneldoc/tree/master/Documentation/books_migrated > > There you find a folder for each DocBook convers

Re: doc build requirements

2017-03-31 Thread Markus Heiser
? :) no ;) yes, you are right and we have improved it; since .. -- doc-4.11-images db6ccf23e8ba40fc2e8914ec9c0eb950df71d9fe Author: Markus Heiser AuthorDate: Mon Mar 6 14:09:27 2017 +0100 docs-rst: automatically convert Graphviz and SVG images -- the situation is much better: for HTML, dot installati

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 "unused-functions" like this > > .. kernel-doc:: > :

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 those:

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 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 receiving this error me

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 : > Em Thu, 13 Apr 2017 14:55:03 +0200 > Markus Heiser escreveu: > >> On 13.04.2017 12:42, Mauro Carvalho Chehab wrote: >>> The default recursion limit is not good enough to handle >>> complex books. I

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

2017-04-20 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 ABI logic there, but, in th

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 **bold** for emphasis. > > Signed

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 > --- > Documentation/DocBook/Makefile

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 > --- > Documentation/DocBook/Makefile

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

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

[PATCH] core-api: remove an unexpected unident

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

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

2017-05-13 Thread Markus Heiser
-by: Markus Heiser --- Documentation/userspace-api/unshare.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/userspace-api/unshare.rst b/Documentation/userspace-api/unshare.rst index 737c192..877e90a 100644 --- a/Documentation/userspace-api/unshare.rst +++ b

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

2017-05-13 Thread Markus Heiser
functions: typec_set_data_role typec_set_pwr_role typec_set_vconn_role typec_set_pwr_opmode Signed-off-by: Markus Heiser --- Documentation/usb/typec.rst | 6 ++ 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/Documentation/usb/typec.rst b/Documentation/usb/typec.rst index b67a467..8a7249f

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

2017-05-17 Thread Markus Heiser
ill 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 Heiser > Date: Sat, 13 M

Re: kernel-doc mishandles declarations split into lines

2017-06-16 Thread Markus Heiser
> Am 06.06.2017 um 15:28 schrieb Johannes Berg : > > Hi, > > Apologies for the long CC list, wasn't sure who really feels like they > understand this script anymore ... Markus, I think you had a rewrite of > the script in python? Hi Johannes, hi Mauro, (Jon) sorry for my late reply. Yes I have

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

2017-06-16 Thread Markus Heiser
> Am 19.05.2017 um 01:01 schrieb Mauro Carvalho Chehab > : > > Em Thu, 18 May 2017 11:26:08 -0600 > Jonathan Corbet escreveu: > >> On Tue, 16 May 2017 09:15:52 -0300 >> Mauro Carvalho Chehab wrote: >> >>> This patch series convert the remaining DocBooks to ReST. >> >> Gotta love this: >> >

Re: kernel-doc mishandles declarations split into lines

2017-06-16 Thread Markus Heiser
> Am 16.06.2017 um 15:11 schrieb Johannes Berg : > > Hi Markus, > >> The parser part is same state machine as the the perl one … with same >> problems ;) > > :-) > >> Problem here; function process_proto_type() concatenates the striped >> lines of declaration without any whitespace. A one-line

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

2017-06-16 Thread Markus Heiser
x27; Problem here: dump_enum() does not strip leading whitespaces from the concatenated string (with the new additional space from process_proto_type). [1] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg12410.html Signed-off-by: Markus Heiser --- scripts/kernel-doc | 4 1 file change

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

2017-06-17 Thread Markus Heiser
that it can be read more liquidly, a distance was added to the last block (l1-b2):: * L1 xx x l1-b2 xxx x * L2 xx x Signed-off-by: Markus Heiser --- Documentation/sphinx-static/theme_overrides.css | 6

[PATCH 2/2] docs RTD theme: code-block with line nos - lines and line numbers don't line up.

2017-06-17 Thread Markus Heiser
the future (take this as a interim solution). Signed-off-by: Markus Heiser --- Documentation/sphinx-static/theme_overrides.css | 11 +++ 1 file changed, 11 insertions(+) diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css index

Re: [PATCH] changes.rst: explain the usage of virtual environment

2017-06-19 Thread Markus Heiser
> Am 19.06.2017 um 15:46 schrieb Jonathan Corbet : > > On Mon, 19 Jun 2017 06:08:37 -0700 > Christoph Hellwig wrote: > >> On Mon, Jun 19, 2017 at 08:24:10AM -0300, Mauro Carvalho Chehab wrote: >>> As the Sphinx build seems very fragile, specially for >>> PDF output, add a notice about how to us

Re: [PATCH] changes.rst: explain the usage of virtual environment

2017-06-19 Thread Markus Heiser
> Am 19.06.2017 um 16:38 schrieb Mauro Carvalho Chehab > : > > HI Markus, > Hi Mauro :) [...] >> Typically I have a PY_ENV target in my projects, building a virtualenv >> in a folder named ./local. E.g. in LinuxDoc [1] I use something like this: >> >> PY ?=3 >> PYTHON ?= python$(PY) >> .. >

[PATCH] docs: add virtualenv to Documentation's build chain

2017-06-20 Thread Markus Heiser
[1] https://virtualenv.pypa.io [2] https://pip.pypa.io [3] https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format Signed-off-by: Markus Heiser --- Documentation/.gitignore | 1 + Documentation/Makefile| 76 -- Documentation/Make

Re: [PATCH] changes.rst: explain the usage of virtual environment

2017-06-20 Thread Markus Heiser
[...] > Am 19.06.2017 um 17:13 schrieb Markus Heiser : > >>> Typically I have a PY_ENV target in my projects, building a virtualenv >>> in a folder named ./local. [...] >> Yeah, IMHO, it makes sense to have something like that at the main build, >> as an opt

Re: [PATCH] docs: add virtualenv to Documentation's build chain

2017-06-20 Thread Markus Heiser
> Am 20.06.2017 um 21:56 schrieb Jonathan Corbet : > > On Tue, 20 Jun 2017 16:51:40 +0200 > Markus Heiser wrote: > >> This add a virtualenv [1] with we can control the versions >> of Documentation's (python) requirements. It also changes the >> default b

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 > --- > scripts/kernel-doc | 2 ++ > 1 file change

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 : > > List items with two ore more blocks are not well rendered. E.g. the gap > between last block (l1-b2) of the first list item and the following list >

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

2017-07-04 Thread Markus Heiser
From: Markus Heiser 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]. Sphinx

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" builds > between every single p

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

2017-07-05 Thread Markus Heiser
> Am 05.07.2017 um 23:14 schrieb Jim Davis : > > On Tue, Jul 4, 2017 at 12:39 AM, Markus Heiser > wrote: >> From: Markus Heiser >> >> The 'lintdocs' produces no output. The input is only parsed and checked for >> consistency. This is useful for

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 : > > 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/scripts/kernel-doc &g

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 already >>> queued up for at least 4.13 (Dave was out and all

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 : > > On Fri, Jun 16, 2017 at 7:03 AM, Markus Heiser > wrote: >> > >> docproc and some lines in the Makefile & .gitignore >> >> ./scripts/docproc.c >> ./scripts/.docproc.cmd >> ./scripts/Makefi

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 > : > > Em Mon, 6 Mar 2017 14:09:27 +0100 > Markus Heiser escreveu: > >> This patch brings scalable figure, image handling and a concept to >> embed *render* markups: >> >> * DOT (http://www.g

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: formatting things this way assumes that people

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

2017-07-14 Thread Markus Heiser
> Am 14.07.2017 um 18:49 schrieb Mauro Carvalho Chehab > : > > Solving Sphinx dependencies can be painful. Add a script to > check if everything is ok. just my 5cent: What we need is a "requirements.txt" file to define a **reference environment**. E.g. to stick Sphinx 1.4.9 in such a reference

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 > : > > Em Fri, 14 Jul 2017 19:35:59 +0200 > Markus Heiser escreveu: > >>> Am 14.07.2017 um 18:49 schrieb Mauro Carvalho Chehab >>> : >>> >>> Solving Sphinx dependencies can be

  1   2   3   4   5   >