Re: [PATCH] kernel-doc: better handle '::' sequences

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

Re: [RFC] scripts: kernel-doc: avoid warnings due to initial commented lines in file

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

Re: linux-next: build failure after upgrading sphinx

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

Re: Documentation: build failure with sphinx >= 3.0.0: exception: cannot import name 'c_funcptr_sig_re' from 'sphinx.domains.c'

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

Re: Documentation: build failure with sphinx >= 3.0.0: exception: cannot import name 'c_funcptr_sig_re' from 'sphinx.domains.c'

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

Re: [PATCH 12/14] doc-rst: add ABI documentation to the admin-guide book

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

Re: [PATCH 0/9] docs: Fix various build warnings/errors

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

Re: [PATCH 0/9] docs: Fix various build warnings/errors

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

Re: [PATCH 7/9] docs: Remove unknown 'hint' directive

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.

Re: [PATCH 10/17] prmem: documentation

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.

Re: [PATCH 10/17] prmem: documentation

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.

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

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: [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 kernel-doc markups,

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

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: 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 a/Documentation/driver-api/usb/typec.rst

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] 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 kernel-doc script >> omits the function name from

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

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 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 Chehab > --- > scripts/kernel-doc | 2 +- > 1 file

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

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: [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 sphinx >>> correctly to fix this patch. >>> >>> Currently

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

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

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 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 needed it to work on a (Linux) system with Python

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

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] 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 directory >>> "Documentation",

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.

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. I miss the

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

> Am 12.12.2017 um 13:05 schrieb Michal Wajdeczko <michal.wajdec...@intel.com>: > > On Tue, 12 Dec 2017 12:38:37 +0100, Markus Heiser <markus.hei...@darmarit.de> > wrote: > >> With commit d9e2e0143c the 'GuC-specific firmware loader' doc >> section was

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

> 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 >> replacement. So l

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

to intel_guc_fw.c Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- 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/i9

[PATCH] docs: fix, intel_guc_loader.c has been moved to intel_guc_fw.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/Documentation/gpu/i915

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 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: Tobin C. Harding

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] 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 complete conversion >

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 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 support to document them. > > So I've finally

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

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: 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 option: "external".

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 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 power management strategies supported by the >

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: [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 > --- > Documentation/power/states.txt | 127 >

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

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

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 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 GraphViz doesn't support

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 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 Hi Mauro, I get a ..

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

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 RFC] scripts/sphinx-pre-install: add a script to check Sphinx install

> 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

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

> 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

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

> 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

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 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: formatting things this way assumes that

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 v2 00/53] Get rid of Docbook

> 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

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 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 already >>> queued up for at least 4.13 (Dave was out and

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"

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" builds > between every single

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

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

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

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

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

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 output, add a notice about how to

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 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 convert the remaining DocBooks to ReST. >> >> Gotta love this: >>

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 > --- > Documentation/DocBook/Makefile

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 > --- > Documentation/DocBook/Makefile

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 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 **bold** for emphasis. > >

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 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 ABI logic there, but, in

Re: making documentation targets on v4.10 with Fedora 25

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=

Re: making documentation targets on v4.10 with Fedora 25

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

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

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

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

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

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

Am 25.01.2017 um 21:59 schrieb Jani Nikula : >> But the problem I see here is, that the perl script generates a >> reST output which I can't use. As an example we can take a look at >> the man-page builder I shipped in the series. > > Sorry, I still don't understand *why*

  1   2   3   4   >