Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx)

xdepth: 1 kernel-doc-intro kernel-doc-syntax - rules like ":ref:", domains like ":c:type:" and directives like ".. toctree:" are a part of the (extended) reST syntax from sphinx, thats why standard docutils (like rst2*) will not work ... >

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 09:54 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser <markus.hei...@darmarit.de> > wrote: >> From: "Heiser, Markus" <markus.hei...@darmarit.de> >> >> Hi Jonathan, Jani, all

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 10:59 schrieb Jani Nikula : > On Tue, 07 Jun 2016, Daniel Vetter wrote: >> I think getting the flat-table directive landed would be great. We >> have a similarly annoying table in gpu.tmpl where the ascii-art tables >> fall short

[PATCH 6/7] kernel-doc directive: initial implementation

turn42.github.io/sphkerneldoc Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/linuxdoc/rstKernelDoc.py | 369 +++ 1 file changed, 369 insertions(+) create mode 100755 scripts/site-python/linuxdoc/rstKernelDoc.py diff --git a/script

[PATCH 0/7] add reST/sphinx-doc to linux documentation

From: "Heiser, Markus" Hi Jonathan, Jani, all - I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2) git://github.com/return42/linux.git linux-doc-reST The specification of the implementation is the (new) kernel-doc-HOWTO book which is a part

[PATCH 2/7] sphinx-doc: add basic sphinx-build infrastructure

turn42.github.io/sphkerneldoc Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/.gitignore| 2 + Documentation/Makefile.reST | 111 Documentation/books/.gitignore | 0

[PATCH 1/7] python: add scripts/site-packages

ages Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/.gitignore | 1 + scripts/site-python/README | 14 ++ 2 files changed, 15 insertions(+) create mode 100644 scripts/site-python/.gitignore create mode 100644 scripts/site-python/README

[PATCH 3/7] kernel-doc-HOWTO: add kernel-doc specification

efer and extract documentation from source files. A online kernel-doc-HOWTO is available at [1] [1] http://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/books/kernel-doc-HOWTO.conf | 200 + .../

[PATCH 4/7] linuxdoc: add python package linuxdoc

From: "Heiser, Markus" <markus.hei...@darmarit.de> The linuxdoc package includes python extensions related to the linux documentation processes. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/linuxdoc/__init__.py | 8 1 file

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

06.06.2016 um 18:32 schrieb Markus Heiser <markus.hei...@darmarit.de>: > From: "Heiser, Markus" <markus.hei...@darmarit.de> > > Hi Jonathan, Jani, all - > > I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2) > >git://g

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 13:09 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 07 Jun 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 07.06.2016 um 10:59 schrieb Jani Nikula <jani.nik...@intel.com>: >>> One of the key arguments against

[GIT PULL] add reST/sphinx-doc to linux documentation

) Markus Heiser (20): python: add scripts/site-packages sphinx-doc: add basic sphinx-build infrastructure kernel-doc-HOWTO: add kernel-doc specification linuxdoc: add python package linuxdoc kernel-doc parser: inital python

Re: [PATCH 3/7] kernel-doc-HOWTO: add kernel-doc specification

Hi Randy, thanks for your amendments / has been fixed [1] [1] https://github.com/return42/linux/commit/98a9fc42cbd0c23b266ac28494dafe20d7920d05 Am 09.06.2016 um 20:05 schrieb Randy Dunlap : > Hi, > > Some spellos and a few questions... >> +

Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension

Am 03.06.2016 um 22:35 schrieb Jonathan Corbet : > On Fri, 20 May 2016 16:39:36 +0300 > Jani Nikula wrote: > >> Add an extension to handle kernel-doc directives, to call kernel-doc >> according to the arguments and parameters given to the reStructuredText

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 08.06.2016 um 21:49 schrieb Jonathan Corbet : > So I've finally gotten a chance to make another pass over this stuff. > > Markus, your enthusiasm is great; I'm hoping you'll do great things > helping us to improve the kernel's documentation toolchain. With 7 years DocBook

Re: [PATCH 00/10] Documentation/Sphinx

Hi, sorry for my temporary absence, I have been on holiday the last weeks :-) Am 30.05.2016 um 11:10 schrieb Daniel Vetter : > On Sun, May 29, 2016 at 10:33 PM, Jani Nikula wrote: >> On Fri, 20 May 2016, Jani Nikula wrote:

Re: [PATCH 00/10] Documentation/Sphinx

Am 31.05.2016 um 10:07 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Tue, May 31, 2016 at 9:27 AM, Markus Heiser > <markus.hei...@darmarit.de> wrote: >>>>> I find it totally unacceptable to require explicitly marking kernel-doc >>>>> co

Re: [PATCH 00/10] Documentation/Sphinx

Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab : > Em Mon, 30 May 2016 23:05:34 +0300 > Jani Nikula escreveu: > >>> I worry a little bit in that reST will be only one more toolchain >>> beside DocBook .. in the long term, kernel's

Re: [PATCH 00/10] Documentation/Sphinx

Am 31.05.2016 um 12:30 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 31 May 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 31.05.2016 um 10:07 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: >>> 0-day builds all docs, and chec

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

FYI Am 07.06.2016 um 09:54 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser <markus.hei...@darmarit.de> > wrote: >> From: "Heiser, Markus" <markus.hei...@darmarit.de> >> > I'm still not s

Re: [PATCH 00/10] Documentation/Sphinx

Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Tue, 31 May 2016 12:16:25 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab >> <mche...@osg.samsung.com

Re: Kernel docs: muddying the waters a bit

://return42.github.io/sphkerneldoc/ The sources available at: https://github.com/return42/sphkerneldoc The work is underway, suggestions are welcome! .. have a nice weekend .. --M-- Am 13.03.2016 um 16:33 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > Am 10.03.2016 um 16:21 s

Re: Kernel docs: muddying the waters a bit

Hi all, hi Jonathan, Am 06.05.2016 um 15:42 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Fri, 6 May 2016 15:32:35 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Hi Mauro, >> >> Am 06.05.2016 um 13:35 schrieb Mauro Carva

Re: Kernel docs: muddying the waters a bit

Am 04.05.2016 um 15:43 schrieb Daniel Vetter <dan...@ffwll.ch>: > On Wed, May 04, 2016 at 02:40:29PM +0200, Markus Heiser wrote: >>> On Wed, 04 May 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >>> I'd be *very* hesitant about adding the kind of things

Re: Kernel docs: muddying the waters a bit

Hy Jani, Am 04.05.2016 um 18:13 schrieb Jani Nikula : >> Am 04.05.2016 um 17:09 schrieb Jonathan Corbet : >> >>> I think all of this makes sense. It would be really nice to have the >>> directives in the native sphinx language like that. I *don't* think

Re: Kernel docs: muddying the waters a bit

comments twice. -- Markus-- Am 06.05.2016 um 13:23 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > Hy Jani, > > Am 04.05.2016 um 18:13 schrieb Jani Nikula <jani.nik...@intel.com>: > >>> Am 04.05.2016 um 17:09 schrieb Jonathan Corbet <

Re: Kernel docs: muddying the waters a bit

Hi Mauro, Am 04.05.2016 um 18:15 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Wed, 4 May 2016 11:34:08 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Hi all, (hi Jonathan, please take note of my offer below) >> >> Am 03

Re: Kernel docs: muddying the waters a bit

Hi Jonahtan, Am 12.04.2016 um 17:46 schrieb Jonathan Corbet <cor...@lwn.net>: > On Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> motivated by this MT, I implemented a toolchain to migrate the kernel’s >> DocBook

Re: Kernel docs: muddying the waters a bit

Hi Mauro, hi kernel-doc authors, Am 12.04.2016 um 15:58 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Fri, 8 Apr 2016 17:12:27 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Hi kernel-doc authors, >> >> motivate

[RFC] Requirements for man page generation

Hi Jonathan, hi all, I want to contribute a modified version of my man-page builder, but before we should elaborate what we need in more detail. We have two use-cases from which we want to create man page. * create man-pages from kernel-doc comments and * create man-pages from "handwritten" reST

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

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

[PATCH 6/7] doc-rst: parseheaders directive (inital)

From: Markus Heiser <markus.hei...@darmarit.de> The parse-header directive includes contend from Linux kernel header files. The python-side of this feature is only an adapter of the ``parse-headers.pl`` Perl script. Overview of directive's argument and options. .. parse-

[PATCH 2/7] doc-rst: add stand-alone conf.py to media folder

From: Markus Heiser <markus.hei...@darmarit.de> With the media/conf.py, and media/index.rst the media folder can be build and distributed stand-alone. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/index.rst | 7 +-- Documentation/media/co

[PATCH 0/7] doc-rst: sphinx sub-folders & parseheaders directive

From: Markus Heiser <markus.hei...@darmarit.de> Hi Jon, Mauro, and Jani, this series is a consolidation on Jon's docs-next branch. It merges the "sphinx sub-folders" patch [1] and the "parseheaders directive" patch [2] on top of Jon's docs-next. In sense of conso

Re: [PATCH 1/3] doc-rst: generic way to build only sphinx sub-folders

Am 12.08.2016 um 23:20 schrieb Jonathan Corbet <cor...@lwn.net>: > On Mon, 8 Aug 2016 15:14:58 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a >> more generic way to build on

[PATCH 5/7] doc-rst: add docutils config file

From: Markus Heiser <markus.hei...@darmarit.de> To stop the sphinx-build on severe errors and exit with an exit code (to stop make) the halt_level must be set. The halt_level can't be set from sphinx, it is a docutils configuration [1]. For this a docutils.conf was added. [1

[PATCH 3/7] doc-rst: add media/conf_nitpick.py

From: Markus Heiser <markus.hei...@darmarit.de> The media/conf_nitpick.py is a *build-theme* wich uses the nit-picking mode of sphinx. To compile only the html of 'media' with the nit-picking build use:: make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs With this, the Documen

[PATCH 1/7] doc-rst: generic way to build only sphinx sub-folders

From: Markus Heiser <markus.hei...@darmarit.de> Add a generic way to build only a reST sub-folder with or without a individual *build-theme*. * control *sub-folders* by environment SPHINXDIRS * control *build-theme* by environment SPHINX_CONF Folders with a conf.py file, matching $(s

[PATCH 4/7] doc-rst: add stand-alone conf.py to gpu folder

From: Markus Heiser <markus.hei...@darmarit.de> With the gpu/conf.py, the gpu folder can be build and distributed stand-alone. To compile only the html of 'gpu' folder use:: make SPHINXDIRS="gpu" htmldocs Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Doc

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

Am 12.08.2016 um 22:02 schrieb Jonathan Corbet <cor...@lwn.net>: > On Thu, 11 Aug 2016 12:02:31 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> It's about the default highlight language in the conf.py. I suggested >> to set it to the value 'gu

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: parts of media docs sphinx re-building every time?

Am 10.08.2016 um 15:46 schrieb Jonathan Corbet : > On Wed, 10 Aug 2016 12:23:16 +0300 > Jani Nikula wrote: > I just noticed running 'make htmldocs' rebuilds parts of media docs every time on repeated runs. This shouldn't happen. Please

Re: [PATCH 01/20] drm/doc: Fix more kerneldoc/sphinx warnings

Am 11.08.2016 um 10:23 schrieb Jani Nikula : > On Thu, 11 Aug 2016, Jani Nikula wrote: >> On Tue, 09 Aug 2016, Daniel Vetter wrote: >>> diff --git a/drivers/gpu/drm/i915/intel_audio.c >>>

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

s' Thanks for your comments and sorry for bumping. -- Markus -- Am 09.08.2016 um 16:11 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > Am 09.08.2016 um 16:07 schrieb Jonathan Corbet <cor...@lwn.net>: > >> On Tue, 9 Aug 2016 15:56:15 +0200 >> Daniel Vetter &l

Re: [PATCH 2/2] [media] doc-rst: increase depth of the main index

Hi Mauro, Am 13.07.2016 um 15:52 schrieb Mauro Carvalho Chehab : > It is useful to have an index with all the book contents somewhere, > as it makes easier to seek for something. So, increase maxdepth > to 5 for the main index at the beginning of the book. > > While

Re: [PATCH 00/18] Complete moving media documentation to ReST format

Am 21.07.2016 um 01:28 schrieb Jonathan Corbet <cor...@lwn.net>: > On Wed, 20 Jul 2016 08:07:54 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> Jon, what do you think ... could we serve this 1.2 doc >> on https://www.kernel.org/doc/ as reference

Re: [PATCH 2/2] drm/doc: Fix more kerneldoc/sphinx warnings

tovers I could only track down using keep_warnings = >>> True. For some of them we might want to update our style guide on how >>> to reference structures and constants, not sure ... >>> >>> Cc: Markus Heiser <markus.hei...@darmarit.de> >>> Cc: Jonat

Re: [PATCH] doc-rst: kernel-doc directive, fix state machine reporter

Am 21.07.2016 um 00:54 schrieb Jonathan Corbet <cor...@lwn.net>: > On Wed, 20 Jul 2016 12:38:58 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> Add a reporter replacement that assigns the correct source name and line >> number to a system m

Re: [PATCH 00/18] Complete moving media documentation to ReST format

Am 19.07.2016 um 19:18 schrieb Mauro Carvalho Chehab : >> A bit OT, but I see that you often use tabs / I recommend to use >> spaces for indentation: >> >> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#whitespace > > The Kernel policies are to

Re: Troubles with kernel-doc and RST files

Am 18.07.2016 um 13:54 schrieb Mauro Carvalho Chehab : > Em Sun, 17 Jul 2016 20:37:19 -0600 > Jonathan Corbet escreveu: > >> [Back home and trying to get going on stuff for real. I'll look at the >> issues listed in this message one at a time.] >> >>

[PATCH] doc-rst: kernel-doc directive, fix state machine reporter

From: Markus Heiser <markus.hei...@darmarit.de> Add a reporter replacement that assigns the correct source name and line number to a system message, as recorded in a ViewList. [1] http://mid.gmane.org/cakmk7ufmq2wop99t-8v06om78mi9ovrzwuqsfjd55qa20bb...@mail.gmail.com Signed-off-by:

Re: [PATCH 1/2] doc/sphinx: Enable keep_warnings

Hi Daniel, hi Mauro, Am 19.07.2016 um 17:32 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Tue, Jul 19, 2016 at 5:25 PM, Daniel Vetter <daniel.vet...@ffwll.ch> wrote: >> On Tue, Jul 19, 2016 at 4:59 PM, Markus Heiser >> <markus.hei...@darmarit.de> wrote

Re: Troubles with kernel-doc and RST files

Am 20.07.2016 um 02:09 schrieb Mauro Carvalho Chehab : > Em Tue, 19 Jul 2016 17:16:35 -0600 > Jonathan Corbet escreveu: > >> On Sun, 17 Jul 2016 10:01:54 -0300 >> Mauro Carvalho Chehab wrote: >> >>> 3) When there's an

Re: [PATCH] doc-rst: get rid of warnings at kernel-documentation.rst

Am 20.07.2016 um 16:11 schrieb Mauro Carvalho Chehab : > Sphinx 1.4.5 complains about some literal blocks at > kernel-documentation.rst: > > Documentation/kernel-documentation.rst:373: WARNING: Could not lex > literal_block as "C". Highlighting skipped. >

Re: [PATCH 00/18] Complete moving media documentation to ReST format

Am 20.07.2016 um 02:00 schrieb Mauro Carvalho Chehab : > Em Tue, 19 Jul 2016 16:49:16 -0600 > Jonathan Corbet escreveu: > >> On Tue, 19 Jul 2016 11:53:19 -0300 >> Mauro Carvalho Chehab wrote: >> >>> So, I guess we should set

Re: [PATCH] [media] doc-rst: Fix some Sphinx warnings

Am 20.07.2016 um 15:00 schrieb Mauro Carvalho Chehab : > Em Wed, 20 Jul 2016 09:32:15 -0300 > Mauro Carvalho Chehab escreveu: > >> Fix all remaining media warnings with ReST that are fixable >> without changing at the Sphinx code. >> > >>

Re: [PATCH 1/2] doc/sphinx: Enable keep_warnings

Am 20.07.2016 um 13:27 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Wed, Jul 20, 2016 at 12:55 PM, Markus Heiser > <markus.hei...@darmarit.de> wrote: >> Hi Daniel, hi Mauro, >> >> Am 19.07.2016 um 17:32 schrieb Daniel Vetter <daniel.vet...@ffwll.ch

Re: [PATCH] doc-rst: get rid of warnings at kernel-documentation.rst

Am 20.07.2016 um 16:31 schrieb Jonathan Corbet <cor...@lwn.net>: > On Wed, 20 Jul 2016 16:23:28 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> Am 20.07.2016 um 16:11 schrieb Mauro Carvalho Chehab >> <mche...@s-opensource.com>: >>

Re: [PATCH] doc-rst: get rid of warnings at kernel-documentation.rst

Am 20.07.2016 um 17:06 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Wed, 20 Jul 2016 16:49:59 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 20.07.2016 um 16:31 schrieb Jonathan Corbet <cor...@lwn.net>: >> >>&g

Re: [RFC] Requirements for man page generation

Am 14.07.2016 um 20:02 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Thu, 14 Jul 2016 17:41:47 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 14.07.2016 um 16:19 schrieb Mauro Carvalho Chehab >> <mche...@osg.samsung.com&g

Re: Functions and data structure cross references with Sphinx

Am 01.08.2016 um 13:25 schrieb Mauro Carvalho Chehab : > There's one remaining major issue I noticed after the conversion of the > media books to Sphinx: > > While sphinx complains if a cross-reference (using :ref:) points to an > undefined reference, the same doesn't

Sphinx-doc: build over N processes in parallel

Am 20.07.2016 um 16:04 schrieb Mauro Carvalho Chehab : > > A completely unrelated question: it seems that Sphinx is using just > one CPU to do its builds: > > %Cpu0 : 3,0 us, 7,6 sy, 0,0 ni, 89,4 id, 0,0 wa, 0,0 hi, 0,0 si, 0,0 > st > %Cpu1 :100,0 us, 0,0

Re: Sphinx-doc: build over N processes in parallel

Am 05.08.2016 um 13:41 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Fri, 5 Aug 2016 11:56:44 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 20.07.2016 um 16:04 schrieb Mauro Carvalho Chehab >> <mche...@s-openso

Re: Functions and data structure cross references with Sphinx

Am 05.08.2016 um 12:47 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Fri, 5 Aug 2016 09:29:23 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 01.08.2016 um 13:25 schrieb Mauro Carvalho Chehab >> <mche...@s-opensource

Re: parts of media docs sphinx re-building every time?

Hi Jani, Am 08.08.2016 um 17:37 schrieb Jani Nikula : > > Hi Mauro & co - > > I just noticed running 'make htmldocs' rebuilds parts of media docs > every time on repeated runs. This shouldn't happen. Please investigate. > > I wonder if it's related to

Re: [PATCH 0/3] Add a way to build only media docs

check% coccicheck \ $(version_h) headers_% archheaders archscripts \ kernelversion %src-pkg +# more fine grained documentation targets +books/%: + $(Q)$(MAKE) $(build)=Documentation -f Documentation/Makefile.reST $@ + If you are interested in, I pre

[PATCH 2/3] doc-rst: add stand-alone conf.py to media folder

From: Markus Heiser <markus.hei...@darmarit.de> With the media/conf.py, the media folder can be build and distributed stand-alone. BTW fixed python indentation in media/conf_nitpick.py. Python indentation is 4 spaces [1] and Python 3 disallows mixing the use of tabs and spaces for inden

[PATCH 1/3] doc-rst: generic way to build only sphinx sub-folders

From: Markus Heiser <markus.hei...@darmarit.de> Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a more generic way to build only a reST sub-folder. * control *sub-folders* by environment SPHINXDIRS * control *build-theme* by environment SPHINX_CONF Folders with a c

[PATCH 3/3] doc-rst: add stand-alone conf.py to gpu folder

From: Markus Heiser <markus.hei...@darmarit.de> With the gpu/conf.py, the gpu folder can be build and distributed stand-alone. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/gpu/conf.py | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 Docum

[PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

From: Markus Heiser <markus.hei...@darmarit.de> Hi Mauro, this is my approach for a more generic way to build only sphinx sub-folders, we discussed in [1]. The last patch adds a minimal conf.py to the gpu folder, if you don't want to patch the gpu folder drop it. [1] http://marc.i

Re: [PATCH 0/3] Add a way to build only media docs

Am 07.08.2016 um 14:38 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Sun, 7 Aug 2016 11:55:27 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> >> Am 06.08.2016 um 14:00 schrieb Mauro Carvalho Chehab >> <mche...@s-op

Re: [PATCH 00/18] Complete moving media documentation to ReST format

Am 22.07.2016 um 11:46 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Thu, 21 Jul 2016 17:17:26 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 19.07.2016 um 19:18 schrieb Mauro Carvalho Chehab >> <mche...@s-opensourc

Re: [PATCH 0/3] doc-rst: more generic way to build only sphinx sub-folders

Am 09.08.2016 um 20:02 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Tue, 9 Aug 2016 09:21:08 -0600 > Jonathan Corbet <cor...@lwn.net> escreveu: > >> On Mon, 8 Aug 2016 15:14:57 +0200 >> Markus Heiser <markus.hei...@darmarit.de> wrote:

[PATCH] doc-rst: flat-table directive - initial implementation

implementation was taken from the sphkerneldoc project [1] [1] https://github.com/return42/sphkerneldoc/commits/master/scripts/site-python/linuxdoc/rstFlatTable.py Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/conf.py | 2 +- Documentation/

[GIT PULL] doc: linux_tv DocBook to reST migration (docs-next)

tion (docs-next) (2016-06-30 15:18:56 +0200) Jani Nikula (1): Documentation: add meta-documentation for Sphinx and kernel-doc Markus Heiser (3): doc-rst: flat-table directive - initial implementation Merge branch

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 29.06.2016 um 22:57 schrieb Mauro Carvalho Chehab : > Em Wed, 29 Jun 2016 11:52:09 -0600 > Jonathan Corbet escreveu: > >>> 2. What is the best way to ship these migrations >>> >>> or better I asked, what is your recommendation for a >>> migration

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Hi Jonathan, Am 29.06.2016 um 19:52 schrieb Jonathan Corbet <cor...@lwn.net>: > On Wed, 29 Jun 2016 19:35:46 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >>> I would love it if you would take the flat-table and man-page work, >>>

Re: [PATCH] doc: flat-table directive

Am 30.06.2016 um 21:44 schrieb Mauro Carvalho Chehab : > Em Thu, 30 Jun 2016 13:05:11 -0600 > Jonathan Corbet escreveu: > >> Anyway, I don't want to delay this work, so I have gone ahead and applied >> it; > > Got already one issue... Maybe on Jeni's

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 12:44 schrieb Jani Nikula : > On Fri, 01 Jul 2016, Mauro Carvalho Chehab wrote: >> Not being able to compile just one docbook is a regression and breaks >> my process. This needs to be fixed. > > Do you have a regression with

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 13:56 schrieb Jani Nikula <jani.nik...@intel.com>: > On Fri, 01 Jul 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 01.07.2016 um 12:44 schrieb Jani Nikula <jani.nik...@intel.com>: >> >>> On Fri, 01 Jul 2016, Mauro Carva

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 11:38 schrieb Mauro Carvalho Chehab : > Btw, yesterday, I tried to add references to a C code, at video.rst, > just like we did with DocBook: > > .. code-block:: c > :caption: Example 2: Switching to the first video input > > int index; > >

Re: [PATCH] doc: flat-table directive

Am 30.06.2016 um 21:05 schrieb Jonathan Corbet <cor...@lwn.net>: > On Thu, 30 Jun 2016 14:00:21 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> this is my flat-table patch on top of your docs-next branch / we discussed on >> the ML > > H

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 15:09 schrieb Jani Nikula <jani.nik...@intel.com>: > On Fri, 01 Jul 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> In Sphinx, the code-block directive is a literal block, no refs or markup >> will be interpreted. This is different to what

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 14:58 schrieb Jonathan Corbet : > On Fri, 01 Jul 2016 13:44:17 +0300 > Jani Nikula wrote: > >> This is also one of the reasons why I so much want to keep everything >> behind one configuration file, and build everything in the Sphinx >>

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

From: Markus Heiser <markus.hei...@darmarit.de> The default layout of the RTD HTML theme has some tweaks, discussed in the linux-doc ML [1][2]. This series adds a boilerplate to customize HTML themes and it fix the tweaks (mainly) for tables, captions and inline literals.

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

Re: [PATCH 00/10] Documentation/Sphinx

Am 27.06.2016 um 19:08 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Mon, 27 Jun 2016 08:15:28 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab >> <mche...@osg.samsung.com

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 29.06.2016 um 15:15 schrieb Jani Nikula <jani.nik...@intel.com>: > On Wed, 29 Jun 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 28.06.2016 um 21:05 schrieb Jani Nikula <jani.nik...@intel.com>: >>> Perhaps you misunderstood, I don't know. Whe

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Hi Jonathan, Am 29.06.2016 um 18:24 schrieb Jonathan Corbet : > Hi, Markus, > > I was glad to hear from you, but I have to agree with Jani: this is not > how things are done. Consider this one line: > >> 706 files changed, 123369 insertions(+), 752 deletions(-) > > Something

Re: [PATCH] doc-rst: kernel-doc: fix handling of address_space tags

Am 22.07.2016 um 16:46 schrieb Mauro Carvalho Chehab : > The RST cpp:function handler is very pedantic: it doesn't allow any > macros like __user on it: > > Documentation/media/kapi/dtv-core.rst:28: WARNING: Error when parsing > function declaration. > If

[PATCH 5/5] doc-rst: migrate ioctl CEC_DQEVENT to c-domain

From: Markus Heiser <markus.hei...@darmarit.de> This is only one example, demonstrating the benefits of the patch series. The CEC_DQEVENT ioctl is migrated to the sphinx c-domain and referred by ":name: CEC_DQEVENT". With this change the indirection using ":ref:`CEC_DQEVENT

[RFC PATCH 0/5] doc-rst: improvements Sphinx's C-domain

From: Markus Heiser <markus.hei...@darmarit.de> Hi, this is my approach to eliminate some distortions we have with the c/cpp Sphinx domains. The C domain is simple: it assumes that all functions, enums, etc are global, e. g. there should be just one function called "ioctl

[PATCH 4/5] doc-rst: Revert "kernel-doc: fix handling of address_space tags"

From: Markus Heiser <markus.hei...@darmarit.de> This reverts commit a88b1672d4ddf9895eb53e6980926d5e960dea8e. >From the origin comit log:: The RST cpp:function handler is very pedantic: it doesn't allow any macros like __user on it Since the kernel-doc parser does NOT

[PATCH 1/5] doc-rst: add boilerplate to customize c-domain

From: Markus Heiser <markus.hei...@darmarit.de> Add a sphinx-extension to customize the sphinx c-domain. No functional changes right yet, just the boilerplate code. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/conf.py | 2 +- Document

[PATCH 2/5] doc-rst:c-domain: ref-name of a function declaration

From: Markus Heiser <markus.hei...@darmarit.de> Add option 'name' to the "c:function:" directive. With option 'name' the ref-name of a function can be modified. E.g.:: .. c:function:: int ioctl( int fd, int request ) :name: VIDIOC_LOG_STATUS The func-name (e.g

  1   2   3   4   >