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

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)

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. >

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

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*

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

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

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

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,

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

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

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

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,

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

Am 24.01.2017 um 16:35 schrieb Matthew Wilcox <mawil...@microsoft.com>: > From: Markus Heiser [mailto:markus.hei...@darmarit.de] >> Am 23.01.2017 um 16:24 schrieb Jonathan Corbet <cor...@lwn.net>: >>> Markus, would you consider sending out a new patch set for revie

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

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 ... >

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

]. 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-off-by: Markus Heiser

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

]. 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-off-by: Markus Heiser

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

ors (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 <markus.hei...@darmarit.de> --

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

ors (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/admin-guide/con

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

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 <markus.hei...@darmarit.de> --- Documentation/sphinx/lint.py

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

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 kernel-doc: add

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

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 --- Documentation/sphinx/lint.py | 121

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

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 kernel-doc: add

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

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 picks up those nodes from the doctree and builds a manpage from the surrounding . Signed-off-by: Markus Heiser <markus.hei...@darmarit

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

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 picks up those nodes from the doctree and builds a manpage from the surrounding . Signed-off-by: Markus Heiser --- Documentation

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

n'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 <markus.hei...@darmarit.de> --- Documentation/sphinx/src2rst

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

n'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 scripts/kernel

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

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

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

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

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

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

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

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

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

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

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

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

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

truct radix_tree_iter *iter, > 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 <markus.hei...@darmarit.de> to be more verbose: what I have tested and what I rec

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

> 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 "linuxdoc" with

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

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

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

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 converting existing .txt files

Re: [Ksummit-discuss] Including images on Sphinx documents

Am 11.11.2016 um 12:22 schrieb Jani Nikula <jani.nik...@linux.intel.com>: > On Thu, 10 Nov 2016, Jani Nikula <jani.nik...@linux.intel.com> wrote: >> On Thu, 10 Nov 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >>> Could this POC persuade you, if so, I

Re: [Ksummit-discuss] Including images on Sphinx documents

Am 11.11.2016 um 12:22 schrieb Jani Nikula : > On Thu, 10 Nov 2016, Jani Nikula wrote: >> On Thu, 10 Nov 2016, Markus Heiser wrote: >>> Could this POC persuade you, if so, I send a more elaborate RFC, >>> what do you think about? >> &

Re: [Ksummit-discuss] Including images on Sphinx documents

On 09.11.2016 12:58, Jani Nikula wrote: > On Wed, 09 Nov 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 09.11.2016 um 12:16 schrieb Jani Nikula <jani.nik...@linux.intel.com>: >>>> So I vote for : >>>> >>>>>

Re: [Ksummit-discuss] Including images on Sphinx documents

On 09.11.2016 12:58, Jani Nikula wrote: > On Wed, 09 Nov 2016, Markus Heiser wrote: >> Am 09.11.2016 um 12:16 schrieb Jani Nikula : >>>> So I vote for : >>>> >>>>> 1) copy (or symlink) all rst files to Documentation/output (or to the >>

Re: [Ksummit-discuss] Including images on Sphinx documents

Am 09.11.2016 um 12:16 schrieb Jani Nikula : >> So I vote for : >> >>> 1) copy (or symlink) all rst files to Documentation/output (or to the >>> build dir specified via O= directive) and generate the *.pdf there, >>> and produce those converted images via Makefile.;

Re: [Ksummit-discuss] Including images on Sphinx documents

Am 09.11.2016 um 12:16 schrieb Jani Nikula : >> So I vote for : >> >>> 1) copy (or symlink) all rst files to Documentation/output (or to the >>> build dir specified via O= directive) and generate the *.pdf there, >>> and produce those converted images via Makefile.; > > We're supposed to solve

Re: [Ksummit-discuss] Including images on Sphinx documents

Am 07.11.2016 um 18:01 schrieb Josh Triplett : > On Mon, Nov 07, 2016 at 07:55:24AM -0200, Mauro Carvalho Chehab wrote: >> 2) add an Sphinx extension that would internally call ImageMagick and/or >> inkscape to convert the bitmap; > > This seems sensible; Sphinx should

Re: [Ksummit-discuss] Including images on Sphinx documents

Am 07.11.2016 um 18:01 schrieb Josh Triplett : > On Mon, Nov 07, 2016 at 07:55:24AM -0200, Mauro Carvalho Chehab wrote: >> 2) add an Sphinx extension that would internally call ImageMagick and/or >> inkscape to convert the bitmap; > > This seems sensible; Sphinx should directly handle the

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

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 RFC 0/4] Fix PDF build errors

Am 02.11.2016 um 17:47 schrieb Mauro Carvalho Chehab : > Em Wed, 2 Nov 2016 17:08:08 +0100 > Markus Heiser escreveu: > >> Am 02.11.2016 um 12:14 schrieb Jani Nikula : >> >>> On Wed, 02 Nov 2016, Mauro Carvalho Chehab wrote: >>> >>>>

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

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: [PATCH RFC 0/4] Fix PDF build errors

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 conversion from a PNG >> image, because Sphinx is not

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

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 1/4] docs-rst: fix PDF build errors

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: > make PDFLATEX=xelatex

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

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 1/4] docs-rst: fix PDF build errors

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: > make PDFLATEX=xelatex

Re: make pdfdocs fails with v4.9-rc3

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: make pdfdocs fails with v4.9-rc3

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 >>> Jim Davis escreveu: > > I've no idea where's it's going astray,

Re: The downside of math::

Am 21.10.2016 um 23:38 schrieb Jonathan Corbet : > On Thu, 20 Oct 2016 17:55:21 +0300 > Jani Nikula wrote: > >> I wonder if we could cook up a nice way to make the math:: usage >> conditional on actually being able to render it. > > I think that's

Re: The downside of math::

Am 21.10.2016 um 23:38 schrieb Jonathan Corbet : > On Thu, 20 Oct 2016 17:55:21 +0300 > Jani Nikula wrote: > >> I wonder if we could cook up a nice way to make the math:: usage >> conditional on actually being able to render it. > > I think that's the ideal solution. > > I got the docs build

Re: The downside of math::

Am 20.10.2016 um 16:55 schrieb Jani Nikula : >> So, I really prefer not removing math support. > > I wonder if we could cook up a nice way to make the math:: usage > conditional on actually being able to render it. > > I would rather have the math:: directive

Re: The downside of math::

Am 20.10.2016 um 16:55 schrieb Jani Nikula : >> So, I really prefer not removing math support. > > I wonder if we could cook up a nice way to make the math:: usage > conditional on actually being able to render it. > > I would rather have the math:: directive produce just the preformatted >

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

Am 19.10.2016 um 01:25 schrieb Jonathan Corbet : > On Tue, 18 Oct 2016 08:20:18 -0200 > Mauro Carvalho Chehab wrote: > >>> While at it, how about unifying some of the FilenamesInCamelCase, >>> filenames-with-hyphens, and filenames_with_underscores

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

Am 19.10.2016 um 01:25 schrieb Jonathan Corbet : > On Tue, 18 Oct 2016 08:20:18 -0200 > Mauro Carvalho Chehab wrote: > >>> While at it, how about unifying some of the FilenamesInCamelCase, >>> filenames-with-hyphens, and filenames_with_underscores too...? To at >>> least move things towards

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

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

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

Am 19.10.2016 um 12:44 schrieb Jani Nikula : > Python module names should not have hyphens per [PEP 8]. Drop the hyphen > from kernel-doc.py. The extension directive remains unchanged. > > [PEP 8] https://www.python.org/dev/peps/pep-0008/#package-and-module-names > > Reported

Re: [PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl

Am 18.10.2016 um 17:59 schrieb Greg KH <g...@kroah.com>: > On Tue, Oct 18, 2016 at 05:52:58PM +0200, Markus Heiser wrote: >> The migration is done with the dbxml2rst project with small additional >> handmade. The uio-howto is chunked along its chapters into smal parts. &

Re: [PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl

Am 18.10.2016 um 17:59 schrieb Greg KH : > On Tue, Oct 18, 2016 at 05:52:58PM +0200, Markus Heiser wrote: >> The migration is done with the dbxml2rst project with small additional >> handmade. The uio-howto is chunked along its chapters into smal parts. > > "small&q

[PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl

Hi, this is the DocBook to reST migration of the uio-howto.tmpl as ordered by Stephen Hemminger [1]. The patch is on top of git://git.lwn.net/linux.git docs-next [1] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg06891.html Markus Heiser (1): doc-rst: DocBook to reST migration

[PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl

The migration is done with the dbxml2rst project with small additional handmade. The uio-howto is chunked along its chapters into smal parts. [1] https://return42.github.io/dbxml2rst/ Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/DocBook/Ma

[PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl

Hi, this is the DocBook to reST migration of the uio-howto.tmpl as ordered by Stephen Hemminger [1]. The patch is on top of git://git.lwn.net/linux.git docs-next [1] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg06891.html Markus Heiser (1): doc-rst: DocBook to reST migration

[PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl

The migration is done with the dbxml2rst project with small additional handmade. The uio-howto is chunked along its chapters into smal parts. [1] https://return42.github.io/dbxml2rst/ Signed-off-by: Markus Heiser --- Documentation/DocBook/Makefile |2 +- Documentation

Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic

Am 18.10.2016 um 15:59 schrieb Stephen Hemminger <step...@networkplumber.org>: > On Tue, 18 Oct 2016 13:01:20 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> Am 18.10.2016 um 12:54 schrieb Jani Nikula <jani.nik...@linux.intel.com>: >> >

Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic

Am 18.10.2016 um 15:59 schrieb Stephen Hemminger : > On Tue, 18 Oct 2016 13:01:20 +0200 > Markus Heiser wrote: > >> Am 18.10.2016 um 12:54 schrieb Jani Nikula : >> >>> On Mon, 17 Oct 2016, Stephen Hemminger wrote: >>>> From: Stephen Hemminger >

Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic

Am 18.10.2016 um 12:54 schrieb Jani Nikula : > On Mon, 17 Oct 2016, Stephen Hemminger wrote: >> From: Stephen Hemminger >> >> Update UIO documentation to include basic information about >> uio_hv_generic. > >

Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic

Am 18.10.2016 um 12:54 schrieb Jani Nikula : > On Mon, 17 Oct 2016, Stephen Hemminger wrote: >> From: Stephen Hemminger >> >> Update UIO documentation to include basic information about >> uio_hv_generic. > > How about converting to Sphinx/reStructuredText first...? It's not a big > file...

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

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: [PATCH 00/32] Create an User's manual and improve development-process book

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: > >> In my opinion, it would be better to

Re: kernel-doc-rst-lint (was: Re: [PATCH 00/15] improve function-level documentation)

Am 05.10.2016 um 16:04 schrieb Jani Nikula : > On Wed, 05 Oct 2016, Daniel Vetter wrote: >> Jani Nikula has a patch with a scrip to make the one kernel-doc parser >> into a lint/checker pass over the entire kernel. I think that'd would >> be more

Re: kernel-doc-rst-lint (was: Re: [PATCH 00/15] improve function-level documentation)

Am 05.10.2016 um 16:04 schrieb Jani Nikula : > On Wed, 05 Oct 2016, Daniel Vetter wrote: >> Jani Nikula has a patch with a scrip to make the one kernel-doc parser >> into a lint/checker pass over the entire kernel. I think that'd would >> be more robust instead of trying to approximate the real

Re: [RFC PATCH v3] docs-rst: user: add MAINTAINERS

Am 23.09.2016 um 17:35 schrieb Mauro Carvalho Chehab : > Em Fri, 23 Sep 2016 09:15:01 -0600 > Jonathan Corbet escreveu: >> I'm not sure I see the value of including it in >> the docs? What am I missing here? > > It is part of the REPORTING-BUGS

Re: [RFC PATCH v3] docs-rst: user: add MAINTAINERS

Am 23.09.2016 um 17:35 schrieb Mauro Carvalho Chehab : > Em Fri, 23 Sep 2016 09:15:01 -0600 > Jonathan Corbet escreveu: >> I'm not sure I see the value of including it in >> the docs? What am I missing here? > > It is part of the REPORTING-BUGS procedure to check MAINTAINERS and > find to

Re: pyc files in source dir with O=

Am 07.09.2016 um 15:28 schrieb Jani Nikula : > On Wed, 07 Sep 2016, Geert Uytterhoeven wrote: >> When running "make htmldocs O=/path/to/somewhere", *.pyc files end up >> in the source tree instead of in the build tree: >> >>$ git ls-files

Re: pyc files in source dir with O=

Am 07.09.2016 um 15:28 schrieb Jani Nikula : > On Wed, 07 Sep 2016, Geert Uytterhoeven wrote: >> When running "make htmldocs O=/path/to/somewhere", *.pyc files end up >> in the source tree instead of in the build tree: >> >>$ git ls-files -o >>Documentation/sphinx/kernel-doc.pyc >>

Re: [PATCH] docs: make kernel-doc handle varargs properly

Am 06.09.2016 um 15:36 schrieb Jonathan Corbet : > On Sat, 27 Aug 2016 11:43:18 +0300 > Jani Nikula wrote: > >> On Fri, 26 Aug 2016, Jonathan Corbet wrote: >>> As far as I can tell, the handling of "..." arguments has never worked >>>

Re: [PATCH] docs: make kernel-doc handle varargs properly

Am 06.09.2016 um 15:36 schrieb Jonathan Corbet : > On Sat, 27 Aug 2016 11:43:18 +0300 > Jani Nikula wrote: > >> On Fri, 26 Aug 2016, Jonathan Corbet wrote: >>> As far as I can tell, the handling of "..." arguments has never worked >>> right, so any documentation provided was ignored in favor

Re: [PATCH 0/3] RFC: The beginning of a proper driver-api book

Am 23.08.2016 um 16:43 schrieb Mauro Carvalho Chehab : > Em Mon, 22 Aug 2016 14:57:40 -0600 > Jonathan Corbet escreveu: > >> This short series convers device-drivers.tmpl into the RST format, splits >> it up, and sets up the result under

Re: [PATCH 0/3] RFC: The beginning of a proper driver-api book

Am 23.08.2016 um 16:43 schrieb Mauro Carvalho Chehab : > Em Mon, 22 Aug 2016 14:57:40 -0600 > Jonathan Corbet escreveu: > >> This short series convers device-drivers.tmpl into the RST format, splits >> it up, and sets up the result under Documentation/driver-api/. For added >> fun, I've taken

Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts

Am 23.08.2016 um 08:01 schrieb Daniel Vetter : > On Mon, Aug 22, 2016 at 12:49:30PM -0300, Mauro Carvalho Chehab wrote: >> Em Mon, 22 Aug 2016 20:41:45 +0530 >> Sumit Semwal escreveu: >> >>> Include dma-buf sphinx documentation into top level index.

Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts

Am 23.08.2016 um 08:01 schrieb Daniel Vetter : > On Mon, Aug 22, 2016 at 12:49:30PM -0300, Mauro Carvalho Chehab wrote: >> Em Mon, 22 Aug 2016 20:41:45 +0530 >> Sumit Semwal escreveu: >> >>> Include dma-buf sphinx documentation into top level index. >>> >>> Signed-off-by: Sumit Semwal >>>

Re: [RFC PATCH 0/3] Documentation: switch to pdflatex and fix pdf build

Am 13.08.2016 um 00:40 schrieb Jonathan Corbet : > On Wed, 10 Aug 2016 18:54:06 +0300 > Jani Nikula wrote: > >> With these you should be able to get started with pdf generation. It's a >> quick transition to pdflatex, the patches are not very pretty, but

Re: [RFC PATCH 0/3] Documentation: switch to pdflatex and fix pdf build

Am 13.08.2016 um 00:40 schrieb Jonathan Corbet : > On Wed, 10 Aug 2016 18:54:06 +0300 > Jani Nikula wrote: > >> With these you should be able to get started with pdf generation. It's a >> quick transition to pdflatex, the patches are not very pretty, but the >> pdf output is. Patch 3/3 works

Re: [RFC 3/4] Documentation: move dma-buf documentation to rst

Am 11.08.2016 um 13:58 schrieb Markus Heiser <markus.hei...@darmarit.de>: >> +.. note:: Until this stage, the buffer-exporter has the option to choose >> not to >> + actually allocate the backing storage for this buffer, but wait for the >> + first buffer

Re: [RFC 3/4] Documentation: move dma-buf documentation to rst

Am 11.08.2016 um 13:58 schrieb Markus Heiser : >> +.. note:: Until this stage, the buffer-exporter has the option to choose >> not to >> + actually allocate the backing storage for this buffer, but wait for the >> + first buffer-user to request use of buffer for alloc

Re: [RFC 3/4] Documentation: move dma-buf documentation to rst

Hi Sumit, I haven't compiled your patch yet, just my 2cent about the reStructuredText (reST) ASCII markup ... Here are some handy links about reST and the Sphinx markup constructs, we have not yet added to the documentation (sorry): * reST primer:

Re: [RFC 3/4] Documentation: move dma-buf documentation to rst

Hi Sumit, I haven't compiled your patch yet, just my 2cent about the reStructuredText (reST) ASCII markup ... Here are some handy links about reST and the Sphinx markup constructs, we have not yet added to the documentation (sorry): * reST primer:

Re: [RFC PATCH 3/3] Documentation: exclude media documentation from pdf generation

Am 10.08.2016 um 18:16 schrieb Mauro Carvalho Chehab : > Hi Jani, > > Em Wed, 10 Aug 2016 18:54:09 +0300 > Jani Nikula escreveu: > >> Although pdflatex is more robust than rst2pdf, building media >> documentation pdf still fails. Exclude media

Re: [RFC PATCH 3/3] Documentation: exclude media documentation from pdf generation

Am 10.08.2016 um 18:16 schrieb Mauro Carvalho Chehab : > Hi Jani, > > Em Wed, 10 Aug 2016 18:54:09 +0300 > Jani Nikula escreveu: > >> Although pdflatex is more robust than rst2pdf, building media >> documentation pdf still fails. Exclude media documentation from pdf >> generation for now. >

Re: [RFC PATCH 0/3] Documentation: switch to pdflatex and fix pdf build

example where to add your stuff > (latex_documents in conf.py) and how. > > Mauro, please look at patch 1/3 for a quick fix for the media build. > > Markus, you can now unleash your "I told you so" on the rst2pdf. ;) :) same here: Didn't test, but looking at th

Re: [RFC PATCH 0/3] Documentation: switch to pdflatex and fix pdf build

add your stuff > (latex_documents in conf.py) and how. > > Mauro, please look at patch 1/3 for a quick fix for the media build. > > Markus, you can now unleash your "I told you so" on the rst2pdf. ;) :) same here: Didn't test, but looking at the patch, it looks OK. Acked-by: Marku

Re: [RFC PATCH 2/3] Documentation: switch to pdflatex for pdf generation

Am 10.08.2016 um 17:54 schrieb Jani Nikula : > Looks like rst2pdf is not robust enough, especially for large documents. > > Use recursive make on the Sphinx generated makefile to convert latex to > pdf. The ugly detail is that pdf is generated into >

Re: [RFC PATCH 2/3] Documentation: switch to pdflatex for pdf generation

Am 10.08.2016 um 17:54 schrieb Jani Nikula : > Looks like rst2pdf is not robust enough, especially for large documents. > > Use recursive make on the Sphinx generated makefile to convert latex to > pdf. The ugly detail is that pdf is generated into > Documentation/output/latex. > >

Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings""

Am 09.08.2016 um 16:07 schrieb Jonathan Corbet : > On Tue, 9 Aug 2016 15:56:15 +0200 > Daniel Vetter wrote: > >>> So I honestly think we should just set the highlight language to "none" by >>> default. The syntax highlighting in code samples adds some

Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings""

Am 09.08.2016 um 16:07 schrieb Jonathan Corbet : > On Tue, 9 Aug 2016 15:56:15 +0200 > Daniel Vetter wrote: > >>> So I honestly think we should just set the highlight language to "none" by >>> default. The syntax highlighting in code samples adds some colorful sugar >>> to the docs, but it's

Re: [RFC PATCH 0/3] doc-rst: customize HTML (RTD) theme

Am 10.07.2016 um 12:06 schrieb Mauro Carvalho Chehab : > Em Sat, 9 Jul 2016 23:22:22 -0600 > Jonathan Corbet escreveu: > >> On Tue, 5 Jul 2016 14:55:09 -0300 >> Mauro Carvalho Chehab wrote: >> >>> I hope you don't mind. I'm

Re: [RFC PATCH 0/3] doc-rst: customize HTML (RTD) theme

Am 10.07.2016 um 12:06 schrieb Mauro Carvalho Chehab : > Em Sat, 9 Jul 2016 23:22:22 -0600 > Jonathan Corbet escreveu: > >> On Tue, 5 Jul 2016 14:55:09 -0300 >> Mauro Carvalho Chehab wrote: >> >>> I hope you don't mind. I'm merging those three patches on my tree >>> (for now, they're on an

[RFC PATCH 2/3] doc-rst: customize RTD theme, table & full width

From: Markus Heiser <markus.hei...@darmarit.de> To: Jonathan Corbet <cor...@lwn.net> To: Mauro Carvalho Chehab <mche...@osg.samsung.com> Cc: Hans Verkuil <hverk...@xs4all.nl> Cc: Daniel Vetter <daniel.vet...@ffwll.ch> Cc: Airlie <airl...@gmail.com> Cc: Likely &l

[RFC PATCH 2/3] doc-rst: customize RTD theme, table & full width

From: Markus Heiser To: Jonathan Corbet To: Mauro Carvalho Chehab Cc: Hans Verkuil Cc: Daniel Vetter Cc: Airlie Cc: Likely Cc: Dunlap Cc: Packard Cc: linux-...@vger.kernel.org Cc: linux-kernel@vger.kernel.org The default table layout of the RTD theme does not fit for vast tables, like

[RFC PATCH 1/3] doc-rst: boilerplate HTML theme customization

From: Markus Heiser <markus.hei...@darmarit.de> To: Jonathan Corbet <cor...@lwn.net> To: Mauro Carvalho Chehab <mche...@osg.samsung.com> Cc: Hans Verkuil <hverk...@xs4all.nl> Cc: Daniel Vetter <daniel.vet...@ffwll.ch> Cc: Airlie <airl...@gmail.com> Cc: Likely &l

<    1   2   3   4   >