Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

> 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

Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

> 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

Re: [RFC bpf-next] bpf: document eBPF helpers and add a script to generate man page

> Am 09.04.2018 um 12:08 schrieb Daniel Borkmann : [...] >> May I completely misunderstood you, so correct my if I'am wrong: >> >> - ./scripts/bpf_helpers_doc.py : produces reST markup from C-comments >> - ./scripts/kerne-doc : produces reST markup from C-comments

Re: [RFC bpf-next] bpf: document eBPF helpers and add a script to generate man page

> Am 09.04.2018 um 11:25 schrieb Daniel Borkmann <dan...@iogearbox.net>: > > On 04/09/2018 11:21 AM, Markus Heiser wrote: > [...] >> Do we really need another kernel-doc parser? >> >> ./scripts/kernel-doc include/uapi/linux/bpf.h >> >> shou

Re: [RFC bpf-next] bpf: document eBPF helpers and add a script to generate man page

On 04/06/2018 01:11 PM, Quentin Monnet wrote: >> eBPF helper functions can be called from within eBPF programs to perform >> a variety of tasks that would be otherwise hard or impossible to do with >> eBPF itself. There is a growing number of such helper functions in the >> kernel, but

Re: make xmldocs failed with error after 4.17 merge period

> Am 06.04.2018 um 12:51 schrieb Heikki Krogerus > <heikki.kroge...@linux.intel.com>: > > 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 >>>

Re: make xmldocs failed with error after 4.17 merge period

> 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

Re: Inline emphasis warnings (more)

> Am 19.02.2018 um 10:31 schrieb Jani Nikula : > >> modified include/linux/kernel.h >> @@ -638,8 +638,10 @@ do { >>\ >> * trace_printk - printf formatting in the ftrace buffer >> * @fmt: the

Re: Inline emphasis warnings (more)

> Am 16.02.2018 um 19:56 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > >> Am 01.10.2017 um 20:33 schrieb Randy Dunlap <rdun...@infradead.org>: >> >> A different "problem" this time: >> >> Documentation/driver-api/basics.rst

Re: Inline emphasis warnings (more)

> Am 01.10.2017 um 20:33 schrieb Randy Dunlap : > > A different "problem" this time: > > Documentation/driver-api/basics.rst pulls in include/linux/kernel.h. > has kernel-doc notation for (among others) trace_printk() > and trace_puts(). > > Part of the text for

Re: ReST questions

> Am 22.10.2017 um 21:42 schrieb Randy Dunlap : > > Hi, > > I'm trying to render the ascii-art in lib/textsearch.c "ARCHITECTURE" (block > diagram): Hi Randy, FYI: if you not have already been noticed, with Jon's patch [1] it should work. [1]

Re: [PATCH] scripts: kernel_doc: fixup reporting of function identifiers

> 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

Re: [PATCH 4/6] scripts: kernel-doc: support in-line comments on nested structs/unions

> Am 16.02.2018 um 15:56 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Fri, 16 Feb 2018 15:52:33 +0100 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >>> Am 16.02.2018 um 14:48 schrieb Mauro Carvalho Chehab >>>

Re: [PATCH 4/6] scripts: kernel-doc: support in-line comments on nested structs/unions

> 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

Re: [PATCH 8/8] docs: kernel-doc: Don't mangle literal code blocks in comments

> 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

Re: [PATCH 2/6] Minor fixes to kernel-doc.rst

> Am 08.02.2018 um 15:45 schrieb Matthew Wilcox : > > From: Matthew Wilcox > > The author clearly meant to use the word 'which' here. @mauro: my english is very bad and I'm not qualified to teach you any bit of english, but often I see that you mix

Re: kernel.org documentation link (was Re: Protecting code integrity with PGP)

> Am 19.01.2018 um 14:47 schrieb Konstantin Ryabitsev > : > > On 2018-01-19 03:37 AM, Jani Nikula wrote: >> On a side note, I was browsing for the generated kernel documentation at >> https://www.kernel.org/ and realized that AFAICT there are no links to >>

Re: [RFC] doc: fix code snippet build warnings

> 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

Re: [PATCH] linux-next: docs-rst: Fix typos in kfigure.py

> 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 -- -- To unsubscribe from this

Re: [PATCH v3 1/1] runchecks: Generalize make C={1,2} to support multiple checkers

> 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

Re: [PATCH] doc: memory-barriers: reStructure Text

> 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

Re: [PATCH] doc: memory-barriers: reStructure Text

> 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

Re: [PATCH] Documentation/driver-api/usb: Replace dead link

> Am 19.12.2017 um 19:45 schrieb Stefan Tatschner : > > On Mon, Dec 11, 2017 at 02:36:33PM -0700, Jonathan Corbet wrote: >> Working URLs are better than dead ones, so I've applied this. But that >> document was written 17 years ago and probably doesn't relate all

Re: [PATCH] docs: fix, intel_guc_loader.c has been moved to intel_guc_fw.c

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

[PATCH] docs: fix process/submit-checklist.rst Sphinx warning

add missing indent whitespace to list item, fixes the warning: - process/submit-checklist.rst:41: WARNING: Enumerated list ends without a blank line; unexpected unindent. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/process/submit-checklist.rst | 4 ++--

[PATCH] docs: ftrace-uses.rst fix varios code-block directives

in any toctree Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/trace/ftrace-uses.rst | 60 ++--- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/Documentation/trace/ftrace-uses.rst b/Documentation/trace/ftrace-uses.rst

Re: [PATCH] docs: Remove "could not extract kernel version" warning

> Am 12.12.2017 um 08:40 schrieb Jani Nikula : > > On Mon, 11 Dec 2017, Randy Dunlap wrote: >> On 12/11/2017 02:24 PM, Jonathan Corbet wrote: >>> This warning will happen for every normal kernel docs build and doesn't >>> carry any useful

Re: [PATCH v2] kernel-doc: parse DECLARE_KFIFO and DECLARE_KFIFO_PTR()

FYI: added similar patch to the linuxdoc sphinx-extension https://github.com/return42/linuxdoc/commit/726af7a Thanks! -- Markus -- > Am 08.12.2017 um 15:05 schrieb Mauro Carvalho Chehab > : > > On media, we now have an struct declared with: > > struct lirc_fh { >

Re: [PATCH v2] doc: convert printk-formats.txt to rst

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

Re: [PATCH] doc: convert printk-formats.txt to rst

> 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

Re: [PATCH v3 00/17] kernel-doc: add supported to document nested structs/

> 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

Re: [PATCH v2 09/13] scripts: kernel-doc: parse next structs/unions

> Am 29.09.2017 um 17:29 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Thu, 28 Sep 2017 18:28:32 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Hi Mauro, >> >>> Am 27.09.2017 um 23:10 schrieb M

Re: [PATCH v2 09/13] scripts: kernel-doc: parse next structs/unions

> Am 29.09.2017 um 15:33 schrieb Mauro Carvalho Chehab > : >> Sorry if I was unclear. I mean we should not use tabs in reST or in py. > > Ah, OK. > >> In python the indentation is a part of the language syntax, same in >> reST; the indentation is the markup. It's not

Re: [PATCH v2 09/13] scripts: kernel-doc: parse next structs/unions

> Am 29.09.2017 um 14:08 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Thu, 28 Sep 2017 18:28:32 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Hi Mauro, >> >>> Am 27.09.2017 um 23:10 schrieb M

Re: [PATCH v2 12/13] scripts: kernel-doc: handle nested struct function arguments

Hi Mauro, this 'else' addition seems a bit spooky to me. As I commented in patch 09/13 may it helps when you look at https://github.com/return42/linuxdoc/blob/master/linuxdoc/kernel_doc.py#L2499 which is IMO a bit more clear. -- Markus -- > Am 27.09.2017 um 23:10 schrieb Mauro Carvalho

Re: [PATCH v2 09/13] scripts: kernel-doc: parse next structs/unions

Hi Mauro, > Am 27.09.2017 um 23:10 schrieb Mauro Carvalho Chehab > : > > > > diff --git a/Documentation/doc-guide/kernel-doc.rst > b/Documentation/doc-guide/kernel-doc.rst > index 96012f9e314d..9e63a18cceea 100644 > --- a/Documentation/doc-guide/kernel-doc.rst > +++

Re: [PATCH net-next 2/2] tools: bpf: add bpftool

> Am 27.09.2017 um 13:19 schrieb Jesper Dangaard Brouer : [...] >>> I would prefer adding a README.rst file, in RST-format, as the rest of >>> the kernel documentation is moving in that direction[1] (your github >>> version is in README.md format). A man page will always be

Re: [PATCH] scripts: kernel-doc: parse next structs/unions

> Am 25.09.2017 um 20:22 schrieb Mauro Carvalho Chehab > : > > Jon, > > Please let me know what you think about this approach. IMHO, it is a way > better than what we do right now. This is more a proof of concept, as the > patch is not complete. > > With it, we can

Re: [PATCH v2] scripts: kernel-doc: fix nexted handling

> Am 25.09.2017 um 20:41 schrieb Mauro Carvalho Chehab > : >>> + $cont = 1; >>> + }; >>> + }; >>> + # Ignore other nested elements, like enums >>> + $members =~ s/({[^\{\}]*})//g; >>> + $nested = $decl_type; >> >> What is the

Re: [PATCH v2] scripts: kernel-doc: fix nexted handling

> Am 24.09.2017 um 19:38 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Sun, 24 Sep 2017 17:13:13 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >>> Am 24.09.2017 um 12:23 schrieb Mauro Carvalho Che >>> &g

Re: [PATCH v2] scripts: kernel-doc: fix nexted handling

> Am 24.09.2017 um 12:23 schrieb Mauro Carvalho Che > > v2: handle embedded structs/unions from inner to outer > > When we have multiple levels of embedded structs, > > we need a smarter rule that will be removing nested structs > from the inner to the outer ones. So, changed the parsing rule

Re: [PATCH] scripts: kernel-doc: fix nexted handling

# ignore members marked private: Hi Mauro, I tested this patch. Feel free to add my Tested-by: Markus Heiser <markus.hei...@darmarit.de> FYI: I also migrated the patch to my python kernel-doc parser: https://github.com/return42/linuxdoc/commit/5dbb93f And here is the impact o

Re: rcu kernel-doc issues (4.14-rc1)

> 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

Re: rcu kernel-doc issues (4.14-rc1)

> 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

Re: Inline emphasis warnings

> Am 09.09.2017 um 18:46 schrieb Randy Dunlap : > > Hi, > > What is the suggested way(s) to fix this warning: > > ../kernel/sched/fair.c:7584: WARNING: Inline emphasis start-string without > end-string. > > from this source: > > * this CPU. The amount of the

Re: [PATCH] Documentation/sphinx: fix kernel-doc decode for non-utf-8 locale

> Am 31.08.2017 um 21:43 schrieb Jonathan Corbet : > > On Thu, 31 Aug 2017 22:21:29 +0300 > Jani Nikula wrote: > >> On python3, Popen() universal_newlines=True converts the subprocess >> stdout to unicode text using a codec based on user preferences.

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

> Am 31.08.2017 um 00:38 schrieb Jonathan Corbet <cor...@lwn.net>: > > On Fri, 16 Jun 2017 21:27:48 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> Reported by Johannes Berg [1]. Problem here: function >> process_proto_type() concat

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

Hi Jon sorry for polling you .. but I miss this patch. Can you please take a look on it / Thanks! -- Markus -- > Am 16.06.2017 um 21:27 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > Reported by Johannes Berg [1]. Problem here: function > process_proto_t

Re: [PATCH] docs: fix minimal sphinx version in conf.py

Hi Jon, I assume you missed this patch, so please can you take a look at / Thanks! -- Markus -- > Am 14.08.2017 um 10:53 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > according to what Documentation/doc-guide/sphinx.rst says:: > > The ReST markups currently used

Re: [PATCH 1/2] PM: docs: Describe high-level PM strategies and sleep states

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

Re: [PATCH 2/2] PM: docs: Delete the obsolete states.txt document

> 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

Re: docs build questions

> Am 14.08.2017 um 09:45 schrieb Jani Nikula <jani.nik...@linux.intel.com>: > > On Mon, 14 Aug 2017, Markus Heiser <markus.hei...@darmarit.de> wrote: >> see "Sphinx Install" Documentation/doc-guide/sphinx.rst (ATM in Jon's >> docs-n

[PATCH] docs: fix minimal sphinx version in conf.py

according to what Documentation/doc-guide/sphinx.rst says:: The ReST markups currently used by the Documentation/ files are meant to be built with ``Sphinx`` version 1.3 or upper. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/conf.py | 2 +- 1 file chan

[PATCH] docs: fix nested numbering in the TOC

-funcs.rst is just a C typo, so lets remove it. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/input/joydev/index.rst | 1 - Documentation/media/uapi/cec/cec-funcs.rst | 1 - 2 files changed, 2 deletions(-) diff --git a/Documentation/input/joydev/index.

media/v4l-drivers/imx.rst: WARNING: document isn't included in any toctree

Hi Steve, Mauro, when I generate documentation from Jon's docs-next, I get this warning: checking consistency... Documentation/media/v4l-drivers/imx.rst: WARNING: document isn't included in any toctree Is there already something on its way upstream or did you missed adding imx.rst to

Re: docs build questions

Hi Randy, > Am 13.08.2017 um 19:29 schrieb Randy Dunlap : > > Hi, > > [on linux v4.13-rc4] > >> sphinx-build --version > Sphinx (sphinx-build) 1.2.3 see "Sphinx Install" Documentation/doc-guide/sphinx.rst (ATM in Jon's docs-next) The ReST markups currently used by the

Re: [PATCH 0/5] Add a script to check for Sphinx install requirements

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

Re: [PATCH 0/5] Add a script to check for Sphinx install requirements

> 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

Re: [PATCH 0/5] Add a script to check for Sphinx install requirements

> 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

Re: [PATCH 3/5] sphinx-pre-install: use a requirements file

> 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

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

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

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

> Am 15.07.2017 um 04:21 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Fri, 14 Jul 2017 19:35:59 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >>> Am 14.07.2017 um 18:49 schrieb Mauro Carvalho Chehab >>> <

Re: [PATCH 2/6] docs-rst: update Sphinx install instructions

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

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

> Am 13.07.2017 um 22:50 schrieb Mauro Carvalho Chehab > <mche...@s-opensource.com>: > > Em Mon, 6 Mar 2017 14:09:27 +0100 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> This patch brings scalable figure, image handling and a concept to >

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

> Am 05.07.2017 um 23:45 schrieb Jim Davis <jim.ep...@gmail.com>: > > On Fri, Jun 16, 2017 at 7:03 AM, Markus Heiser > <markus.hei...@darmarit.de> wrote: >> > >> docproc and some lines in the Makefile & .gitignore >> >> ./scripts/do

Re: [PATCH 0/5] Make PDF builds work again

> 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

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

> Am 03.07.2017 um 10:22 schrieb Daniel Vetter <dan...@ffwll.ch>: > > On Fri, Jun 16, 2017 at 09:27:48PM +0200, Markus Heiser wrote: >> R--- >> scripts/kernel-doc | 4 >> 1 file changed, 4 insertions(+) >> >> diff --git a/scripts/kernel-doc b

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

> Am 05.07.2017 um 23:14 schrieb Jim Davis <jim.ep...@gmail.com>: > > On Tue, Jul 4, 2017 at 12:39 AM, Markus Heiser > <markus.hei...@darmarit.de> wrote: >> From: Markus Heiser <markus.hei...@darmarit.de> >> >> The 'lintdocs' produces

Re: [PULL] Docs for 4.13

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"

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

From: Markus Heiser <markus.hei...@darmarit.de> The 'lintdocs' produces no output. The input is only parsed and checked for consistency. This is useful for basic sanity checks [1]. The 'lintdocs' target uses Sphinx's 'dummy' builder. For this at least Sphinx 1.4 is needed [2]. Sphi

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

Hi Jon, sorry for my noise .. did you received the two patches? -- Markus -- > Am 17.06.2017 um 10:17 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > List items with two ore more blocks are not well rendered. E.g. the gap > between last block (l1-b2) of t

Re: [PATCH] scripts/kernel-doc: handle DECLARE_HASHTABLE

> Am 01.07.2017 um 04:09 schrieb Jakub Kicinski : > > DECLARE_HASHTABLE needs similar handling to DECLARE_BITMAP > because otherwise kernel-doc assumes the member name is the > second, not first macro parameter. > > Signed-off-by: Jakub Kicinski

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

> Am 20.06.2017 um 21:56 schrieb Jonathan Corbet <cor...@lwn.net>: > > On Tue, 20 Jun 2017 16:51:40 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> This add a virtualenv [1] with we can control the versions >> of Documentation's

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

[...] > Am 19.06.2017 um 17:13 schrieb Markus Heiser <markus.hei...@darmarit.de>: > >>> 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

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

https://virtualenv.pypa.io [2] https://pip.pypa.io [3] https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/.gitignore | 1 + Documentation/Makefile

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

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

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

> 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

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

in the future (take this as a interim solution). Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/sphinx-static/theme_overrides.css | 11 +++ 1 file changed, 11 insertions(+) diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/

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

that it can be read more liquidly, a distance was added to the last block (l1-b2):: * L1 xx x l1-b2 xxx x * L2 xx x Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/sphinx-

Re: kernel-doc mishandles declarations split into lines

> Am 16.06.2017 um 15:11 schrieb Johannes Berg : > > Hi Markus, > >> The parser part is same state machine as the the perl one … with same >> problems ;) > > :-) > >> Problem here; function process_proto_type() concatenates the striped >> lines of declaration

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

> 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

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

he week.) > > The patch will hopefully also be merged in Linus's tree for the > next -rc kernel release. > > If you have any questions about this process, please let me know. > > > From 5383fae76b8224a8f0465be6ab9c7a645042951a Mon Sep 17 00:00:00 2001 > From: Markus He

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

typec_set_data_role typec_set_pwr_role typec_set_vconn_role typec_set_pwr_opmode Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/usb/typec.rst | 6 ++ 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/Documentation/usb/typec.rst b/Documentation/usb/typec.rst ind

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

-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/userspace-api/unshare.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/userspace-api/unshare.rst b/Documentation/userspace-api/unshare.rst index 737c192..877e90a 100644 --- a/Documentation/use

[PATCH] core-api: remove an unexpected unident

As complained by Sphinx: Documentation/core-api/assoc_array.rst:13: WARNING: Enumerated list ends without a blank line; unexpected unindent. This was already addressed, but not really fixed in 2ba90ccca7. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentatio

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

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

Re: [PATCH 03/36] docs-rst: convert kernel-locking to ReST

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

Re: [PATCH 03/36] docs-rst: convert kernel-locking to ReST

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

Re: [PATCH 01/36] docs-rst: convert kernel-hacking to ReST

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

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

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

Re: [PATCH] docs: conf.py: increase recursion limit

Am 13.04.2017 um 15:29 schrieb Mauro Carvalho Chehab <mche...@s-opensource.com>: > Em Thu, 13 Apr 2017 14:55:03 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> On 13.04.2017 12:42, Mauro Carvalho Chehab wrote: >>> The default recursio

Re: [PATCH] docs: conf.py: increase recursion limit

On 13.04.2017 15:29, Mauro Carvalho Chehab wrote: Em Thu, 13 Apr 2017 14:55:03 +0200 Markus Heiser <markus.hei...@darmarit.de> escreveu: On 13.04.2017 12:42, Mauro Carvalho Chehab wrote: The default recursion limit is not good enough to handle complex books. I'm sometimes rec

Re: [PATCH] docs: conf.py: increase recursion limit

On 13.04.2017 12:42, Mauro Carvalho Chehab wrote: The default recursion limit is not good enough to handle complex books. I'm sometimes receiving this error message: sphinx.errors.SphinxParallelError: RecursionError: maximum recursion depth exceeded while pickling an object or

Re: [PATCH 1/2] Documentation/sphinx: kerneldoc: add "unused-functions"

Am 31.03.2017 um 09:16 schrieb Johannes Berg : > From: Johannes Berg > > When adding functions one by one into documentation, in order to > order/group things properly, it's easy to miss things. Allow use > of the kernel-doc directive with

Re: doc build requirements

s changed and I can try again? :) no ;) yes, you are right and we have improved it; since .. -- doc-4.11-images db6ccf23e8ba40fc2e8914ec9c0eb950df71d9fe Author: Markus Heiser <markus.hei...@darmarit.de> AuthorDate: Mon Mar 6 14:09:27 2017 +0100 docs-rst: automatically convert Graphv

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

Am 30.03.2017 um 13:17 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > If it helps ... dbxml2rst also supports single file conversion ... I updated: > > > https://github.com/return42/sphkerneldoc/tree/master/Documentation/books_migrated > > There you fin

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

Am 30.03.2017 um 12:12 schrieb Mauro Carvalho Chehab : >>> At this point I'd just go with what Mauro has. It's here now, as >>> patches. We've seen from the GPU documentation that polishing the >>> one-time initial conversion is, after a point, wasted effort. Having the

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

Am 30.03.2017 um 10:21 schrieb Jani Nikula <jani.nik...@intel.com>: > On Thu, 30 Mar 2017, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Hi Mauro, >> >> Am 29.03.2017 um 20:54 schrieb Mauro Carvalho Chehab >> <mche...@s-opensource.com>:

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

Hi Mauro, Am 29.03.2017 um 20:54 schrieb Mauro Carvalho Chehab : > As we're moving out of DocBook, let's convert the remaining > USB docbooks to ReST. > > The transformation itself on this patch is a no-brainer > conversion using pandoc. right, its a no-brainer ;-)

Re: [PATCH 216/216] Use sphinx.version_info directly instead of parsing

Am 20.03.2017 um 16:11 schrieb Jani Nikula : >> # Get Sphinx version >> -major, minor, patch = map(int, sphinx.__version__.split(".")) >> +major, minor, patch, _, _ = sphinx.version_info Thanks! ... alternative, use only first three items of the tuple. More stable,

  1   2   3   4   >