Am 30.03.21 um 13:35 schrieb Jani Nikula:
If the introduction were "/*rST" instead of "/**", would we have
consensus? It gives us a path to let people intermix kernel-doc and
hawkmoth comments in the same file, which would be amazing.
If you want to allow two syntaxes for documentation comm
Am 09.03.21 um 13:53 schrieb Aditya Srivastava:
Starting commented lines in a file mostly contains comments describing
license, copyright or general information about the file.
E.g., in sound/pci/ctxfi/ctresource.c, initial comment lines describe
its copyright and other related file informatio
Am 31.08.20 um 21:03 schrieb Jonathan Corbet:
On Thu, 27 Aug 2020 14:50:17 +1000
Stephen Rothwell wrote:
Today I upgraded ot sphinx v3.2.1 and got the following error from
"make htmldocs":
Running Sphinx v3.2.1
enabling CJK for LaTeX builder
Extension error:
Could not import extension cdomai
Am 12.08.20 um 10:21 schrieb Markus Heiser:
Am 12.08.20 um 09:30 schrieb Salvatore Bonaccorso:
[..]
The problem is actually related to changes happening in Sphinx 3.0.0.
There is the followign issue filled upstream:
https://github.com/sphinx-doc/sphinx/issues/7421
'c_funcptr_sig_re
Am 12.08.20 um 09:30 schrieb Salvatore Bonaccorso:
[..]
The problem is actually related to changes happening in Sphinx 3.0.0.
There is the followign issue filled upstream:
https://github.com/sphinx-doc/sphinx/issues/7421
'c_funcptr_sig_re' was removed upstream in sphinx v3.0.0b1 and so the
ke
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/
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
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
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.
Am 26.10.18 um 11:26 schrieb Peter Zijlstra:
>> Jon,
>>
>> So the below document is a prime example for why I think RST sucks. As a
>> text document readability is greatly diminished by all the markup
>> nonsense.
>>
>> This stuff should not become write-only content like html and other
>> gunk. T
> Am 10.05.2018 um 18:42 schrieb Mauro Carvalho Chehab
> :
>
> Em Thu, 10 May 2018 09:38:46 -0600
> Jonathan Corbet escreveu:
>
>> On Thu, 10 May 2018 11:21:13 -0300
>> Mauro Carvalho Chehab wrote:
>>
>>> The problem with a hint-based mechanism is that it will generate
>>> false hints. If ad
> Am 09.05.2018 um 20:35 schrieb Jonathan Corbet :
>
>> Why should I care for people not using text editors to write code?
Eh? .. why must readers write code?
We have rules how to write kernel-doc markup since the beginning of the century.
If you do not want to contribute kernel-doc markups, th
> Am 06.04.2018 um 12:51 schrieb Heikki Krogerus
> :
>
> Hi Markus,
>
> On Fri, Apr 06, 2018 at 12:03:55PM +0200, Markus Heiser wrote:
>>>> There are ways to do this, look at how the v4l2 and I think the drm
>>>> subsystems handle ascii art such that
> Am 06.04.2018 um 11:11 schrieb Heikki Krogerus
> :
[...]
>> An ascii graphic in typec.rst cause the error.
>
> Thanks for the report. I'm going to propose that we fix this by
> marking the ascii art as comment:
>
> diff --git a/Documentation/driver-api/usb/typec.rst
> Am 16.02.2018 um 15:56 schrieb Jonathan Corbet :
>
> On Tue, 13 Feb 2018 13:31:46 +0200
> Mike Rapoport wrote:
>
>> When function description includes brackets after the function name as
>> suggested by Documentation/doc-guide/kernel-doc, the kernel-doc script
>> omits the function name from
> Am 16.02.2018 um 15:56 schrieb Mauro Carvalho Chehab
> :
>
> Em Fri, 16 Feb 2018 15:52:33 +0100
> Markus Heiser escreveu:
>
>>> Am 16.02.2018 um 14:48 schrieb Mauro Carvalho Chehab
>>> :
>>>
>>> The parser at kernel-doc rejects
> Am 16.02.2018 um 14:48 schrieb Mauro Carvalho Chehab
> :
>
> The parser at kernel-doc rejects names with dots in the middle.
> Fix it, in order to support nested structs/unions.
>
> Tested-by: Jani Nikula
> Signed-off-by: Mauro Carvalho Chehab
> ---
> scripts/kernel-doc | 2 +-
> 1 file chan
> Am 07.02.2018 um 18:26 schrieb Jonathan Corbet :
>
> It can be useful to put code snippets into kerneldoc comments; that can be
> done with the "::" operator at the end of a line like this::
>
> if (desperate)
> run_in_circles();
>
> kernel-doc currently fails to understand these litera
> Am 16.01.2018 um 11:22 schrieb Jani Nikula :
>
> On Wed, 10 Jan 2018, Jonathan Corbet wrote:
>> On Wed, 10 Jan 2018 15:04:53 +1100
>> "Tobin C. Harding" wrote:
>>
>>> Posting as RFC in the hope that someone knows how to massage sphinx
>>> correctly to fix this patch.
>>>
>>> Currently funct
> Am 11.01.2018 um 12:00 schrieb Masanari Iida :
>
> This patch fixes some spelling typos found in kfigure.py
FYI: I copied the patch to the linuxdoc project [1] / Thanks!
[1] https://github.com/return42/linuxdoc/commit/41d228f
-- Markus --
> Am 05.01.2018 um 15:30 schrieb Jani Nikula :
>
> On Thu, 04 Jan 2018, Knut Omang wrote:
>> On Thu, 2018-01-04 at 17:50 +0200, Jani Nikula wrote:
[...]
>> Hmm - I have been burnt by the use of unstable interfaces in Python before,
>> when I needed it to work on a (Linux) system with Python v.
> Am 05.01.2018 um 04:52 schrieb afzal mohammed :
[...]
> Initially i was sceptical of rst & once instead of hitting the fly,
> hit "make htmldocs" on the keyboard :), and the opinion about it was
> changed.
Yes, I understand that some of us have a (reasonable) doubt about
the reST markup. It
> Am 04.01.2018 um 04:59 schrieb afzal mohammed :
>
> Hi,
>
> On Thu, Jan 04, 2018 at 09:48:50AM +0800, Boqun Feng wrote:
>
>>> The location chosen is "Documentation/kernel-hacking", i was unsure
>>> where this should reside & there was no .rst file in top-level directory
>>> "Documentation", s
> Am 12.12.2017 um 16:23 schrieb Daniel Vetter :
>
>>> Thanks for your patch, but similar fix is already merged here [1]
>>>
>>> Michal
>>>
>>> [1]
>>> https://cgit.freedesktop.org/drm-tip/commit/?id=006c23327f8de8575508c458131b304188d426f7
>>
>>
>> Thanks for pointing out. I miss the ":doc:
> Am 12.12.2017 um 13:05 schrieb Michal Wajdeczko :
>
> On Tue, 12 Dec 2017 12:38:37 +0100, Markus Heiser
> wrote:
>
>> With commit d9e2e0143c the 'GuC-specific firmware loader' doc
>> section was removed from intel_guc_loader.c without a
>> replacem
c_loader.c to
intel_guc_fw.c
Signed-off-by: Markus Heiser
---
Documentation/gpu/i915.rst | 5 +
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 2e7ee03..e94d3ac 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentatio
> Am 07.12.2017 um 06:49 schrieb Tobin C. Harding :
>
> Documentation/printk-formats.txt is a candidate for conversion to
> ReStructuredText format. Some effort has already been made to do this
> conversion even thought the suffix is currently .txt
>
[...]
>
> Signed-off-by: Tobin C. Harding
>
> Am 06.12.2017 um 02:45 schrieb Tobin C. Harding :
>
> Documentation/printk-formats.txt is a candidate for conversion to
> ReStructuredText format. Some effort has already been made to do this
> conversion even thought the suffix is currently .txt
>
> Changes required to complete conversion
>
> Am 07.10.2017 um 18:34 schrieb Jonathan Corbet :
>
> On Wed, 4 Oct 2017 08:48:38 -0300
> Mauro Carvalho Chehab wrote:
>
>> Right now, it is not possible to document nested struct and nested unions.
>> kernel-doc simply ignore them.
>>
>> Add support to document them.
>
> So I've finally fo
> Am 18.09.2017 um 04:40 schrieb Paul E. McKenney :
[...]
> And after some playing around, I did get rid of the error messages.
> The code-block output looks a bit strange though, hints? I preceded
> the code block with "::", again at Akira's suggestion. It looks fine
> except for the :c:func: a
> Am 17.09.2017 um 03:26 schrieb Randy Dunlap :
>
> On 4.14-rc1, I am seeing lots of warnings on rcu kernel-doc:
>
> .. kernel-doc:: include/linux/rcupdate.h
> :external:
> ./Documentation/core-api/kernel-api.rst:357: ERROR: Error in "kernel-doc"
> directive:
> unknown option: "external".
FYI
Hi Rafael,
great work, helps me and the world saving fossil fuels ;)
> Am 20.08.2017 um 18:05 schrieb Rafael J. Wysocki :
>
> From: Rafael J. Wysocki
>
> Reorganize the power management part of admin-guide by adding a
> description of major power management strategies supported by the
> kernel
> Am 20.08.2017 um 18:06 schrieb Rafael J. Wysocki :
>
> From: Rafael J. Wysocki
>
> The Documentation/power/states.txt document is now redundant and
> sonewhat outdated, so delete it.
>
> Signed-off-by: Rafael J. Wysocki
> ---
> Documentation/power/states.txt | 127
> --
> Am 17.07.2017 um 12:57 schrieb Mauro Carvalho Chehab
> :
>
> So, we need a way for kfigure to fallback when distros don't
> have such feature.
Hm .. I'am not very happy to implement where distros packaging fail.
But .. if there is really a need for, I will do so.
Lets see how this series goe
> Am 17.07.2017 um 12:09 schrieb Mauro Carvalho Chehab
> :
>
>>
>> Anyway, I guess we should modify kfigure.py to check if PDF is
>> available, falling back to SVG, using ImageMagick to convert
>> from SVG to PDF.
>
> Ok, I discovered that, on Fedora, support for pdf, png and some other
> form
> Am 17.07.2017 um 00:08 schrieb Mauro Carvalho Chehab
> :
>
> [1] There's an unrelated bug with the Kernel's sphinx extension
> kimage: when parsing GraphViz graphs, it uses "-Tpdf" argument,
> in order to generate a PDF image. That doesn't work on some
> distros, as GraphViz doesn't support PD
> Am 17.07.2017 um 00:08 schrieb Mauro Carvalho Chehab
> :
>
> Instead of using 3 commands to install a virtualenv, use
> a single one, reading the requirements from this file:
>
> Documentation/sphinx/requirements.txt
>
> Signed-off-by: Mauro Carvalho Chehab
Hi Mauro,
I get a ..
fa
Hy Mauro,
thanks a lot for your RFC, your patch consolidate a lot of
knowledge around Sphinx build requirements and brings a huge
value I will no longer miss.
I tested v6 of this patch on ubuntu and there is only some
conceptual bikeshedding I can do.
> Am 15.07.2017 um 14:49 schrieb Mauro Car
> 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
> 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
> 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
> 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
> 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
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
[...]
> 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
> 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)
>> ..
>
> 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
> 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:
>>
>
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
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
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
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
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
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
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
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
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
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
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 ...
>
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
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/
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
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
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
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 +++
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
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
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
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 "
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
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?
>>
>> Sorry, I do not
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
>>>
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 p
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 sourc
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:
>>>
>>>>
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 s
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 -
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 -
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,
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
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
> inde
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 jus
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
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
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 of
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
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
>
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...
>
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 mo
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
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 wh
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
>>D
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 o
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
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
>>> ---
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 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
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 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
1 - 100 of 163 matches
Mail list logo
