Re: Including images on Sphinx documents

2016-11-13 Thread Jonathan Corbet
On Mon, 7 Nov 2016 07:55:24 -0200 Mauro Carvalho Chehab wrote: > So, we have a few alternatives: > > 1) copy (or symlink) all rst files to Documentation/output (or to the >build dir specified via O= directive) and generate the *.pdf there, >and produce those

Re: [PATCH v2.1 0/6] Fix PDF builds on media documentation

2016-11-13 Thread Jonathan Corbet
On Tue, 8 Nov 2016 07:55:41 -0200 Mauro Carvalho Chehab wrote: > This series address a series of errors during PDF generation from > media documentation. > > It replaces the previous patch series entitled: > [PATCH RFC 0/4] Fix PDF build errors So I'm finally

Re: [PATCH 0/3] Add howto.rst Korean translation into build system

2016-11-13 Thread Jonathan Corbet
On Tue, 8 Nov 2016 21:26:06 +0900 SeongJae Park wrote: > This patchset does > - fix trivial document build warnings, That one fixes warnings in linux-next at the cost of adding them to docs-next. Oh well, it'll all sort out in the merge window, I guess. > - move

Re: [PATCH] Change the document about iowait

2016-11-13 Thread Jonathan Corbet
On Wed, 26 Oct 2016 10:41:28 +0800 Chao Fan wrote: > The iowait is not reliable by reading from /proc/stat, so this > method to get iowait is not suggested. And we mark it in the > document. Sorry for the delay on this. Life has been...challenging... > Signed-off-by:

Re: [PATCH v9 7/8] thunderbolt: Networking doc

2016-11-10 Thread Jonathan Corbet
On Wed, 9 Nov 2016 17:00:02 +0100 Greg KH wrote: > > Documentation/00-INDEX | 2 + > > Documentation/thunderbolt/networking.txt | 132 > > +++ > > Note, new files should be in .rst format, and live in the new >

Re: [PATCH] USB: fix typo in documentation

2016-11-07 Thread Jonathan Corbet
On Tue, 1 Nov 2016 15:23:37 + Luis de Bethencourt wrote: > A typo sneaked in the latest change on the USB documentation. Fixing it > and also a trailing whitespace since it is also in the "USB Host-Side API > Model" chapter. Applied to the docs tree (with

Re: [PATCH v2] doc-rst: make cleandocs misses a fair number of files

2016-11-07 Thread Jonathan Corbet
On Tue, 1 Nov 2016 15:36:02 +0100 Markus Heiser wrote: > Removes intermediate 'Documentation/DocBook/.*.xml.cmd' files > > Changes since v1: > - Reduce the patch to DocBook cleandocs > > References: >

Re: [PATCH 2/4] doc-rst: admin-guide: move bug bisect to a separate file

2016-11-07 Thread Jonathan Corbet
On Mon, 7 Nov 2016 23:13:03 -0200 Mauro Carvalho Chehab wrote: > Argh! PDF output is really fragile. I would change it then to: > > .. [#f1] You can, optionally, provide both good and bad arguments at git >start: ``git bisect start [BAD] [GOOD]`` > > Do you

Re: [PATCH 2/4] doc-rst: admin-guide: move bug bisect to a separate file

2016-11-07 Thread Jonathan Corbet
On Mon, 7 Nov 2016 17:03:17 -0200 Mauro Carvalho Chehab wrote: > +.. [#f1] You can, optionally, provide both good and bad arguments at git > + start:: > + > + git bisect start [BAD] [GOOD] So this, as it turns out, kills the PDF build: Markup is

Re: [PATCH v2 00/12] Fix and update HOWTO Korean translation

2016-11-07 Thread Jonathan Corbet
On Tue, 1 Nov 2016 05:27:09 +0900 SeongJae Park wrote: > This patchset applies ReST conversion effort for HOWTO document to its Korean > translation. It also contains fixup of trivial nitpicks in the document and > the translation. OK, to the extent that I can understand

Re: [PATCH 2/4] doc-rst: admin-guide: move bug bisect to a separate file

2016-11-07 Thread Jonathan Corbet
On Mon, 7 Nov 2016 17:03:17 -0200 Mauro Carvalho Chehab wrote: > Better organize the admin guide documentation by moving the > bug bisect to a separate file. > > Signed-off-by: Mauro Carvalho Chehab > --- >

Re: [PATCH 3/3] tpm: move documentation under Documentation/security

2016-11-07 Thread Jonathan Corbet
On Thu, 3 Nov 2016 17:57:52 -0600 Jarkko Sakkinen wrote: > In order too make Documentation root directory cleaner move the tpm > directory under Documentation/security. So I'll happily apply these to the docs tree, but... 1) It won't apply to current

Re: [PATCH v2 00/12] Fix and update HOWTO Korean translation

2016-11-06 Thread Jonathan Corbet
On Mon, 7 Nov 2016 03:21:32 +0900 SeongJae Park wrote: > May I ask some comments, please? Sorry, last week was the kernel summit and plumbers, so I'm behind on a lot of things. I'll get there. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in

Re: [PATCH] Documentation/sphinx: set literal block highlight language to none

2016-11-03 Thread Jonathan Corbet
On Thu, 3 Nov 2016 11:07:33 +0200 Jani Nikula wrote: > Set the default highlight language to "none", i.e. do not try to guess > the language and do automatic syntax highlighting on literal blocks. As you might guess, I'm totally in favor of this; I think it's the right

Re: make pdfdocs fails with v4.9-rc3

2016-10-31 Thread Jonathan Corbet
On Mon, 31 Oct 2016 11:51:20 -0700 Jim Davis wrote: > Running make pdfdocs on a Ubuntu 16.04 system fails with > > Makefile:58: recipe for target 'media.pdf' failed > make[2]: *** [media.pdf] Error 1 > Documentation/Makefile.sphinx:79: recipe for target 'pdfdocs' failed >

Re: [PATCH v5 0/4] workqueue documentation reformatted

2016-10-28 Thread Jonathan Corbet
On Fri, 28 Oct 2016 10:14:07 +0200 Silvio Fricke wrote: > > - Don't forget to adjust MAINTAINERS for the new location for the > > workqueue doc. > > The MAINTAINERS are already patched on P4. Should this get an own patch? No, you just need to throw something at me

Re: ABI conversion to ReST - Was: Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-28 Thread Jonathan Corbet
On Fri, 28 Oct 2016 11:07:15 +0200 Markus Heiser wrote: > My conclusion of this and other discussions on the linux-doc ML is; we > have the situation, where *old hats* want to stay with perl, since they > are productive with, while sphinx is in the python domain. And

Re: [PATCH] USB: update intro of documentation

2016-10-27 Thread Jonathan Corbet
On Mon, 24 Oct 2016 14:25:27 +0200 Greg KH wrote: > I don't have any objection to the changes, please take them through your > documentation tree: I have now done so. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message

Re: [PATCH v4 0/4] workqueue documentation reformatted

2016-10-27 Thread Jonathan Corbet
On Mon, 24 Oct 2016 20:04:00 +0200 Silvio Fricke wrote: > v3 -> v4: > * The outdated misc reference in D/index.rst was not removed > > v2 -> v3: > * Introduce a core-api folder > * move workqueue.rst to core-api > * reflect change in 00-index and workqueue.h OK, we're

Re: [PATCH v3 09/37] Documentation/BUG-HUNTING: convert to ReST markup

2016-10-27 Thread Jonathan Corbet
On Wed, 26 Oct 2016 21:14:00 -0200 Mauro Carvalho Chehab wrote: > On a very quick look on the document, it seems that the legacy info > there are at this section of the document: > > - Finding it the old way > > IMHO, we can strip that section completely. At

Re: Documentation/kernel-parameters.txt

2016-10-27 Thread Jonathan Corbet
On Mon, 17 Oct 2016 17:52:46 +0300 Jani Nikula wrote: > I was looking at Documentation/kernel-parameters.txt and figured that > has got to be constantly stale and incomplete. It's really data that > should be autogenerated. I don't think it should just be converted to >

Re: [PATCH 00/32] Create an User's manual and improve development-process book

2016-10-27 Thread Jonathan Corbet
On Thu, 27 Oct 2016 13:17:33 -0700 Andrew Morton wrote: > > This patch series continues the efforts of converting the Linux Kernel > > documentation to Sphinx. > > hm, renaming Documentation/kernel-parameters.txt in linux-next is going > to be a pain for the next

Re: [PATCH v2 0/4] doc-rst: make sub-folder buildable stand-alone

2016-10-26 Thread Jonathan Corbet
On Wed, 26 Oct 2016 08:23:13 +0200 Markus Heiser wrote: > This patch series continues [1] the efforts to build sub-folders of the > documentation stand-alone. As far as I can tell, this all works as advertised, so I've just applied the set. Thanks, jon -- To

[PATCH 02/11] docs: retitle the kernel-documentation.rst

2016-10-26 Thread Jonathan Corbet
Let's make the title of this document (which shows up in the top page) better describe its contents. Cc: Jani Nikula <jani.nik...@intel.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/kernel-documentation.rst | 6 +++--- 1 file changed, 3 insertions(+),

[PATCH 05/11] docs: Get rid of the "basic profiling" guide

2016-10-26 Thread Jonathan Corbet
The document has not been touched in over 11 years and doesn't reflect how profiling is done in the perf era. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/admin-guide/basic-profiling.rst | 68 --- Documentation/admin-guide/index.rst

[PATCH 09/11] docs: Collapse the process guide TOC

2016-10-26 Thread Jonathan Corbet
I believe this makes the page as a whole more approachable. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/process/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst

[PATCH 10/11] docs: add a warning to submitting-drivers.rst

2016-10-26 Thread Jonathan Corbet
This is crufty stuff and should maybe just be deleted, but I'm not quite ready to do that yet. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/process/submitting-drivers.rst | 8 1 file changed, 8 insertions(+) diff --git a/Documentation/process/submitting-drive

[PATCH 03/11] docs: Clean up and organize the admin guide a bit

2016-10-26 Thread Jonathan Corbet
early to do that. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/admin-guide/index.rst | 50 +++-- Documentation/admin-guide/kernel-parameters.rst | 4 +- Documentation/admin-guide/sysfs-rules.rst | 4 +- Documentation/admin-gui

[PATCH 07/11] docs: Apply some basic organization to the process guide

2016-10-26 Thread Jonathan Corbet
Put like documents together, with the essential ones at the top, and split the TOC into sections. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/process/changes.rst | 2 +- Documentation/process/index.rst | 37 - 2 files chang

[PATCH 08/11] docs: Tweak submitting-patches.rst formatting

2016-10-26 Thread Jonathan Corbet
The main goal here was to get the subsections to show in the TOC as they do for all the other documents. Also call out the DCO in the section title since it's important. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/process/submitting-patches.rst | 16 ++---

[PATCH 06/11] docs: Get rid of the "bug-hunting" guide

2016-10-26 Thread Jonathan Corbet
Larry McVoy's advice on how to manually bisect 1.3.x kernel bugs is of historical interest, but that's what the repository is for. It is not useful to users now. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/admin-guide/bug-hunting.rst

[PATCH 11/11] docs: Add a warning to applying-patches.rst

2016-10-26 Thread Jonathan Corbet
This is ancient stuff and we don't do things this way anymore. In the absence of simply deleting the document, at least add a warning to it. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/process/applying-patches.rst | 4 1 file changed, 4 insertions(+) diff

[PATCH 00/11] Organize and clean up the admin and process guides

2016-10-26 Thread Jonathan Corbet
more accessible. Hopefully none of this is too controversial. That's probably too much to hope for in the case of the deleted documents, though, since deleting anything seems to be an uphill battle. Jonathan Corbet (11): docs: Tweak the top-level Sphinx page docs: retitle the kernel

Re: [PATCH] Documentation: initrd: Remove trailing whitespace

2016-10-26 Thread Jonathan Corbet
On Wed, 26 Oct 2016 22:20:22 +0200 Igor Vuk wrote: > Trailing whitespace cleanup. > > Signed-off-by: Igor Vuk > --- > Documentation/initrd.txt | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) Unfortunately, this file has been converted

Re: [PATCH v3 00/37] Create an User's manual and improve development-process book

2016-10-25 Thread Jonathan Corbet
On Mon, 24 Oct 2016 09:00:09 -0200 Mauro Carvalho Chehab wrote: > This patch series continues the efforts of converting the Linux Kernel > documentation to Sphinx. > > It contains text to ReST conversion of several files under Documentation, > and a few ones under the

Re: [PATCH v3 32/37] docs-rst: add documents to development-process

2016-10-25 Thread Jonathan Corbet
On Mon, 24 Oct 2016 09:00:41 -0200 Mauro Carvalho Chehab wrote: > Add several documents to the development-process ReST book. > > As we don't want renames, use symlinks instead, keeping those > documents on their original place. This changelog looks like it got left

Re: [PATCH v3 24/37] Documentation/unicode.txt: convert it to ReST markup

2016-10-25 Thread Jonathan Corbet
[Adding Peter to CC] On Mon, 24 Oct 2016 09:00:33 -0200 Mauro Carvalho Chehab wrote: > Probably, unicode is something that we might remove from the > docs, as all modern systems support it. Yet, this chapter > is fun, as it mentions support for the Klington fictional >

Re: [PATCH v3 15/37] Documentation/md.txt: Convert to ReST markup

2016-10-25 Thread Jonathan Corbet
On Mon, 24 Oct 2016 09:00:24 -0200 Mauro Carvalho Chehab wrote: > - add a title for the document; > - convert some parameters to tables; > - use quote blocks where needed; > - use monotonic fonts for parameters; > - adjust whitespaces and blank lines; > - add it to the

Re: [PATCH v3 12/37] Documentation/initrd.txt: convert to ReST markup

2016-10-25 Thread Jonathan Corbet
On Mon, 24 Oct 2016 09:00:21 -0200 Mauro Carvalho Chehab wrote: > - use a quote blocks where needed; > - fix the chapter/section/subsection markups; > - use ``foo`` for monotonic; > - use .. note:: for /sbin/init file permissions; > - adjust whitespaces and blank lines;

Re: [PATCH v3 09/37] Documentation/BUG-HUNTING: convert to ReST markup

2016-10-25 Thread Jonathan Corbet
On Mon, 24 Oct 2016 09:00:18 -0200 Mauro Carvalho Chehab wrote: > - Add a document title and remove its own index; > - use monotonic fonts for paths; > - use quote blocks where needed; > - adjust/use spaces to properly format paragraphs; > - add it to the user book.

Re: [PATCH v3 05/37] Documentation/basic_profiling.rst: convert to ReST markup

2016-10-25 Thread Jonathan Corbet
On Mon, 24 Oct 2016 09:00:14 -0200 Mauro Carvalho Chehab wrote: > Convert it to ReST markup and add it to the user book: > > - Add a title to the document; > - touch spaces/new lines to fix Sphinx format; > - use ``foo`` for commands; > - use quote blocks where needed;

Re: [PATCH v3 04/37] Documentation/bad_memory.txt: convert it to ReST markup

2016-10-25 Thread Jonathan Corbet
On Mon, 24 Oct 2016 09:00:13 -0200 Mauro Carvalho Chehab wrote: > - promote the section level of the document name; > - add/remove spaces/new lines where needed to format the output; > - use quote blocks. > - add it to the user book. So this document is about the

Re: [PATCH] Documentation: cpu-hotplug: Fix typos

2016-10-25 Thread Jonathan Corbet
On Tue, 25 Oct 2016 21:00:31 +0200 Igor Vuk wrote: > Fix some minor spelling errors and capitalization issues. > > Signed-off-by: Igor Vuk > --- > Documentation/cpu-hotplug.txt | 32 > 1 file changed, 16 insertions(+),

Re: [PATCH] locking/Doc/ko_KR: Clarify limited control-dependency scope

2016-10-25 Thread Jonathan Corbet
On Fri, 21 Oct 2016 23:10:02 +0900 SeongJae Park wrote: > This commit applies upstream change, commit ebff09a6ff16 > ("locking/Documentation: Clarify limited control-dependency scope"), to > Korean translation. This has been applied to the docs tree. Thanks, jon -- To

Re: [PATCH v2 0/8] Conversion crypto API documentation to Sphinx

2016-10-23 Thread Jonathan Corbet
On Fri, 21 Oct 2016 04:53:45 +0200 Stephan Mueller wrote: > the attached patch set converts the existing crypto API documentation > from DocBook to Sphinx. This looks generally good to me - thanks for doing it! Is there any chance of running the Documentation/ parts

Re: [PATCH v2 3/3] Documentation/workqueue.txt: convert to ReST markup

2016-10-23 Thread Jonathan Corbet
On Wed, 19 Oct 2016 20:38:39 +0200 Silvio Fricke wrote: > This patch add a "misc" documentation section and add the workqueue Thanks for doing this; can I add a few comments? - Ccing the docs maintainer is considered good form with documentation patches :) That's

Re: [PATCH 0/4] reST-directive kernel-cmd / include contentent from scripts

2016-10-22 Thread Jonathan Corbet
On Sat, 22 Oct 2016 08:56:29 -0200 Mauro Carvalho Chehab wrote: > The security implications will be the same if either coded as an > "ioctl()" or as "syscall", the scripts should be audited. Actually, > if we force the need of a "syscall" for every such script, we have >

Re: [PATCH] vme: Convert documentation to reStructuredText, move under driver APIs

2016-10-21 Thread Jonathan Corbet
On Fri, 21 Oct 2016 22:15:27 +0100 Martyn Welch wrote: > Perform a relatively simple conversion of vme_api.txt to reStructuredText > and move under driver-api, which seems the most logical place for this > documentation. Makes sense to me, applied to the docs tree.

Re: [PATCH v2 3/3] doc: add documentation for uio-hv-generic

2016-10-21 Thread Jonathan Corbet
On Mon, 17 Oct 2016 12:33:19 -0700 Stephen Hemminger wrote: > From: Stephen Hemminger > > Update UIO documentation to include basic information about > uio_hv_generic. I've applied this to the docs tree, thanks. jon -- To unsubscribe from

Re: [PATCH] Documentation: DMA-API: Clarify semantics of dma_set_mask_and_coherent

2016-10-21 Thread Jonathan Corbet
cumentation to clarify that even though the call to > dma_set_mask_and_coherent succeeds, it may not be possible to use the > full addressing capability of the device. OK, so I guess I can buy this. But... > Signed-off-by: Punit Agrawal <punit.agra...@arm.com> > Cc: Jonathan Cor

Re: [PATCH] [linux-next] Doc: dm raid: Fix typo in dm-raid.txt

2016-10-21 Thread Jonathan Corbet
On Mon, 17 Oct 2016 21:17:10 +0900 Masanari Iida wrote: > This patch fix spelling typos in Documentation/device-mapper/dm-raid.txt. Applied to the docs tree, thanks. -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to

Re: [PATCH] Documentation/trace/uprobetracer.txt: fix incorrect examples

2016-10-21 Thread Jonathan Corbet
On Thu, 6 Oct 2016 09:52:12 +0200 Marcin Nowakowski wrote: > Current uprobetracer examples don't work as they use an incorrect syntax > - if no event name is specified then 'p/r' must not be followed by a > colon > - if no event name is specified then the default

Re: [PATCH 00/12] Fix and update HOWTO Korean translation

2016-10-21 Thread Jonathan Corbet
On Sat, 22 Oct 2016 00:19:45 +0900 SeongJae Park wrote: > This patchset applies ReST conversion effort for HOWTO document to its Korean > translation. It also contains fixup of trivial nitpicks in the document and > the translation. Thanks for doing these; let's definitely

Re: [PATCH] Documentation: usb: the dumb conversion to Sphinx

2016-10-20 Thread Jonathan Corbet
On Thu, 20 Oct 2016 18:22:28 +0200 Oliver Neukum wrote: > > Why does this not remove the .tmpl file? > > 1. We might want to keep it > 2. It is an operation beyond the scope of this patch. I have to disagree with this part; the last thing we want is two copies of the

Re: sequence diagrams in rst documentation

2016-10-18 Thread Jonathan Corbet
On Tue, 18 Oct 2016 13:43:41 +0200 Johannes Berg wrote: > > Example here: > > https://johannes.sipsolutions.net/files/80211/mac80211.html#connection-flow > > > > Coming back to this - sadly, it appears that this software (blockdiag, > seqdiag) is completely

Re: [PATCH 00/32] Create an User's manual and improve development-process book

2016-10-18 Thread Jonathan Corbet
On Tue, 18 Oct 2016 08:20:18 -0200 Mauro Carvalho Chehab wrote: > > While at it, how about unifying some of the FilenamesInCamelCase, > > filenames-with-hyphens, and filenames_with_underscores too...? To at > > least move things towards just one of them within one

Re: [PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl

2016-10-18 Thread Jonathan Corbet
On Tue, 18 Oct 2016 17:52:57 +0200 Markus Heiser wrote: > this is the DocBook to reST migration of the uio-howto.tmpl as ordered by > Stephen Hemminger [1]. Markus, slow down just a little bit, please. Let me get docs-next going for 4.9 (will happen once I get LWN

Renaming Documentation/ [was [PATCH 00/32] Create an User's manual and improve development-process book]

2016-10-18 Thread Jonathan Corbet
On Tue, 18 Oct 2016 06:30:48 +0200 Markus Heiser wrote: > One Silly request of mine: > > Is there a chance moving "./Documentation" to something shorter > like "./doc"? Even with "Text completion" (in Emacs [1]), IMO > "Documentation" is to long. I'd be entirely in

Re: [PATCH 00/32] Create an User's manual and improve development-process book

2016-10-17 Thread Jonathan Corbet
I've only been able to take a quick look at these - I'm buried fairly deep at the moment. A few superficial thoughts. On Mon, 17 Oct 2016 14:55:37 -0200 Mauro Carvalho Chehab wrote: > In my opinion, it would be better to move the converted files to be inside > a

[PULL] One more documentation change for 4.9

2016-10-14 Thread Jonathan Corbet
The following changes since commit 3c76ff4765fbd382c095acc37f87e136a8dfc73d: URL changed for Linux Foundation TAB (2016-10-01 00:57:13 -0600) are available in the git repository at: git://git.lwn.net/linux.git tags/docs-4.9-2 for you to fetch changes up to

Re: [PATCH] Documentation: MIPS supports HAVE_REGS_AND_STACK_ACCESS_API

2016-10-13 Thread Jonathan Corbet
On Thu, 13 Oct 2016 17:09:36 +0200 Ralf Baechle wrote: > Jonathan, you can funnel this through the MIPS tree if you're ok with that? > Just lemme know -- Ralf Through the MIPS tree is fine with me. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe

[PULL] Documentation for 4.9

2016-10-03 Thread Jonathan Corbet
media documentation from pdf generation Jean Delvare (1): CodingStyle: Clarify and complete chapter 7 Joe Perches (1): CodingStyle: Remove "Don't use C99-style comments" Jon Bailey (1): URL changed for Linux Foundation TAB Jonathan Corbet (22): Merge branc

Re: [PATCH] dax : Fix documentation with respect to struct pages

2016-10-01 Thread Jonathan Corbet
On Tue, 27 Sep 2016 10:52:48 -0600 Ross Zwisler wrote: > On Sun, Sep 25, 2016 at 07:18:37PM -0600, Stephen Bates wrote: > > The documentation for dax is not up to date with respect to the struct > > page support available in some of the device drivers that utilize >

Re: [RFC PATCH v3] docs-rst: user: add MAINTAINERS

2016-09-23 Thread Jonathan Corbet
On Fri, 23 Sep 2016 12:07:33 -0300 Mauro Carvalho Chehab wrote: > including MAINTAINERS using ReST is tricky, because all > maintainer's entries are like: So I'm generally in favor of moving things over to RST, but I have to ask: what's the payoff for doing that with

Re: [PATCH v2 0/3] Move runnable tools from Documentation to tools

2016-09-22 Thread Jonathan Corbet
tops/dslm, and pcmcia to tools. > > If v2 patches look good, and if I get an okay, I will try to get > these into 4.9-rc1 Acked-by: Jonathan Corbet <cor...@lwn.net> Though I still wonder if we really need to keep some of those tools... jon -- To unsubscribe from this list:

Re: [PATCH] docs-rst: add inter-document cross references

2016-09-21 Thread Jonathan Corbet
On Wed, 21 Sep 2016 08:51:05 -0300 Mauro Carvalho Chehab wrote: > Add cross references for the development process documents > that were converted to ReST: > Documentation/SubmitChecklist > Documentation/SubmittingDrivers >

Re: [PATCH] Documentation/email-clients.txt: convert it to ReST markup

2016-09-21 Thread Jonathan Corbet
On Wed, 21 Sep 2016 07:49:18 -0300 Mauro Carvalho Chehab wrote: > As this file is mentioned at the development-process/ book, > let's convert it to ReST markup. Applied, thanks. jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of

Re: [PATCH v2 0/4] Move runnable examples code from Documentation to samples

2016-09-21 Thread Jonathan Corbet
On Wed, 21 Sep 2016 13:47:29 -0600 Shuah Khan wrote: > Move runnable examples code from Documentation to samples. I moved > just the example code, and left documentation files as is. > > I dropped accounting, laptops, and pcmcia from this v2 series as per > the v1

Re: [PATCH v4 00/29] Create a book for Kernel development

2016-09-20 Thread Jonathan Corbet
On Mon, 19 Sep 2016 08:07:34 -0300 Mauro Carvalho Chehab wrote: > That's the 4th version of this series. It also contains a second patch series > with more ReST conversions and documentation improvements. > This patchset merges the content of a second patch series: > >

Re: [PATCH] [linux-next] Fix double word "the the" in Doc/filesystems

2016-09-20 Thread Jonathan Corbet
On Tue, 20 Sep 2016 12:49:59 +0900 Masanari Iida wrote: > This patch fix typos "the the" found in Documentation/filesystems. So this patch doesn't apply. > Signed-off-by: Masanari Iida > --- > Documentation/filesystems/autofs4-mount-control.txt |

Re: [PATCH v10 RESEND 0/3] Documentation: Add description of enable multi-cpus support for kdump

2016-09-20 Thread Jonathan Corbet
On Mon, 19 Sep 2016 13:59:46 +0800 Baoquan He wrote: > This is v10 post. In this patchset patch 1/3 is added to give more details > about nr_cpus and maxcpus in kernel-parameters.txt. This is suggested by > Jonathan since the description of them is unclear so that people can't

Re: [PATCH] Documentation: DMA-API-HOWTO: Fix a typo

2016-09-20 Thread Jonathan Corbet
On Tue, 20 Sep 2016 09:04:20 -0700 Andrey Smirnov wrote: > - if (dma_mapping_error(cp->dev, dma_handle)) { > + if (dma_mapping_error(cp->dev, mapping)) { Interesting, that has been wrong for the entire git era; another patch fixed that line a

Re: [PATCH v2 0/3] doc-rst:c-domain: fix some issues in the c-domain

2016-09-20 Thread Jonathan Corbet
On Tue, 20 Sep 2016 20:56:35 +0200 Markus Heiser wrote: > > I submitted one patch fixing it. Not sure if it got merged by Jon > > or not. > > Ups, I might have overseen this patch .. as Jon said, its hard to > follow you ;) > > I tested the above with Jon's

Re: [PATCH 6/8] samples: move pcmcia example code from Documentation

2016-09-19 Thread Jonathan Corbet
On Mon, 19 Sep 2016 08:47:37 -0600 Shuah Khan wrote: > Move pcmcia examples to samples and remove it from Documentation > Makefile. Create a new Makefile to build pcmcia. It can be built > from top level directory or from pcmcia directory: Does PCMCIA still exist/work?

Re: [PATCH 5/8] samples: move misc-devices/mei example code from Documentation

2016-09-19 Thread Jonathan Corbet
> level directory or from mei directory: This one still has a fair amount of code hiding in the .txt files, but that's a separate job. Acked-by: Jonathan Corbet <cor...@lwn.net> jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a mess

Re: [PATCH 4/8] samples: move mic/mpssd example code from Documentation

2016-09-19 Thread Jonathan Corbet
gt; > Run make -C samples/mic/mpssd or cd samples/mic/mpssd; make This one seems good as-is Acked-by: Jonathan Corbet <cor...@lwn.net> jon -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majo

Re: [PATCH 3/8] samples: move laptops example code from Documentation

2016-09-19 Thread Jonathan Corbet
On Mon, 19 Sep 2016 08:47:34 -0600 Shuah Khan wrote: > Move laptops examples to samples and remove it from Documentation > Makefile. Create a new Makefile to build laptops. It can be built > from top level directory or from laptops directory: This one might be better

Re: [PATCH 2/8] samples: move auxdisplay example code from Documentation

2016-09-19 Thread Jonathan Corbet
On Mon, 19 Sep 2016 08:47:33 -0600 Shuah Khan wrote: > Move auxdisplay examples to samples and remove it from Documentation > Makefile. Create a new Makefile to build auxdisplay. It can be built > from top level directory or from auxdisplay directory:

Re: [PATCH 1/8] samples: move accounting example code from Documentation

2016-09-19 Thread Jonathan Corbet
On Mon, 19 Sep 2016 08:47:32 -0600 Shuah Khan wrote: > Move accounting examples to samples and remove it from Documentation > Makefile. Create a new Makefile to build accounting. It can be built > from top level directory or from accounting directory: So I like the

Re: [PATCH v3 19/21] docs-rst: move HOWTO and mentioned documents to development-process/

2016-09-16 Thread Jonathan Corbet
On Wed, 14 Sep 2016 08:06:48 -0300 Mauro Carvalho Chehab wrote: > In preparation to add those files to the Sphinx build logic, > move them to development-process/ dir and rename their extension > to RST. And this is the crux of the matter, of course :) I'd like to see

Re: [PATCH v3 17/21] Documentation/SubmittingPatches: convert it to ReST markup

2016-09-16 Thread Jonathan Corbet
On Wed, 14 Sep 2016 08:06:46 -0300 Mauro Carvalho Chehab wrote: > If you do not have a repository with the current kernel source handy, use > git to obtain one. You'll want to start with the mainline repository, > which can be grabbed with: > > - git clone

Re: [PATCH v3 11/21] Documentation/kernel-docs.txt: convert it to ReST markup

2016-09-16 Thread Jonathan Corbet
On Wed, 14 Sep 2016 08:06:40 -0300 Mauro Carvalho Chehab wrote: > This one required lots of manual work, for it to be properly > displayed. And, honestly, I wonder if it was worth it. This document contains no entries for any recent documents, many of the links in it

Re: [PATCH v3 07/21] Documentation/CodingStyle: Convert to ReST markup

2016-09-16 Thread Jonathan Corbet
On Wed, 14 Sep 2016 08:06:36 -0300 Mauro Carvalho Chehab wrote: > - Fix all chapter identation; > - add c blocks where needed; Here is where I think we need a bit of a philosophical discussion... > - Chapter 1: Indentation > +Indentation > +---

Re: [PATCH v3 05/21] Documentation/applying-patches.txt: convert it to ReST markup

2016-09-16 Thread Jonathan Corbet
On Wed, 14 Sep 2016 08:06:34 -0300 Mauro Carvalho Chehab wrote: > - use the correct markup to identify each section; > > - Add some blank lines for Sphinx to properly interpret > the markups; > > - Remove a blank space on some paragraphs; > > - Fix the verbatim and

Re: [PATCH 00/17] Create a book for Kernel development

2016-09-16 Thread Jonathan Corbet
On Wed, 14 Sep 2016 07:52:53 -0300 Mauro Carvalho Chehab wrote: > Based on the few comments it got on LKML, it seems people are accepting > such renames. I suspect it just hasn't come to the attention of enough people yet. A quick grep through linux-kernel traffic

Re: [PATCH v2 0/3] doc-rst:c-domain: fix some issues in the c-domain

2016-09-16 Thread Jonathan Corbet
On Wed, 7 Sep 2016 09:12:55 +0200 Markus Heiser <markus.hei...@darmarit.de> wrote: > according to your remarks I fixed the first and second patch. The third patch > is > resend unchanged; OK, I've applied the first two, finally. > > Am 06.09.2016 um 14:28 schrieb

Re: [PATCH] docs/driver-model: fix typo

2016-09-16 Thread Jonathan Corbet
On Thu, 15 Sep 2016 22:49:53 +0200 Laurent Navet wrote: > No need to be be, just be should be sufficient. To be be, or not to be be? :) 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] DMA-API-HOWTO: is no more

2016-09-16 Thread Jonathan Corbet
On Sun, 11 Sep 2016 15:58:53 +0200 Christoph Hellwig wrote: > So don't mention it. 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 majord...@vger.kernel.org More majordomo info at

Re: [PATCH v2 0/6] Move runnable code (tests) from Documentation to selftests

2016-09-14 Thread Jonathan Corbet
On Tue, 13 Sep 2016 14:18:39 -0600 Shuah Khan <shua...@osg.samsung.com> wrote: > Move runnable code (tests) from Documentation to selftests and update > Makefiles to work under selftests. This all seems good to me. Acked-by: Jonathan Corbet <cor...@lwn.net> jon -- To unsubscr

Re: [PATCH 00/17] Create a book for Kernel development

2016-09-12 Thread Jonathan Corbet
On Mon, 12 Sep 2016 11:47:51 -0300 Mauro Carvalho Chehab wrote: > There are several documents related to Kernel development, where the > HOWTO working like an index to most of them. > > Convert the documents mentioned at HOWTO (including it) to ReST and add them > at

Re: [PATCH 0/9] Move runnable code (tests) from Documentation to selftests

2016-09-10 Thread Jonathan Corbet
On Fri, 9 Sep 2016 16:22:41 -0600 Shuah Khan wrote: > Move runnable code (tests) from Documentation to selftests and update > Makefiles to work under selftests. > > Jon Corbet and I discussed this in an email thread and as per that > discussion, this patch series moves

Re: [PATCH 00/47] Fix most of Sphinx warnings in nitpick mode

2016-09-08 Thread Jonathan Corbet
ee, including the two patches that touch at the parse-headers.pl > script, as, currently, the only user for it is media. I'm also OK if you > prefer > to merge patches 2 and 3 on your tree instead. Go ahead and keep them with the rest. Acked-by: Jonathan Corbet <cor...@lwn.net> jon --

Re: Source and Make files under Documentation directory

2016-09-08 Thread Jonathan Corbet
On Wed, 7 Sep 2016 18:11:59 -0600 Shuah Khan wrote: > I noticed there are several source files and Makefiles under the > Documentation directory. Some of them look very much like tests. > > If they are indeed tests, maybe it is worth while to move them to > selftests?

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

2016-09-06 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. Acked-by: Sebastian Reichel <s...@kernel.org> Signed-off-by: Jonathan Corbet <cor..

[PATCH 4/5] docs: split up serial-interfaces.rst

2016-09-06 Thread Jonathan Corbet
It never made sense to keep these documents together; move each into its own file. Drop the section numbering on hsi.txt on its way to its own file. Suggested-by: Sebastian Reichel <s...@kernel.org> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/driver

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

2016-09-06 Thread Jonathan Corbet
Perform a basic sphinx conversion of the device-drivers docbook and move it to its own directory. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/DocBook/Makefile| 2 +- Documentation/DocBook/device-drivers.tmpl | 521 Documentation/

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

2016-09-06 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. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/driver-api/basics.rst| 120 + Documen

[PATCH 5/5] docs: Don't format internal MPT docs

2016-09-06 Thread Jonathan Corbet
This is the driver API document, so the internal stuff is just noise here. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/driver-api/message-based.rst | 18 -- 1 file changed, 18 deletions(-) diff --git a/Documentation/driver-api/message-based.

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

2016-09-06 Thread Jonathan Corbet
On Tue, 23 Aug 2016 02:20:19 +0200 Sebastian Reichel wrote: > Thanks for doing this. I like the resulting HTML. I'm a bit confused > by the rendering of the struct sections, though. Initially I thought > the blue box with "struct xyz" is an empty table (= there are no >

Re: [PATCH] docs: make kernel-doc handle varargs properly

2016-09-06 Thread Jonathan Corbet
On Sat, 27 Aug 2016 11:43:18 +0300 Jani Nikula <jani.nik...@intel.com> wrote: > On Fri, 26 Aug 2016, Jonathan Corbet <cor...@lwn.net> wrote: > > As far as I can tell, the handling of "..." arguments has never worked > > right, so any documentation provi

<    1   2   3   4   5   6   7   8   >