Re: [PATCH] x86: fix memory ranges in mm documentation

2016-09-06 Thread Jonathan Corbet
On Tue, 23 Aug 2016 09:00:45 +0100 Lorenzo Stoakes wrote: > This is a trivial fix to correct upper bound addresses to always be > inclusive. Previously, the majority of ranges specified were inclusive with a > small minority specifying an exclusive upper bound. This patch

Re: [PATCH 1/3] documentation/scsi: Remove nodisconnect parameter

2016-09-06 Thread Jonathan Corbet
On Sat, 27 Aug 2016 12:29:59 +1000 Finn Thain wrote: > The driver that used the 'nodisconnect' parameter was removed in > commit 565bae6a4a8f ("[SCSI] 53c7xx: kill driver"). Related documentation > was cleaned up in commit f37a7238d379 ("[SCSI] 53c7xx: fix removal >

Re: [PATCH 3/3] doc-rst:c-domain: function-like macros index entry

2016-09-06 Thread Jonathan Corbet
On Wed, 31 Aug 2016 17:29:32 +0200 Markus Heiser wrote: > For function-like macros, sphinx creates 'FOO (C function)' entries. > With this patch 'FOO (C macro)' are created for function-like macros, > which is the same for object-like macros. As others have pointed

Re: [PATCH 1/3] doc-rst:c-domain: fix sphinx version incompatibility

2016-09-06 Thread Jonathan Corbet
On Wed, 31 Aug 2016 17:29:30 +0200 Markus Heiser wrote: > +if major >= 1 and minor < 4: > +# indexnode's tuple changed in 1.4 > +# > https://github.com/sphinx-doc/sphinx/commit/e6a5a3a92e938fcd75866b4227db9e0524d58f7c > +

Re: [PATCH] doc: ioctl: Add some clarifications to botching-up-ioctls

2016-09-06 Thread Jonathan Corbet
On Sat, 03 Sep 2016 00:44:02 +0200 Arnd Bergmann wrote: > On Friday, September 2, 2016 3:42:24 PM CEST Laura Abbott wrote: > > - The guide currently says to pad the structure to a multiple of > > 64-bits. This is not necessary in cases where the structure contains > > no

Re: [PATCH] Documentation/CodingStyle

2016-09-06 Thread Jonathan Corbet
On Sat, 3 Sep 2016 08:13:13 +0200 Bruno Raoult wrote: > I am new here, so feel free to tell me if I am wrong. Welcome! > I am participating to Eulyptula challenge, and of course had a look on > Documentation/CodingStyle. > > As I use GNU/Emacs (yes, I know, Evil Tool,

Re: [PATCH] Fix how CSS files are added to the Sphinx HTML.

2016-09-03 Thread Jonathan Corbet
On Fri, 2 Sep 2016 10:26:33 -0700 Eric Holscher wrote: > I'm happy to resend the whole patch, or feel free to simply edit my > original with your suggested > ``app.add_stylesheet('theme_overrides.css')`` line. Please go ahead and send an updated patch. Then I'm sure I'll

Re: [PATCH] doc-rst:sphinx-extensions: add metadata parallel-safe

2016-09-01 Thread Jonathan Corbet
On Wed, 24 Aug 2016 15:35:24 +0200 Markus Heiser wrote: > With metadata "parallel_read_safe = True" a extension is marked as > save for "parallel reading of source". This is needed if you want > build in parallel with N processes. E.g.: > > make SPHINXOPTS=-j4

Re: [PATCH 0/3] Fix kernel-doc parser for typedef functions

2016-09-01 Thread Jonathan Corbet
On Tue, 30 Aug 2016 20:20:56 -0300 Mauro Carvalho Chehab wrote: > The other two patches better fit on your tree, IMHO. > > Mauro Carvalho Chehab (3): > docs-rst: improve typedef parser > docs-rst: kernel-doc: fix typedef output in RST format I've just applied

Re: [PATCH 2/3] docs: split up the driver book

2016-08-25 Thread Jonathan Corbet
On Tue, 23 Aug 2016 11:30:16 -0300 Mauro Carvalho Chehab wrote: > I noticed several issues on the converted document. Just commenting > a few of them, as they all follow a pattern: kernel-doc markups > needs review during the conversion to RST, because, unfortunately, >

Re: [PATCH v9 1/2] Documentation: kdump: remind user of nr_cpus

2016-08-25 Thread Jonathan Corbet
On Wed, 24 Aug 2016 13:06:45 +0800 Baoquan He wrote: > Hi Jon, do you think change as below is OK to you? So nr_cpus is the maximum value, and maxcpus is the current number. Figures. No wonder the documentation is confusing... Anyway, this is much more along the lines of what

Re: [PATCH 2/3] docs: split up the driver book

2016-08-24 Thread Jonathan Corbet
mments. But this seems to improve things for the moment. jon >From 5dccd4fb9f3c0b6468f38efab8c1d6232d3e701b Mon Sep 17 00:00:00 2001 From: Jonathan Corbet <cor...@lwn.net> Date: Wed, 24 Aug 2016 16:31:15 -0600 Subject: [PATCH] docs: Special-case function-pointer parameters in kernel-doc A

Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts

2016-08-23 Thread Jonathan Corbet
On Tue, 23 Aug 2016 08:01:35 +0200 Daniel Vetter wrote: > I'm also not too sure about whether dma-buf really should be it's own > subdirectory. It's plucked from the device-drivers.tmpl, I think an > overall device-drivers/ for all the misc subsystems and support code would > be

Re: [PATCH 0/2] Two additional patches for Documentation/conf.py

2016-08-22 Thread Jonathan Corbet
On Sun, 21 Aug 2016 15:26:14 -0300 Mauro Carvalho Chehab wrote: > The first patch in this series use the type of notice box to color the box, > providing a functionality that it is also used on the HTML theme we use. > > The second patch is a fix for a non-fatal error

Re: [PATCH] docs-rst: kernel-doc: better output struct members

2016-08-22 Thread Jonathan Corbet
On Sun, 21 Aug 2016 09:11:57 -0300 Mauro Carvalho Chehab wrote: > So, change kernel-doc, for it to produce the output on a different way: > > **Members** > > ``prios[4]`` > - **type**: ``atomic_t`` > > array with elements to store the

Re: [PATCH] docs-rst: conf.py: adjust the size of .. note:: tag

2016-08-22 Thread Jonathan Corbet
On Fri, 19 Aug 2016 09:49:38 -0300 Mauro Carvalho Chehab wrote: > While the current implementation works well when using as a > paragraph, it doesn't work properly if inside a table. As we > have quite a few such cases, fix the logic to take the column > size into

Re: [PATCH] docs-rst: add support for LaTeX output

2016-08-22 Thread Jonathan Corbet
On Thu, 18 Aug 2016 11:53:39 -0300 Mauro Carvalho Chehab wrote: > Sphinx supports LaTeX output. Sometimes, it is interesting to > call it directly, instead of also generating a PDF. As it comes > for free, add a target for it. > Applied to the docs tree, thanks. jon

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

2016-08-22 Thread Jonathan Corbet
On Mon, 15 Aug 2016 16:08:23 +0200 Markus Heiser wrote: > this is my approach to eliminate some distortions we have with the c/cpp > Sphinx > domains. The C domain is simple: it assumes that all functions, enums, etc > are global, e. g. there should be just one

[PATCH 2/3] docs: split up the driver book

2016-08-22 Thread Jonathan Corbet
We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Cc: Jani Nikula <jani.nik...@intel.com> Cc: Mauro Carvalho Chehab <mche...@s-opensource.com> Signed-off-by: Jonathan

[PATCH 1/3] Docs: sphinxify device-drivers.tmpl

2016-08-22 Thread Jonathan Corbet
Perform a basic sphinx conversion of the device-drivers docbook and move it to its own directory. Cc: Jani Nikula <jani.nik...@intel.com> Cc: Mauro Carvalho Chehab <mche...@s-opensource.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/DocBook/Makefil

[PATCH 3/3] docs: Pull HSI documentation together

2016-08-22 Thread Jonathan Corbet
The HSI subsystem documentation was split across hsi.txt and the device-drivers docbook. Now that the latter has been converted to Sphinx, pull in the HSI document so that it's all in one place. Cc: Sebastian Reichel <s...@kernel.org> Signed-off-by: Jonathan Corbet <cor..

Re: [PATCH] CodingStyle: add some more error handling guidelines

2016-08-22 Thread Jonathan Corbet
On Mon, 22 Aug 2016 16:57:46 +0300 "Michael S. Tsirkin" wrote: > commit commit ea04036032edda6f771c1381d03832d2ed0f6c31 ("CodingStyle: > add some more error handling guidelines") suggests never naming goto > labels after the goto location - that is the error that is handled. >

Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools

2016-08-18 Thread Jonathan Corbet
he formatted output suffers slightly, but it's not a big deal... Thanks, jon >From d228af5bcb60fda50f8b3a100c0539c4994df040 Mon Sep 17 00:00:00 2001 From: Jonathan Corbet <cor...@lwn.net> Date: Sun, 7 Aug 2016 15:09:14 -0600 Subject: [PATCH] docs: sphinxify sparse.txt and move to dev-tools

Re: [PATCH v2] Documentation: sunxi: Update Allwinner SoC documentation

2016-08-18 Thread Jonathan Corbet
On Sat, 13 Aug 2016 18:01:13 +0800 Icenowy Zheng wrote: > Now, the A83T and A64 SoC user manuals are available. > Update the documentation to add the links. > > An updated version of A83T datasheet is also included now. Applied to the docs tree, thanks. jon -- To unsubscribe

Re: [PATCH] kconfig-language: improve menuconfig usage description

2016-08-18 Thread Jonathan Corbet
On Wed, 3 Aug 2016 00:40:34 +0200 Eugeniu Rosca wrote: > Improper menuconfig usage leads to empty menu entries. > zconfdump() is able to reveal some real-life examples: > - menuconfig VFIO_NOIOMMU > - menuconfig RESET_CONTROLLER > - menuconfig SND_ARM > > To avoid future

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

2016-08-18 Thread Jonathan Corbet
On Sat, 13 Aug 2016 16:12:42 +0200 Markus Heiser wrote: > Add a generic way to build only a reST sub-folder with or > without a individual *build-theme*. > > * control *sub-folders* by environment SPHINXDIRS > * control *build-theme* by environment SPHINX_CONF > >

Re: [PATCH] mm, kasan: Update kasan docs to indicate arm64 support

2016-08-18 Thread Jonathan Corbet
On Tue, 16 Aug 2016 09:30:31 -0700 Laura Abbott wrote: > KASAN has been supported on arm64 since 39d114ddc682 ("arm64: add KASAN > support"). Update the docs to indicate this. This creates a conflict with my patch sphinxifying this file, of course, but I'll cope. Applied to

[PULL] Docs fixes

2016-08-18 Thread Jonathan Corbet
: customize RTD theme, drop padding of inline literal (2016-08-14 12:15:09 -0600) Three small fixes for Sphinx-formatted documentation generation. Jonathan Corbet (2

Re: rst htmldocs on kernel.org

2016-08-15 Thread Jonathan Corbet
On Thu, 11 Aug 2016 21:13:29 +0200 Lukas Wunner wrote: > not sure if this is already on your radar or if you're at all the > right person to contact, but I just noticed that the gpu htmldocs > are gone from https://www.kernel.org/doc/htmldocs/gpu/ > > Actually all the

Re: [PATCH] Documentation: kprobes: Document jprobes stack copying limitations

2016-08-15 Thread Jonathan Corbet
On Mon, 15 Aug 2016 10:49:36 -0400 David Long <dave.l...@linaro.org> wrote: > On 08/15/2016 10:25 AM, Jonathan Corbet wrote: > > On Fri, 12 Aug 2016 16:24:44 -0400 > > David Long <dave.l...@linaro.org> wrote: > > > >> Some architectures (i.e.: sparc6

Re: [PATCH] Documentation: kprobes: Document jprobes stack copying limitations

2016-08-15 Thread Jonathan Corbet
On Fri, 12 Aug 2016 16:24:44 -0400 David Long wrote: > Some architectures (i.e.: sparc64 and arm64) make reasonable partial stack > duplication for jprobes problematic. Document this. Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line

Re: [PATCH] CodingStyle: Remove "Don't use C99-style comments"

2016-08-14 Thread Jonathan Corbet
On Thu, 04 Aug 2016 10:55:14 -0700 Joe Perches wrote: > > Because Linus may still be reading source code on greenbar paper > > instead of color terminals with code syntax highlighting and > > appropriate font decorations. > > > > Link: > >

Re: [PATCH] CodingStyle: Clarify and complete chapter 7

2016-08-14 Thread Jonathan Corbet
On Mon, 25 Jul 2016 14:29:06 +0200 Jean Delvare wrote: > Chapter 7 (Centralized exiting of functions) of the coding style > documentation is unclear at times, and lacks some information (such > as the possibility to indent labels with a single space.) Clarify and > complete it.

Re: [PATCH] doc-rst: customize RTD theme, drop padding of inline literal

2016-08-14 Thread Jonathan Corbet
On Fri, 5 Aug 2016 11:27:07 +0200 Hans Verkuil wrote: > On 08/05/2016 11:19 AM, Markus Heiser wrote: > > From: Markus Heiser > > > > Remove the distracting (left/right) padding of inline literals. (HTML > > ). Requested and discussed in [1]. > >

Re: [PATCH v2] Documentation: clk: update file names containing referenced structures

2016-08-14 Thread Jonathan Corbet
On Fri, 12 Aug 2016 14:41:25 +0200 Geert Uytterhoeven wrote: > From: Andi Shyti > > Commit 'b09d6d991' removes include/linux/clk-private.h and > re-arranges the clock related structures contained in it in > different files. The documentation has

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

2016-08-14 Thread Jonathan Corbet
On Sat, 13 Aug 2016 16:12:41 +0200 Markus Heiser wrote: > this series is a consolidation on Jon's docs-next branch. It merges the > "sphinx > sub-folders" patch [1] and the "parseheaders directive" patch [2] on top of > Jon's docs-next. > > In sense of consolidation,

Re: [RFC PATCH 0/3] Documentation: switch to pdflatex and fix pdf build

2016-08-12 Thread 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 an example where to add your stuff

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

2016-08-12 Thread Jonathan Corbet
On Mon, 8 Aug 2016 15:14:58 +0200 Markus Heiser wrote: > Remove the 'DOC_NITPIC_TARGETS' from main $(srctree)/Makefile and add a > more generic way to build only a reST sub-folder. > > * control *sub-folders* by environment SPHINXDIRS > * control *build-theme* by

Re: [RFC 0/4] doc: dma-buf: sphinx conversion and cleanup

2016-08-11 Thread Jonathan Corbet
On Thu, 11 Aug 2016 16:17:56 +0530 Sumit Semwal wrote: > Convert dma-buf documentation over to sphinx; also cleanup to > address sphinx warnings. > > While at that, convert dma-buf-sharing.txt as well, and make it the > dma-buf API guide. Thanks for working to improve

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

2016-08-11 Thread Jonathan Corbet
On Thu, 11 Aug 2016 12:02:31 +0200 Markus Heiser wrote: > "bump" ... may my mail got lost ... > > It's about the default highlight language in the conf.py. I suggested > to set it to the value 'guess', since this might solve most of our > problems discussed in this

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

2016-08-10 Thread Jonathan Corbet
On Wed, 10 Aug 2016 12:23:16 +0300 Jani Nikula wrote: > >> I just noticed running 'make htmldocs' rebuilds parts of media docs > >> every time on repeated runs. This shouldn't happen. Please investigate. > > > > I was unable to reproduce it here. Are you passing any

[PATCH 10/10] docs: Sphinxify gdb-kernel-debugging.txt and move to dev-tools

2016-08-08 Thread Jonathan Corbet
Cc: Jan Kiszka <jan.kis...@siemens.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- .../gdb-kernel-debugging.rst} | 77 +- Documentation/dev-tools/tools.rst | 1 + 2 files changed, 46 insertions(+), 32 deletion

[PATCH 02/10] docs: sphinxify coccinelle.txt and add it to dev-tools

2016-08-08 Thread Jonathan Corbet
No textual changes have been made, but the formatting has obviously been tweaked. Cc: Michal Marek <mma...@suse.com> Cc: Gilles Muller <gilles.mul...@lip6.fr> Cc: Nicolas Palix <nicolas.pa...@imag.fr> Cc: Julia Lawall <julia.law...@lip6.fr> Signed-off-by: Jonatha

[PATCH 06/10] docs: sphinxify kasan.txt and move to dev-tools

2016-08-08 Thread Jonathan Corbet
No textual changes beyond formatting. Cc: Andrey Ryabinin <aryabi...@virtuozzo.com> Cc: Alexander Potapenko <gli...@google.com> Cc: Dmitry Vyukov <dvyu...@google.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/d

[PATCH 05/10] docs: sphinixfy gcov.txt and move to dev-tools

2016-08-08 Thread Jonathan Corbet
No textual changes beyond formatting. Cc: Peter Oberparleiter <ober...@linux.vnet.ibm.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/dev-tools/gcov.rst | 256 + Documentation/dev-tools/tools.rst | 1 + Documentat

[PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents

2016-08-08 Thread Jonathan Corbet
<gli...@google.com> Cc: Dmitry Vyukov <dvyu...@google.com> Cc: Michal Marek <mma...@suse.com> Cc: Gilles Muller <gilles.mul...@lip6.fr> Cc: Nicolas Palix <nicolas.pa...@imag.fr> Cc: Julia Lawall <julia.law...@lip6.fr> Cc: Jani Nikula <jani.nik...@intel.com>

[PULL] Docs fixes

2016-08-05 Thread Jonathan Corbet
A handful of documentation fixes. You'll get a conflict on Documentation/DocBook/Makefile due to the changes from the drm and media trees. Resolution is pretty easy - just take the docs-next side - but I also have a resolution in the docs-next-merge branch if that's useful to you. Thanks, jon

Re: [PATCH] DocBook: use DOCBOOKS="" to ignore DocBooks instead of IGNORE_DOCBOOKS=1

2016-08-04 Thread Jonathan Corbet
On Thu, 4 Aug 2016 11:48:26 +0300 Jani Nikula wrote: > Instead of a separate ignore flag, use the obvious DOCBOOKS="" to ignore > all DocBook files. Makes sense, applied. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of

Re: [PATCH 1/1] Documenation: update cgroup's document path

2016-08-03 Thread Jonathan Corbet
On Tue, 2 Aug 2016 23:23:57 +0900 "seokhoon.yoon" wrote: > cgroup's document path is changed to "cgroup-v1". update it. Seems worthy to me, applied to the docs tree. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a

Re: [PATCH] doc-rst: Remove the media docbook

2016-08-01 Thread Jonathan Corbet
On Mon, 1 Aug 2016 08:19:14 -0300 Mauro Carvalho Chehab wrote: > My general impression is that it is now a way easier to maintain the > media documentation and make it more consistent than with DocBook. Music to my ears - maybe this whole thing was worth it :)

Re: [PATCH] doc-rst: Remove the media docbook

2016-07-27 Thread Jonathan Corbet
On Wed, 27 Jul 2016 06:32:31 -0300 Mauro Carvalho Chehab wrote: > This patch should be applied after Linus handle my media documentation > pull request. Do you prefer to send the patch yourself, or if I do it? If you want it to go up for 4.8, just go ahead and send it

Re: Visualizing linux kernel datastructures

2016-07-25 Thread Jonathan Corbet
On Mon, 25 Jul 2016 16:56:46 +0200 Charlemagne Lasse wrote: > So my questions would be: > > 1. is there a standard (machine readable?) how to correctly document > (kernel-doc?) in the code if a struct list_head is the head/root of a > list or the anchor of the item

[PULL] Documentation for 4.8

2016-07-25 Thread Jonathan Corbet
Martinez Canillas (1): Documentation: Fix some grammar mistakes in sync_file.txt Jerome Marchand (1): Documentation: add watermark_scale_factor to the list of vm systcl file Jonathan Corbet (7): sphinx: cheesy script to convert .tmpl files Merge branch 'sphinx-for-docs-next' into doc/4.8

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

2016-07-22 Thread Jonathan Corbet
On Fri, 22 Jul 2016 11:46:36 -0300 Mauro Carvalho Chehab wrote: > The RST cpp:function handler is very pedantic: it doesn't allow any > macros like __user on it: > [...] > So, we have to remove it from the function prototype. Sigh, this is the kind of thing where

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

2016-07-21 Thread Jonathan Corbet
On Thu, 21 Jul 2016 16:41:53 +0200 Markus Heiser <markus.hei...@darmarit.de> wrote: > Am 21.07.2016 um 01:28 schrieb Jonathan Corbet <cor...@lwn.net>: > > > I would hope that most people wouldn't have to worry about it, and would > > be able to just use what their

Re: [PATCH v5 2/2] Doc/memory-barriers: Add Korean translation

2016-07-21 Thread Jonathan Corbet
On Thu, 21 Jul 2016 07:23:46 -0700 "Paul E. McKenney" <paul...@linux.vnet.ibm.com> wrote: > If Minchan is OK with this version, if Ingo and Jon have no objections, > and given the small change below, I will take it. None here. Acked-by: Jonathan Corbet <cor...@lwn.ne

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

2016-07-20 Thread Jonathan Corbet
On Wed, 20 Jul 2016 08:07:54 +0200 Markus Heiser wrote: > Jon, what do you think ... could we serve this 1.2 doc > on https://www.kernel.org/doc/ as reference? Seems like a good idea. I don't really know who controls that directory, though; I can ping Konstantin and

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

2016-07-20 Thread Jonathan Corbet
On Wed, 20 Jul 2016 12:38:58 +0200 Markus Heiser wrote: > Add a reporter replacement that assigns the correct source name and line > number to a system message, as recorded in a ViewList. This is clearly a worthwhile fix, and I've applied it. A couple of little

Re: [PATCH] docs: Remove kernel-doc-nano-HOWTO.txt

2016-07-20 Thread Jonathan Corbet
" that kernel-doc-nano-HOWTO.txt is there, and various other docs had pointers to it. So I've just committed this instead, hope it's OK... jon --- >From 8ed292fe864e9ed7d335515e97590122a56d7cba Mon Sep 17 00:00:00 2001 From: Jonathan Corbet <cor...@lwn.net> Date: Wed, 20 Jul 2016

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

2016-07-20 Thread Jonathan Corbet
On Wed, 20 Jul 2016 16:23:28 +0200 Markus Heiser wrote: > Am 20.07.2016 um 16:11 schrieb Mauro Carvalho Chehab > : > > > Sphinx 1.4.5 complains about some literal blocks at > > kernel-documentation.rst: > > > >

Re: Troubles with kernel-doc and RST files

2016-07-19 Thread Jonathan Corbet
On Sun, 17 Jul 2016 10:01:54 -0300 Mauro Carvalho Chehab wrote: > 4) There are now several errors when parsing functions. Those seems to > happen when an argument is a function pointer, like: > > /devel/v4l/patchwork/Documentation/media/kapi/v4l2-core.rst:757: WARNING:

Re: Troubles with kernel-doc and RST files

2016-07-19 Thread Jonathan Corbet
On Sun, 17 Jul 2016 10:01:54 -0300 Mauro Carvalho Chehab wrote: > 2) For functions, kernel-doc is now an all or nothing. If not all > functions are declared, it outputs this warning: > > ./include/media/media-devnode.h:1: warning: no structured comments > > And

Re: Troubles with kernel-doc and RST files

2016-07-19 Thread Jonathan Corbet
On Tue, 19 Jul 2016 12:00:24 +0200 Markus Heiser wrote: > I recommend to consider to switch to the python version of the parser. > I know, that there is a natural shyness about a reimplementation in python > and thats why I offer to support it for a long time period ..

Re: [PATCH v4] Documentation: Move samples from doc to samples/

2016-07-19 Thread Jonathan Corbet
On Mon, 18 Jul 2016 15:55:00 -0400 Mahesh Khanwalkar wrote: > Moved sample code found in Documentation/ to samples/ but kept actual > documentation where it is, while updating any in-text references to the > moved code. Updated the Documentation/Makefile and

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

2016-07-19 Thread Jonathan Corbet
On Tue, 19 Jul 2016 13:42:54 +0200 Daniel Vetter wrote: > Unfortunately warnings generated after parsing in sphinx can end up > with entirely bogus files and line numbers as sources. Strangely for > outright errors this is not a problem. Trying to convert warnings to >

Re: [PATCH] Documentation: add watermark_scale_factor to the list of vm systcl file

2016-07-18 Thread Jonathan Corbet
On Tue, 12 Jul 2016 12:05:59 +0200 "Jerome Marchand" wrote: > Commit 795ae7a0de6b ("mm: scale kswapd watermarks in proportion to > memory") properly added the description of the new knob to > Documentation/sysctl/vm.txt, but forgot to add it to the list of files > in

Re: [PATCH] kernel-doc: Fix up warning output

2016-07-17 Thread Jonathan Corbet
On Fri, 15 Jul 2016 10:19:30 +0200 Daniel Vetter wrote: > While trying to make gpu docs warning free I stumbled over one output > which wasn't following proper compiler error output standards. Fix it > up for more quickfix awesomeness. Applied to the docs tree -

Re: Troubles with kernel-doc and RST files

2016-07-17 Thread Jonathan Corbet
[Back home and trying to get going on stuff for real. I'll look at the issues listed in this message one at a time.] On Sun, 17 Jul 2016 10:01:54 -0300 Mauro Carvalho Chehab wrote: > 1) We now need to include each header file with documentation twice, > one to get the

[PATCH] docs: Get rid of some kernel-documentation warnings

2016-07-17 Thread Jonathan Corbet
Sphinx wants to interpret all literal blocks as being in the chosen language and complains when an attempt to parse a block fails. kernel-documentation.rst has a few blocks that are not in C; make that explicit to shut down the associated warnings. Signed-off-by: Jonathan Corbet <cor...@lwn.

Re: Update the maximum depth of C-state from 6 to 9

2016-07-10 Thread Jonathan Corbet
On Mon, 4 Jul 2016 09:55:10 +0800 "baolex.ni" wrote: > Currently, CPUIDLE_STATE_MAX has been defined as 10 in the cpuidle head file, > and max_cstate = CPUIDLE_STATE_MAX – 1, so 9 is the right maximum depth of > C-state. > This change is reflected in one place of the

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

2016-07-09 Thread Jonathan Corbet
On Tue, 5 Jul 2016 14:55:09 -0300 Mauro Carvalho Chehab wrote: > I hope you don't mind. I'm merging those three patches on my tree > (for now, they're on an experimental tree that I can easily rebase, if > needed). If OK for you, my plan is to merge it on a separate

Re: [PATCH v2] doc-rst: add an option to ignore DocBooks when generating docs

2016-07-09 Thread Jonathan Corbet
On Sat, 9 Jul 2016 13:12:45 -0300 Mauro Carvalho Chehab wrote: > Sometimes, we want to do a partial build, instead of building > everything. However, right now, if one wants to build just > Sphinx books, it will build also the DocBooks. > > Add an option to allow to

Re: [PATCH] doc: flat-table directive

2016-06-30 Thread Jonathan Corbet
On Thu, 30 Jun 2016 14:00:21 +0200 Markus Heiser wrote: > this is my flat-table patch on top of your docs-next branch / we discussed on > the ML Hmm... we don't have an official kernel coding style for Python, but if we did, I'd sure like it to be a lot more like the

Re: [PATCH] [linux-next] Doc: PM: Fix a typo in intel_powerclamp.txt

2016-06-30 Thread Jonathan Corbet
On Wed, 29 Jun 2016 18:05:56 +0900 Masanari Iida wrote: > This patch fix a spelling typo in intel_powerclamp.txt Applied to the docs tree, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

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

2016-06-29 Thread Jonathan Corbet
On Wed, 29 Jun 2016 19:35:46 +0200 Markus Heiser wrote: > > I would love it if you would take the flat-table and man-page work, > > separate them out, and make them work with the *existing* Sphinx-based > > scheme. If you can do it soon, we can maybe get it into 4.8.

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

2016-06-29 Thread Jonathan Corbet
Hi, Markus, I was glad to hear from you, but I have to agree with Jani: this is not how things are done. Consider this one line: > 706 files changed, 123369 insertions(+), 752 deletions(-) Something like that will be a huge red flag to any kernel maintainer! In the kernel community, we have

Re: [PATCH] Documentation: tiny typo fix in usb/gadget_multi.txt

2016-06-23 Thread Jonathan Corbet
On Sat, 11 Jun 2016 02:56:37 +0200 Michal Nazarewicz wrote: > -For the gadget two work under Windows two conditions have to be met: > +For the gadget to work under Windows two conditions have to be met: Applied to the docs tree, thanks. jon -- To unsubscribe from this list:

Re: [PATCH] Documentation: fix wrong value in md.txt

2016-06-23 Thread Jonathan Corbet
On Fri, 17 Jun 2016 09:40:02 +0800 (CST) "Tiezhu Yang" wrote: > I read drivers/md/raid5.c and find the following related code: > 1) in function 'raid5_set_cache_size': > if (size <= 16 || size > 32768) > return -EINVAL; > 2) #define NR_STRIPES 256 > > So the

Re: [docs-next PATCH v2 00/11] Documentation/sphinx follow-up, again

2016-06-23 Thread Jonathan Corbet
On Thu, 23 Jun 2016 15:28:00 +0300 Jani Nikula wrote: > The first 9 patches are just a resend of [1], there's two patches on top > here. OK, these all look good to me. Applied to the docs tree, sorry for the delay. jon -- To unsubscribe from this list: send the line

Re: [PATCH v2 00/38] Documentation/sphinx

2016-06-14 Thread Jonathan Corbet
On Tue, 14 Jun 2016 10:15:00 +0200 Daniel Vetter wrote: > Hi Jon, > > On Fri, Jun 10, 2016 at 10:41 PM, Dave Airlie wrote: > > > It would be best if Jon can give us a known tag that won't get rebased, > > and will end up in docs-next and drm-next,

Re: [PATCH v2 00/38] Documentation/sphinx

2016-06-09 Thread Jonathan Corbet
On Sat, 4 Jun 2016 14:37:01 +0300 Jani Nikula wrote: > When this lands in docs-next and we can backmerge to drm, we'll plunge > ahead and convert gpu.tmpl to rst, and have that ready for v4.8. That is now done — thanks for running with this! I'm looking forward to

Re: [PATCH] docs: fix "interruptible" misspellings

2016-06-09 Thread Jonathan Corbet
On Wed, 18 May 2016 06:55:45 -0700 Kees Cook wrote: > A common misspelling of "interruptible" is "interruptable". This fixes > them in the tree and adds the two most common variations to spelling.txt. > > Suggested-by: Randy Dunlap > Signed-off-by:

Re: [PATCH] docs: self-protection: rename "leak" to "exposure"

2016-06-09 Thread Jonathan Corbet
On Wed, 18 May 2016 06:37:47 -0700 Kees Cook wrote: > The meaning of "leak" can be both "untracked resource allocation" and > "memory content disclosure". This document's use was entirely of the > latter meaning, so avoid the confusion by using the Common Weakness >

Re: [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few

2016-06-09 Thread Jonathan Corbet
On Sat, 4 Jun 2016 14:37:30 +0300 Jani Nikula wrote: > kernel-doc currently identifies anything matching "section header:" > (specifically a string of word characters and spaces followed by a > colon) as a new section in the documentation comment, and renders the >

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

2016-06-08 Thread Jonathan Corbet
So I've finally gotten a chance to make another pass over this stuff. Markus, your enthusiasm is great; I'm hoping you'll do great things helping us to improve the kernel's documentation toolchain. But please, at this point, let's build on Jani's work and go from there. Things have waited for

Re: [PATCH 00/10] Documentation/Sphinx

2016-06-03 Thread Jonathan Corbet
On Mon, 30 May 2016 23:05:34 +0300 Jani Nikula wrote: > To be clear, the "sphinx-for-docs-next" branch of [1], [2] is what I > propose to merge at this time. There's the Sphinx configuration, kernel > build integration, Sphinx kernel-doc extension, tons of kernel-doc >

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

2016-06-03 Thread Jonathan Corbet
On Mon, 30 May 2016 23:05:34 +0300 Jani Nikula wrote: > > I can't recommend to use rst2pdf (it is less maintained), use default > > sphinx LaTeX toolchain. > > I think we'll use whatever works, rst2pdf seemed to work for now, but we > can change if needed. I really

Re: [PATCH 00/10] Documentation/Sphinx

2016-05-31 Thread Jonathan Corbet
On Mon, 30 May 2016 11:10:26 +0200 Daniel Vetter wrote: > I think next steps is to get this merged into docs-next, with a stable > tag, so that I can pull it into drm-misc. So, I want to take another look at this, which probably will need another day or two before it can

Re: [PULL v4.6-rc1] bcache: documentation updates

2016-05-31 Thread Jonathan Corbet
On Mon, 30 May 2016 07:43:09 -0700 Marc MERLIN wrote: > > There is a bcache documentation update available: > > > > > > git pull https://bitbucket.org/ewheelerinc/linux > > > > v4.6-rc1-bcache-documentation > > > > Is this the right list to submit such documentation? >

Re: [PATCH v2] doc: clarify that trace_events= takes a comma-separated list

2016-05-23 Thread Jonathan Corbet
On Mon, 23 May 2016 16:54:51 -0400 Steven Rostedt wrote: > This version looks good to me. Jonathan, you want to take this patch? Sure, I'll take it. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH 0038/1529] Fix typo

2016-05-21 Thread Jonathan Corbet
Did you really just broadcast out 1,500 patches? I appreciate you're trying to help, but it's not really going to be possible for anybody to take a serious look at something like this. Especially since... On Sat, 21 May 2016 13:40:47 +0200 Andrea Gelmini wrote: >

Re: [PATCH -trivial 1/3] Documentation: vm: Spelling s/paltform/platform/g

2016-05-14 Thread Jonathan Corbet
On Tue, 10 May 2016 20:59:56 +0200 Geert Uytterhoeven wrote: > diff --git a/Documentation/vm/hugetlbpage.txt > b/Documentation/vm/hugetlbpage.txt > index 54dd9b9c6c31aeed..6f3b3fa35613d900 100644 > --- a/Documentation/vm/hugetlbpage.txt > +++

Re: [PATCH] Documentation/memcg: update kmem limit doc as codes behavior

2016-05-14 Thread Jonathan Corbet
On Wed, 11 May 2016 14:07:31 +0800 Qiang Huang wrote: > The restriction of kmem setting is not there anymore because the > accounting is enabled by default even in the cgroup v1 - see > b313aeee2509 ("mm: memcontrol: enable kmem accounting for all > cgroups in the legacy

Re: [PATCH 0/9] kernel-doc/docproc prep work for reStructuredText

2016-05-14 Thread Jonathan Corbet
On Thu, 12 May 2016 16:15:35 +0300 Jani Nikula wrote: > Jon, I was hoping we could consider nudging things forward a bit in the > kernel-doc and docproc reStructuredText front already in 4.7. I know > it's a bit close to the merge window, but this should not interfere with

Re: Kernel docs: muddying the waters a bit

2016-05-05 Thread Jonathan Corbet
On Wed, 4 May 2016 14:57:38 -0300 Mauro Carvalho Chehab wrote: > Also, media documentation is not just one more documentation. It is > the biggest one we have, and that has more changes than any other > documentation under Documentation/DocBook: > > $ git lg --since

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 4 May 2016 13:50:35 -0300 Mauro Carvalho Chehab wrote: > Em Wed, 4 May 2016 19:13:21 +0300 > Jani Nikula escreveu: > > I think we should go for vanilla sphinx at first, to make the setup step > > as easy as possible for everyone. > >

Re: Kernel docs: muddying the waters a bit

2016-05-04 Thread Jonathan Corbet
On Wed, 4 May 2016 16:18:27 +0200 Daniel Vetter wrote: > > I'd really like to converge on the markup question, so that we can start > > using all the cool stuff with impunity in gpu documentations. > > Aside: If we decide this now I could send in a pull request for the

Re: [PATCH] Changed the path from to the incorrect drivers/char/sysrq.c to drivers/tty/sysrq.c

2016-04-28 Thread Jonathan Corbet
On Thu, 28 Apr 2016 10:15:24 +0200 René Nyffenegger wrote: > You're right, the lines were wrapped at character 78. I have fixed that > and sent the patch to myself. The attached patch should work now. The patch applies, but the above text is not a proper commit message,

Re: [PATCH v2] Documentation: fix common spelling mistakes

2016-04-28 Thread Jonathan Corbet
On Tue, 26 Apr 2016 16:41:21 -0700 Kees Cook wrote: > This fixes several spelling mistakes in the Documentation/ tree, which > are caught by checkpatch.pl's spell checking. I've applied this to the docs tree, thanks. jon -- To unsubscribe from this list: send the line

Re: [PATCH 39/41] Documentation: vm: fix spelling mistakes

2016-04-28 Thread Jonathan Corbet
On Thu, 28 Apr 2016 07:31:43 -0600 Jonathan Corbet <cor...@lwn.net> wrote: > On Mon, 25 Apr 2016 07:37:05 +0100 > Eric Engestrom <e...@engestrom.ch> wrote: > > > Documentation/vm/transhuge.txt | 6 +++--- > > 1 file changed, 3 insertions(+), 3 deletions(-

<    2   3   4   5   6   7   8   >