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

On Mon, 20 Feb 2017 12:19:24 -0700 Jim Davis wrote: > pdfdocs (Sphinx or DocBook) has been broken for some time, while > psdocs hasn't worked in ages. The errors with the Sphinx htmldocs and > epubdocs targets seem to be some Python issue: pdfdocs works for me. With

Re: [PATCH 0/2] PM / docs: Fixes for PM and device links driver-api

On Mon, 20 Feb 2017 15:23:29 +0100 "Rafael J. Wysocki" wrote: > These two patches fix references to struct data types in two documents that > did those things more or less incorrectly. > > Both of them fix existing commits, one in the mainline and one in your tree. I've

Re: [PATCH] lib/Kconfig.debug: correct documentation paths

On Fri, 24 Feb 2017 10:36:20 +0200 Krzysztof Kozlowski wrote: > What happened with this patch? I am asking because on top of > next-20170224 I found some more sysrq.txt obsolete paths... including > the ones fixed here. I am not sure whether I am fixing something > already

[PULL] Documentation for 4.11

on (1): docs: IIO documentation sphinx conversion Jonathan Corbet (5): docs: Convert the deviceio template to RST docs: Convert the regulator docbook to RST Merge branch 'ben' into docs-next docs: Fix a warning in the Korean HOWTO.rst translation docs: Remove the copy

Re: [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks

On Mon, 23 Jan 2017 08:34:58 -0200 Mauro Carvalho Chehab wrote: > The main difference between a "pointer file" and a symlink is that the > first indicates a temporary solution, teaching people that the > file got renamed and were it is located now. As such, we can

Re: [PATCH 2/2] Documentation: DMA-ISA-LPC.txt

On Thu, 9 Feb 2017 18:36:36 -0500 Nathan Howard wrote: > Fixed spelling issue. > > Signed-off-by: Nathan Howard > --- > Documentation/DMA-ISA-LPC.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git

Re: [PATCH] Documentation: input: fix path to input code definitions

On Thu, 9 Feb 2017 07:53:29 +0100 Martin Kepplinger wrote: > Signed-off-by: Martin Kepplinger > --- > Documentation/input/input.txt | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/input/input.txt

Re: [PATCH] Documentation: make Makefile.sphinx no-ops quieter

On Fri, 10 Feb 2017 17:06:50 -0700 Jim Davis wrote: > Silence the "make[1]: Nothing to be done for ..." messages for the > no-op targets in Makefile.sphinx. Applied, thanks. jon

Re: [PATCH] Documentation: DocBook/Makefile comment typo

On Mon, 13 Feb 2017 17:02:57 -0700 Jim Davis wrote: > Fix a se for so typo. That typo has been there for almost 11 years; I guess nobody read that far until now :) Applied, thanks. jon

Re: [PATCH] Documentation: Fix linux-api list typo

On Tue, 14 Feb 2017 04:04:17 + Tyler Hicks wrote: > A Japanese translation file contained the incorrect email address for > the linux-api list. Even those of us who don't read Japanese should have noticed that one. Applied, thanks. jon

Re: [PATCH] Documentation: rs485: Do not define manually the ioctl

On Thu, 18 Aug 2016 10:54:19 +0200 Ricardo Ribalda Delgado wrote: > It is not a very good practice to define the IOCTL manually instead of > using the header file. > > Fix it on the documentation example. Makes sense to me; applied to the docs tree, thanks. jon

[PULL] Docs fixes

: 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: [PATCH] mm, kasan: Update kasan docs to indicate arm64 support

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

Re: linux-next: manual merge of the jc_docs tree with the drm-misc tree

On Fri, 19 Aug 2016 11:52:15 +1000 Stephen Rothwell wrote: > Today's linux-next merge of the jc_docs tree got a conflict in: > > Documentation/gpu/index.rst > > between commit: > > b754b35b089d ("vgaarbiter: rst-ifiy and polish kerneldoc") > > from the drm-misc

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

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

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

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

On Thu, 18 Aug 2016 11:11:46 +0800 Zhou Wenjian wrote: Thank you for working to improve the documentation! > * We generally don' have to bring up a SMP kernel just to capture the >dump. Hence generally it is useful either to build a UP dump-capture >kernel

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

On Fri, 19 Aug 2016 08:33:21 +0800 "Zhou, Wenjian/周文剑" wrote: > I was also confused by maxcpus and nr_cpus before writing this patch. > I think it is a good choice to describe it in kernel-parameters.txt. > > Then, only two things need to be done I think. > One is

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

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

[PULL] Docs fixes

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 2/3] docs: split up the driver book

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] docs: make kernel-doc handle varargs properly

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

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

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] doc: ioctl: Add some clarifications to botching-up-ioctls

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 1/3] documentation/scsi: Remove nodisconnect parameter

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 >

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

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.

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

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 2/5] docs: split up the driver book

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 0/5 V2] The beginning of a proper driver-api book

comments - Hopefully this is about ready to go... Cc: Sebastian Reichel <s...@kernel.org> Jonathan Corbet (5): Docs: sphinxify device-drivers.tmpl docs: split up the driver book docs: Pull the HSI documentation together docs: split up serial-interfaces.rst docs: Don't format i

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

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 >

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

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 1/5] Docs: sphinxify device-drivers.tmpl

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/

Re: [PATCH v5 2/3] Documentation/filesystems: Fixed typo

On Wed, 7 Sep 2016 20:22:00 -0400 Robert Foss wrote: > > This could be taken directly into the docs tree, I think -- no reason > > to make it depend on the rest of the series. > > Agreed. Would you like a separate submission for that? Please, I've lost track of the

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

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

Re: rfc: Updating SubmittingPatches with [RFC PATCH] and/or [WIP PATCH]

On Wed, 07 Sep 2016 12:47:41 -0700 Joe Perches wrote: > +If the patch or patch series is just a proposal to garner comments > +use [RFC PATCH] before each patch subject. > + > +If the patch or patch seriies is incomplete or possibly contains known > +defects and you would like

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

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 v2 0/4] Move runnable examples code from Documentation to samples

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 v3 11/21] Documentation/kernel-docs.txt: convert it to ReST markup

On Fri, 16 Sep 2016 17:42:19 -0300 Mauro Carvalho Chehab wrote: > > many of the links in it are long since > > dead, and I honestly doubt it has been helpful to anybody. > > I tested: all links there point to an existing documentation. Really? URL:

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

> 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

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

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

Re: [PATCH 7/8] samples: move timers example code from Documentation

timers/hpet.txt needs updating. Otherwise Acked-by: Jonathan Corbet <cor...@lwn.net> jon

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

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 6/8] samples: move pcmcia example code from Documentation

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 1/8] samples: move accounting example code from Documentation

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 3/8] samples: move laptops example code from Documentation

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 8/8] samples: move watchdog example code from Documentation

On Mon, 19 Sep 2016 08:47:39 -0600 Shuah Khan wrote: > Move watchdog examples to samples and remove it from Documentation > Makefile. Create a new Makefile to build watchdog. It can be built > from top level directory or from watchdog directory: Updates needed to

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

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

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

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

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 v4 00/29] Create a book for Kernel development

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] Documentation: DMA-API-HOWTO: Fix a typo

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] [linux-next] Fix double word "the the" in Doc/filesystems

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] DMA-API-HOWTO: is no more

On Sun, 11 Sep 2016 15:58:53 +0200 Christoph Hellwig wrote: > So don't mention it. Applied to the docs tree, thanks. jon

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

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

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

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 11/21] Documentation/kernel-docs.txt: convert it to ReST markup

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 05/21] Documentation/applying-patches.txt: convert it to ReST markup

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 v3 13/21] Documentation/SecurityBugs: convert it to ReST markup

On Wed, 14 Sep 2016 08:06:42 -0300 Mauro Carvalho Chehab wrote: > Add a name for the document and convert the sections to > ReST markups. No objection to the changes (modulo the discussion on section numbers), but I do wonder whether this one belongs with the process

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

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 19/21] docs-rst: move HOWTO and mentioned documents to development-process/

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

[PATCH] docs: Remove space-before-label guidance from CodingStyle

lv...@suse.de> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/CodingStyle | 7 ++- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index 852253c932fe..9c61c039ccd9 100644 --- a/Documentation/CodingSty

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

t don't follow that convention, but they are no more broken than before. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- scripts/kernel-doc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index c681e8f0ecc2..e6c52ab938fd 100755 --- a/scr

[PATCH] kthread: add kerneldoc for kthread_create()

This macro is referenced in other kerneldoc comments, but lacks one of its own; fix that. Reported-by: Mauro Carvalho Chehab <mche...@s-opensource.com> Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- include/linux/kthread.h | 11 +++ 1 file changed, 11 insertions(+)

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

On Tue, 23 Aug 2016 15:28:55 +0200 Daniel Vetter wrote: > I think the more interesting story is, what's your plan with all the > other driver related subsystem? Especially the ones which already have > full directories of their own, like e.g. Documentation/gpio/. I think > those

[PATCH 0/3] RFC: The beginning of a proper driver-api book

gt; Cc: Mauro Carvalho Chehab <mche...@s-opensource.com> Cc: Sebastian Reichel <s...@kernel.org> Jonathan Corbet (3): Docs: sphinxify device-drivers.tmpl docs: split up the driver book docs: Pull HSI documentation together Documentation/DocBook/Makefile | 2 +- Doc

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

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

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

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 2/3] docs: split up the driver book

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

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

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 v9 1/2] Documentation: kdump: remind user of nr_cpus

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

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

[PULL] Documentation for 4.9

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 0/2] Moving runnable code from Documentation (last 2 patches)

s-example from Documentation > > Doc: update 00-INDEX files to reflect the runnable code move > > > > Hi Jon and Michal, > > Do these patches look good to you? I can get these into 4.9-rc1 > with your Ack. Seems good to me. Acked-by: Jonathan Corbet <cor...@lwn.net> jon

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

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 02/11] docs: retitle the kernel-documentation.rst

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 00/11] Organize and clean up the admin and process guides

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

[PATCH 04/11] docs: Get rid of the badRAM guide

The last release of this tool was for 2.6.28; it's hard to see how it has any relevance to current kernels. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/admin-guide/bad-memory.rst | 50 Documentation/admin-guide/index.rst | 1 - 2

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

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 01/11] docs: Tweak the top-level Sphinx page

This will be the initial landing point for readers, so give them a bit of introductory material. Also split the TOC into area-specific chunks to make the whole thing a bit more approachable. Signed-off-by: Jonathan Corbet <cor...@lwn.net> --- Documentation/index.rs

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

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 09/11] docs: Collapse the process guide TOC

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 06/11] docs: Get rid of the "bug-hunting" guide

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 07/11] docs: Apply some basic organization to the process guide

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

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 10/11] docs: add a warning to submitting-drivers.rst

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

Re: [PATCH v10 19/19] docs: Sample driver to demonstrate how to use Mediated device framework.

On Thu, 27 Oct 2016 02:59:26 +0530 Kirti Wankhede wrote: > The Sample driver creates mdev device that simulates serial port over PCI > card. > > Signed-off-by: Kirti Wankhede > Signed-off-by: Neo Jia > Change-Id:

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

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

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

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: [PULL] modules: begin maintainer transition

On Wed, 26 Oct 2016 10:16:15 +1030 Rusty Russell wrote: > Being a Linux kernel maintainer has been my proudest professional > accomplishment, spanning the last 19 years. But now we have a surfeit > of excellent hackers, and I can hand this over without regret. So

Re: linux-next: bad merge in the jc_docs tree

On Fri, 28 Oct 2016 10:30:29 +1100 Stephen Rothwell wrote: > I noticed that you left some conflict markers in > Documentation/admin-guide/index.rst in merge commit > > 7a6992dc952e ("Merge branch 'doc-tweaks' into docs-next") Argh. I noticed that too, but failed to

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

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

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

Re: [PATCH] Doc: update kselftest.txt with details on how to run tests after install

On Mon, 7 Nov 2016 13:24:14 -0700 Shuah Khan wrote: > Update kselftest.txt with details on how to run tests after install. > > Signed-off-by: Shuah Khan Applied to the docs tree, thanks. jon

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

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] coding-style: fix mismatch of jump label name

On Thu, 3 Nov 2016 01:57:34 +0900 Masahiro Yamada wrote: > Commit 865a1caa4b6b ("CodingStyle: Clarify and complete chapter 7") > renamed the label "out_buffer" to "out_free_buffer", but missed to > change this line. Applied to the docs tree, thanks. jon

Re: [PATCH] USB: fix typo in documentation

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 v9 7/8] thunderbolt: Networking doc

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 >

The downside of math::

Hey, Mauro, So I was a little surprised to find that the htmldocs build now breaks on one of my machines due to a lack of LaTeX. A bit of digging turned up the culprit: commit b7ff94df5628 (pixfmt-007.rst: use Sphinx math:: expressions). The math:: directive uses LaTeX to process the math

[PULL] One more documentation change for 4.9

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

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

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

<    2   3   4   5   6   7   8   9   10   11   >