d from any python script. If
you are unfamiliar with python packages consult [3] at least.
[1] https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
[2] https://docs.python.org/3/install/#inst-search-path
[3] https://docs.python.org/3/tutorial/modules.html#packages
Signed-off-by: Mar
urce 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
---
Documentation/books/kernel-doc-HOWTO.conf | 200 +
.../books/kernel-doc-HOWTO/all-in-a-tumble-src.rst | 12 +
.../books/
From: "Heiser, Markus"
The linuxdoc package includes python extensions related to the linux
documentation processes.
Signed-off-by: Markus Heiser
---
scripts/site-python/linuxdoc/__init__.py | 8
1 file changed, 8 insertions(+)
create mode 100644 scripts/site-pytho
ttp://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO/table-markup.html#flat-table
[2] http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table
[3] http://return42.github.io/sphkerneldoc
Signed-off-by: Markus Heiser
---
scripts/site-python/linuxdoc/rstFlatTable.py | 35
ned-off-by: Markus Heiser
---
scripts/site-python/linuxdoc/rstKernelDoc.py | 369 +++
1 file changed, 369 insertions(+)
create mode 100755 scripts/site-python/linuxdoc/rstKernelDoc.py
diff --git a/scripts/site-python/linuxdoc/rstKernelDoc.py
b/scripts/site-pytho
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 of the patch series (also onl
erneldoc
Signed-off-by: Markus Heiser
---
Documentation/.gitignore| 2 +
Documentation/Makefile.reST | 111
Documentation/books/.gitignore | 0
Documentation/conf.py | 357
oc-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 ...
> Am 18.04.2016 um 10:10 schrieb Markus Heiser :
Am 07.06.2016 um 09:54 schrieb Daniel Vetter :
> On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser
> wrote:
>> From: "Heiser, Markus"
>>
>> Hi Jonathan, Jani, all -
>>
>> I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2)
>&
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 and are annoying. We want to split it up, but tha
06.06.2016 um 18:32 schrieb Markus Heiser :
> 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 specificat
Am 07.06.2016 um 13:09 schrieb Jani Nikula :
> On Tue, 07 Jun 2016, Markus Heiser wrote:
>> Am 07.06.2016 um 10:59 schrieb Jani Nikula :
>>> One of the key arguments against too much splitting that hasn't been
>>> mentioned is that despite all the fine output
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 and 8 years reST
)
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
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...
>> + b/Documentation/books/kernel-doc-HOWTO/vintage-kern
Am 07.06.2016 um 08:44 schrieb Jani Nikula :
> On Tue, 07 Jun 2016, Markus Heiser wrote:
>> I looked closer to rst2pdf, it supports only the docutils reST, but
>> not the sphinx superset ...
>>
>> -
>> $ rst2pdf index.rst
>> index.rst:15:
FYI
Am 07.06.2016 um 09:54 schrieb Daniel Vetter :
> On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser
> wrote:
>> From: "Heiser, Markus"
>>
> I'm still not sold on the vintage-kerneldoc idea. At least in my
> experience (after first converting to asci
Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab :
> Em Tue, 31 May 2016 12:16:25 +0200
> Markus Heiser escreveu:
>
>> Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab
>> :
>>
>>> Em Mon, 30 May 2016 23:05:34 +0300
>>> Jani Nikula escr
Am 28.06.2016 um 21:05 schrieb Jani Nikula :
> On Tue, 28 Jun 2016, Markus Heiser wrote:
>> Hi Jonathan, hi Mauro,
>>
>> here is my DocBook to reST movement on top of Jon's docs-next branch. It
>> includes:
>>
>> * kernel-doc parser & directive
Am 27.06.2016 um 19:08 schrieb Mauro Carvalho Chehab :
> Em Mon, 27 Jun 2016 08:15:28 +0200
> Markus Heiser escreveu:
>
>> Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab
>> :
>>
>>> Em Tue, 31 May 2016 12:16:25 +0200
>>> Markus Heiser escre
Am 29.06.2016 um 15:15 schrieb Jani Nikula :
> On Wed, 29 Jun 2016, Markus Heiser wrote:
>> Am 28.06.2016 um 21:05 schrieb Jani Nikula :
>>> Perhaps you misunderstood, I don't know. When we ask you to rebase your
>>> work on something, in this case docs-next, it
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 like that will be
Hi Jonathan,
Am 29.06.2016 um 19:52 schrieb Jonathan Corbet :
> On Wed, 29 Jun 2016 19:35:46 +0200
> Markus Heiser wrote:
>
>>> I would love it if you would take the flat-table and man-page work,
>>> separate them out, and make them work with the *existing* Sphinx-ba
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 strategy. Jani says, that this better belong
Hi Jonathan,
this is my flat-table patch on top of your docs-next branch / we discussed on
the ML[1]
[1] http://mid.gmane.org/573d454c-2f55-4dd7-9c16-00b3897ae...@darmarit.de
Markus Heiser (1):
doc-rst: flat-table directive - initial implementation
Documentation/conf.py
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
---
Documentation/conf.py | 2 +-
Documentation/kernel-documentation.rst | 85
reST migration (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
Mer
Am 30.06.2016 um 21:05 schrieb Jonathan Corbet :
> On Thu, 30 Jun 2016 14:00:21 +0200
> Markus Heiser wrote:
>
>> this is my flat-table patch on top of your docs-next branch / we discussed on
>> the ML
>
> Hmm... we don't have an official kernel coding style
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 changes to the makefiles...
>
> I want to
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 *DocBook XML* on docs-next now? If yes,
> clearly th
Am 01.07.2016 um 13:56 schrieb Jani Nikula :
> On Fri, 01 Jul 2016, Markus Heiser wrote:
>> 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 regress
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;
>
> index = 0;
>
> if (-1 == i
emoved once we drop the DocBook
> build.
>
> Cc: Markus Heiser
> Cc: Mauro Carvalho Chehab
> Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx
> configuration and build")
> Signed-off-by: Jani Nikula
> ---
> Documentation/Makefile.sphin
Am 01.07.2016 um 15:09 schrieb Jani Nikula :
> On Fri, 01 Jul 2016, Markus Heiser wrote:
>> In Sphinx, the code-block directive is a literal block, no refs or markup
>> will be interpreted. This is different to what you know from DocBook.
>> I will look for a soluti
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
>> toolchain. To keep it all more uniform, t
From: Markus Heiser
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.
Since there is no (vast) table in Jon's docs
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-doc@vger.kernel.org
Cc: linux-ker...@vger.kernel.org
The layout of (table) captions in the RTD theme is a bit ugly and the
bordered
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-doc@vger.kernel.org
Cc: linux-ker...@vger.kernel.org
The default table layout of the RTD theme does not fit for vast tables,
like
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-doc@vger.kernel.org
Cc: linux-ker...@vger.kernel.org
Implements the minimal boilerplate for Sphinx HTML theme customization.
Signed
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 ex
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 here, remove the genindex con
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
Am 14.07.2016 um 16:19 schrieb Mauro Carvalho Chehab :
> Em Thu, 14 Jul 2016 13:45:00 +0200
> Markus Heiser escreveu:
>
>> Hi Jonathan, hi all,
>>
>> I want to contribute a modified version of my man-page builder,
>> but before we should elaborate what we ne
Am 14.07.2016 um 20:02 schrieb Mauro Carvalho Chehab :
> Em Thu, 14 Jul 2016 17:41:47 +0200
> Markus Heiser escreveu:
>
>> Am 14.07.2016 um 16:19 schrieb Mauro Carvalho Chehab
>> :
>
>>> If we're willing to document single drivers (I'm now talking
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.]
>>
>> On Sun, 17 Jul 2016 10:01:54 -0300
>> Maur
Am 19.07.2016 um 13:12 schrieb Mauro Carvalho Chehab :
> Em Tue, 19 Jul 2016 11:19:11 +0200
> Hans Verkuil escreveu:
>
>>> All those documents are built automatically, once by day, at linuxtv.org:
>>>
>>> uAPI:
>>> https://linuxtv.org/downloads/v4l-dvb-apis-new/media/media_uapi.html
>>
the source, e.g.
the drivers/gpu/drm/drm_crtc.c or the rst-file where the drm_crtc.c
is referred by a kernel-doc directive .. these dependence sometimes
confuse me .. when I missed log messages, I clean the cache e.g. by
target cleandocs.
-- Markus --
>
> Cc: Markus Heiser
> Cc:
Am 19.07.2016 um 16:53 schrieb Mauro Carvalho Chehab :
> Em Tue, 19 Jul 2016 14:31:18 +0200
> Markus Heiser escreveu:
>
>
>>> I really hate stupid toolchains that require everybody to upgrade to
>>> the very latest version of it every time.
>>
>>
Am 20.07.2016 um 00:58 schrieb Jonathan Corbet :
> On Tue, 19 Jul 2016 12:00:24 +0200
> Markus Heiser wrote:
>
>> I recommend to consider to switch to the python version of the parser.
>> I know, that there is a natural shyness about a reimplementation in python
>&g
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 asterisk inside the source code, for example, to
>>> document a pointer, or
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 the minimal requirement to 1.2.x.
>>
>> *sigh*.
>>
>> I hate to
From: Markus Heiser
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: Markus Heiser
---
Documentation
Hi Daniel, hi Mauro,
Am 19.07.2016 um 17:32 schrieb Daniel Vetter :
> On Tue, Jul 19, 2016 at 5:25 PM, Daniel Vetter wrote:
>> On Tue, Jul 19, 2016 at 4:59 PM, Markus Heiser
>> wrote:
>>>
>>> Am 19.07.2016 um 13:42 schrieb Daniel Vetter :
>>>
&
Am 20.07.2016 um 13:27 schrieb Daniel Vetter :
> On Wed, Jul 20, 2016 at 12:55 PM, Markus Heiser
> wrote:
>> Hi Daniel, hi Mauro,
>>
>> Am 19.07.2016 um 17:32 schrieb Daniel Vetter :
>>
>>> On Tue, Jul 19, 2016 at 5:25 PM, Daniel Vetter
>>
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.
>>
>
>> diff --git a/include/media/media-entity.h b/include/me
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.
> Documentation/kernel-docume
Am 20.07.2016 um 16:31 schrieb Jonathan Corbet :
> On Wed, 20 Jul 2016 16:23:28 +0200
> Markus Heiser wrote:
>
>> Am 20.07.2016 um 16:11 schrieb Mauro Carvalho Chehab
>> :
>>
>>> Sphinx 1.4.5 complains about some literal blocks at
>>> kernel-
Am 20.07.2016 um 17:06 schrieb Mauro Carvalho Chehab :
> Em Wed, 20 Jul 2016 16:49:59 +0200
> Markus Heiser escreveu:
>
>> Am 20.07.2016 um 16:31 schrieb Jonathan Corbet :
>>
>>> On Wed, 20 Jul 2016 16:23:28 +0200
>>> Markus Heiser wrote:
>>
gt;> 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
>>> Cc: Jonathan Corbet
>>> Cc: linux-doc@vger.kernel.org
>>> Signed-off-by: Daniel Vett
Am 21.07.2016 um 00:54 schrieb Jonathan Corbet :
> On Wed, 20 Jul 2016 12:38:58 +0200
> Markus Heiser wrote:
>
>> Add a reporter replacement that assigns the correct source name and line
>> number to a system message, as recorded in a ViewList.
>
> This is clearly
Am 21.07.2016 um 01:28 schrieb Jonathan Corbet :
> On Wed, 20 Jul 2016 08:07:54 +0200
> Markus Heiser wrote:
>
>> Jon, what do you think ... could we serve this 1.2 doc
>> on https://www.kernel.org/doc/ as reference?
>
> Seems like a good idea. I don'
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 use tabs instead of spaces,
Am 22.07.2016 um 11:46 schrieb Mauro Carvalho Chehab :
> Em Thu, 21 Jul 2016 17:17:26 +0200
> Markus Heiser escreveu:
>
>> Am 19.07.2016 um 19:18 schrieb Mauro Carvalho Chehab
>> :
>>
>>>> A bit OT, but I see that you often use tabs / I recomm
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 happen if the reference use
From: Markus Heiser
Remove the distracting (left/right) padding of inline literals. (HTML
). Requested and discussed in [1].
[1] http://www.spinics.net/lists/linux-media/msg103991.html
Signed-off-by: Markus Heiser
---
Documentation/sphinx-static/theme_overrides.css | 3 ++-
1 file changed, 2
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 sy, 0,0 ni, 0,0 id, 0,0 w
Am 05.08.2016 um 13:41 schrieb Mauro Carvalho Chehab :
> Em Fri, 5 Aug 2016 11:56:44 +0200
> Markus Heiser escreveu:
>
>> Am 20.07.2016 um 16:04 schrieb Mauro Carvalho Chehab
>> :
>>
>>>
>>> A completely unrelated question: it seems that Sphi
Am 05.08.2016 um 12:47 schrieb Mauro Carvalho Chehab :
> Em Fri, 5 Aug 2016 09:29:23 +0200
> Markus Heiser escreveu:
>
>> Am 01.08.2016 um 13:25 schrieb Mauro Carvalho Chehab
>> :
>>
>>> There's one remaining major issue I noticed after the co
From: Markus Heiser
Load an additional configuration file into conf.py namespace.
The name of the configuration file is taken from the environment
SPHINX_CONF. The external configuration file extends (or overwrites) the
configuration values from the origin conf.py. With this you are
able to
$(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 prepare a p
Am 07.08.2016 um 14:38 schrieb Mauro Carvalho Chehab :
> Em Sun, 7 Aug 2016 11:55:27 +0200
> Markus Heiser escreveu:
>
>>
>> Am 06.08.2016 um 14:00 schrieb Mauro Carvalho Chehab
>> :
>>
>>> Being able to build just the media docs is important for
From: Markus Heiser
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.info/?t=147051523900002
Markus Heis
From: Markus Heiser
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 indentation.
[1] https://www.python.org
From: Markus Heiser
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 conf.py file, matching
From: Markus Heiser
With the gpu/conf.py, the gpu folder can be build and distributed
stand-alone.
Signed-off-by: Markus Heiser
---
Documentation/gpu/conf.py | 3 +++
1 file changed, 3 insertions(+)
create mode 100644 Documentation/gpu/conf.py
diff --git a/Documentation/gpu/conf.py b
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 Documentation/media/Makefile... which I ha
Am 09.08.2016 um 20:02 schrieb Mauro Carvalho Chehab :
> Em Tue, 9 Aug 2016 09:21:08 -0600
> Jonathan Corbet escreveu:
>
>> On Mon, 8 Aug 2016 15:14:57 +0200
>> Markus Heiser wrote:
>>
>>> this is my approach for a more generic way to build only sphinx
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.
>
> Unfortunatel
Am 10.08.2016 um 11:22 schrieb Mauro Carvalho Chehab :
> Em Wed, 10 Aug 2016 12:15:34 +0300
> Jani Nikula escreveu:
>
>> On Mon, 08 Aug 2016, Markus Heiser wrote:
>>> Hi Jani,
>>>
>>> Am 08.08.2016 um 17:37 schrieb Jani Nikula :
>>>
&
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 investigate.
>>>
>>> I was unable to reproduce
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 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 the patch, it looks OK.
Acked
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
>>> b/drivers/gpu/drm/i915/intel_audio.c
>>> index d32f586f9c05..85389cdd0bec 100644
>>> --- a/drivers/gpu/drm
age = 'guess'
Thanks for your comments and sorry for bumping.
-- Markus --
Am 09.08.2016 um 16:11 schrieb Markus Heiser :
>
> Am 09.08.2016 um 16:07 schrieb Jonathan Corbet :
>
>> On Tue, 9 Aug 2016 15:56:15 +0200
>> Daniel Vetter wrote:
>>
>>>&
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:http://www.sphinx-doc.org/en/stable/rest.htm
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
From: Markus Heiser
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
---
Documentation/gpu/conf.py | 3 +++
1 file changed, 3 insert
From: Markus Heiser
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] http://docutils.sourceforge.net/docs
From: Markus Heiser
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 Documentation/conf.py is read
From: Markus Heiser
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 $(srctree)/Documentation/*/conf.py
can be
From: Markus Heiser
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 consolidation, it also in
From: Markus Heiser
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-header::
:exceptions:
:
From: Markus Heiser
With the media/conf.py, and media/index.rst the media folder can be
build and distributed stand-alone.
Signed-off-by: Markus Heiser
---
Documentation/index.rst | 7 +--
Documentation/media/conf.py | 3 +++
Documentation/media/index.rst | 12
3
Am 12.08.2016 um 23:20 schrieb Jonathan Corbet :
> On Mon, 8 Aug 2016 15:14:58 +0200
> Markus Heiser wrote:
>
>> Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a
>> more generic way to build only a reST sub-folder.
>>
>
>
Am 12.08.2016 um 22:02 schrieb Jonathan Corbet :
> On Thu, 11 Aug 2016 12:02:31 +0200
> Markus Heiser wrote:
>
>> It's about the default highlight language in the conf.py. I suggested
>> to set it to the value 'guess', since this might solve most of our
&
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 as
Am 14.08.2016 um 20:09 schrieb Jonathan Corbet :
> On Sat, 13 Aug 2016 16:12:41 +0200
> Markus Heiser wrote:
>
>> this series is a consolidation on Jon's docs-next branch. It merges the
>> "sphinx
>> sub-folders" patch [1] and the "parseheade
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 the function has no return
From: Markus Heiser
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 make use of the cpp:domain, there
is no
From: Markus Heiser
Add a sphinx-extension to customize the sphinx c-domain. No functional
changes right yet, just the boilerplate code.
Signed-off-by: Markus Heiser
---
Documentation/conf.py | 2 +-
Documentation/sphinx/cdomain.py | 44 +
2
301 - 400 of 447 matches
Mail list logo
