[PATCH 2/4] docs: admin-guide: Move Dell RBU document from driver-api

2019-10-12 Thread Jonathan Neuschäfer
This document describes how an admin can use the dell_rbu driver, rather than any in-kernel API details. Signed-off-by: Jonathan Neuschäfer --- Documentation/{driver-api => admin-guide}/dell_rbu.rst | 0 Documentation/admin-guide/index.rst| 1 + Documentation/driver-

[PATCH 3/4] docs: admin-guide: dell_rbu: Rework the title

2019-10-12 Thread Jonathan Neuschäfer
- Mention the driver name, which is also used in sysfs (dell_rbu) - Rewrite the title to be more concise Signed-off-by: Jonathan Neuschäfer --- Documentation/admin-guide/dell_rbu.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/admin-guide/dell_rbu.rst

[PATCH 4/4] docs: admin-guide: dell_rbu: Improve formatting and spelling

2019-10-12 Thread Jonathan Neuschäfer
This improves readability a bit. Signed-off-by: Jonathan Neuschäfer --- Documentation/admin-guide/dell_rbu.rst | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/admin-guide/dell_rbu.rst b/Documentation/admin-guide/dell_rbu.rst index 10830db9e616

[PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts

2019-10-12 Thread Jonathan Neuschäfer
Since the "unordered guides" linked in admin-guide/index.rst are not supposed to be in any particular order, let's sort them alphabetically to avoid the risk of merge conflicts by spreading newly added lines more evenly. Signed-off-by: Jonathan Neuschäfer --- Upon a second look,

[PATCH 1/2] docs: i2c: Fix SPDX-License-Identifier syntax

2019-10-05 Thread Jonathan Neuschäfer
ReST directives are introduced with two dots. Signed-off-by: Jonathan Neuschäfer --- Documentation/i2c/busses/index.rst | 2 +- Documentation/i2c/index.rst| 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/i2c/busses/index.rst b/Documentation/i2c

[PATCH 2/2] docs: w1: Fix SPDX-License-Identifier syntax

2019-10-05 Thread Jonathan Neuschäfer
ReST directives are introduced with two dots. Signed-off-by: Jonathan Neuschäfer --- Documentation/w1/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/w1/index.rst b/Documentation/w1/index.rst index 57cba81865e2..156279f17553 100644 --- a/Documentation

[PATCH] docs: driver-api: pti_intel_mid: Enable syntax highlighting for C code block

2019-10-04 Thread Jonathan Neuschäfer
This makes the code snippet more readable. Signed-off-by: Jonathan Neuschäfer --- Documentation/driver-api/pti_intel_mid.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/driver-api/pti_intel_mid.rst b/Documentation/driver-api/pti_intel_mid.rst index

[PATCH 2/2] docs: driver-api: bt8xxgpio: Revive dead link

2019-10-04 Thread Jonathan Neuschäfer
www.bu3sch.de has been unusable for several years, but the same information is available on bues.ch. Cc: Michael Buesch Signed-off-by: Jonathan Neuschäfer --- Documentation/driver-api/gpio/bt8xxgpio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/driver

[PATCH 1/2] docs: driver-api: Move bt8xxgpio to the gpio directory

2019-10-04 Thread Jonathan Neuschäfer
Let's declutter Documentation/driver-api a bit. Signed-off-by: Jonathan Neuschäfer --- Is this where we want to put documentation about specific GPIO drivers/chips? Or perhaps under a subheading? --- Documentation/driver-api/{ => gpio}/bt8xxgpio.rst | 0 Documentation/driver-api/gpio/i

[PATCH] docs: networking: phy: Improve phrasing

2019-10-03 Thread Jonathan Neuschäfer
It's not about times (multiple occurences of an event) but about the duration of a time interval. Signed-off-by: Jonathan Neuschäfer --- Documentation/networking/phy.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/networking/phy.rst b/Document

[PATCH] docs: networking: devlink-trap: Fix reference to other document

2019-10-03 Thread Jonathan Neuschäfer
This fixes the following Sphinx warning: Documentation/networking/devlink-trap.rst:175: WARNING: unknown document: /devlink-trap-netdevsim Fixes: 9e0874570488 ("Documentation: Add description of netdevsim traps") Signed-off-by: Jonathan Neuschäfer --- Documentation/networking/devlin

Re: [PATCH] Documentation: networking: device drivers: Remove stray asterisks

2019-10-03 Thread Jonathan Neuschäfer
On Thu, Oct 03, 2019 at 10:47:37AM -0600, Jonathan Corbet wrote: > On Wed, 2 Oct 2019 17:09:55 +0200 > Jonathan Neuschäfer wrote: > > > These asterisks were once references to a line that said: > > "* Other names and brands may be claimed as the property of others.&q

[PATCH] docs: it_IT: maintainer-pgp-guide: Fix reference to "Nitrokey Pro 2"

2019-10-02 Thread Jonathan Neuschäfer
This fixes the following Sphinx warning: Documentation/translations/it_IT/process/maintainer-pgp-guide.rst:458: WARNING: Unknown target name: "nitrokey pro". Signed-off-by: Jonathan Neuschäfer --- .../translations/it_IT/process/maintainer-pgp-guide.rst | 2 +- 1 file

[PATCH] Documentation: networking: device drivers: Remove stray asterisks

2019-10-02 Thread Jonathan Neuschäfer
n for RST conversion") Fixes: 105bf2fe6b32 ("i40evf: add driver to kernel build system") Fixes: 1fae869bcf3d ("Documentation: ice: Prepare documentation for RST conversion") Fixes: df69ba43217d ("ionic: Add basic framework for IONIC Network device driver") Signed-off-b

[PATCH] Documentation: gpio: driver: Format code blocks properly

2019-10-02 Thread Jonathan Neuschäfer
This fixes a lot of Sphinx warnings, and makes the code blocks look nice in HTML. Signed-off-by: Jonathan Neuschäfer --- Documentation/driver-api/gpio/driver.rst | 4 1 file changed, 4 insertions(+) diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio

[PATCH v2 2/2] Documentation: sphinx: Don't parse socket() as identifier reference

2019-08-12 Thread Jonathan Neuschäfer
/networking/af_xdp.rst. Prevent socket() from being misinterpreted by adding it to the Skipfuncs list in automarkup.py. Signed-off-by: Jonathan Neuschäfer --- v2: - block socket() in Documentation/sphinx/automarkup.py, as suggested by Jonathan Corbet v1: - https://lore.kernel.org/lkml

[PATCH v2 1/2] Documentation: sphinx: Add missing comma to list of strings

2019-08-12 Thread Jonathan Neuschäfer
In Python, like in C, when a comma is omitted in a list of strings, the two strings around the missing comma are concatenated. Signed-off-by: Jonathan Neuschäfer --- v2: - new patch --- Documentation/sphinx/automarkup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a

Re: [PATCH] Documentation/networking/af_xdp: Inhibit reference to struct socket

2019-08-11 Thread Jonathan Neuschäfer
On Sat, Aug 10, 2019 at 08:58:21AM -0600, Jonathan Corbet wrote: > On Sat, 10 Aug 2019 14:17:37 +0200 > Jonathan Neuschäfer wrote: > > > With the recent change to auto-detect function names, Sphinx parses > > socket() as a reference to the in-kernel definition of socket. It

[PATCH] Documentation/networking/af_xdp: Inhibit reference to struct socket

2019-08-10 Thread Jonathan Neuschäfer
. Prevent socket() from being misinterpreted by wrapping it in ``inline literal`` quotes. Signed-off-by: Jonathan Neuschäfer --- Documentation/networking/af_xdp.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/networking/af_xdp.rst b/Documentation/networking

[PATCH 2/2] Documentation/arm/sa1100/assabet: Fix 'make assabet_defconfig' command

2019-08-08 Thread Jonathan Neuschäfer
"make assabet_config" doesn't work. Signed-off-by: Jonathan Neuschäfer --- Documentation/arm/sa1100/assabet.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/arm/sa1100/assabet.rst b/Documentation/arm/sa1100/assabet.rst index 3e704831c31

[PATCH 1/2] Documentation/arm/sa1100: Remove some obsolete documentation

2019-08-08 Thread Jonathan Neuschäfer
- Yopy Tifon support has been removed in 2.4.3.3. Signed-off-by: Jonathan Neuschäfer --- Documentation/arm/sa1100/adsbitsy.rst | 51 -- Documentation/arm/sa1100/brutus.rst | 69 - Documentation/arm/sa1100/freebird.rst | 25 - Documentat

[PATCH] Documentation/arm/samsung-s3c24xx: Remove stray U+FEFF character to fix title

2019-08-08 Thread Jonathan Neuschäfer
le of contents. Signed-off-by: Jonathan Neuschäfer --- Documentation/arm/samsung-s3c24xx/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/arm/samsung-s3c24xx/index.rst b/Documentation/arm/samsung-s3c24xx/index.rst index 5b8a7f9398d8..ccb951a0bedb 100644

[PATCH] docs: process: Remove outdated info about -git patches

2019-02-10 Thread Jonathan Neuschäfer
As can be seen by clicking around the timeline on web.archive.org[1], there were no -git patches/tarballs on kernel.org since release 3.1. [1]: https://web.archive.org/web/2003073843/http://www.kernel.org/ Signed-off-by: Jonathan Neuschäfer --- Documentation/process/howto.rst | 9

[PATCH v2] doc: Change LXR references to elixir.bootlin.com

2019-01-30 Thread Jonathan Neuschäfer
-electrons-becomes-bootlin/ [2]: https://github.com/free-electrons/elixir Signed-off-by: Jonathan Neuschäfer --- v2: - Fix ident search URL, as suggested by Martin Kepplinger - Add trailing slash, which I accidentally dropped in v1 in Documentation/translations/it_IT/process/howto.rst v1: https

Re: [PATCH] doc: Change LXR references to elixir.bootlin.com

2019-01-29 Thread Jonathan Neuschäfer
nt/xpad_device Oops. Indeed, it doesn't work with the old syntax. I'll fix this in v2. > other than that, good. Thanks, Jonathan Neuschäfer signature.asc Description: PGP signature

[PATCH] doc: Change LXR references to elixir.bootlin.com

2019-01-29 Thread Jonathan Neuschäfer
-electrons-becomes-bootlin/ [2]: https://github.com/free-electrons/elixir Signed-off-by: Jonathan Neuschäfer --- Documentation/input/devices/xpad.rst | 2 +- Documentation/process/howto.rst| 2 +- Documentation/process/kernel-docs.rst | 2 +- Documentation

[PATCH] Documentation: gpio: driver: Fix a typo and some odd grammar

2018-05-16 Thread Jonathan Neuschäfer
Signed-off-by: Jonathan Neuschäfer --- Documentation/driver-api/gpio/driver.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst index 505ee906d7d9..cbe0242842d1 100644 --- a

[PATCH] PM: docs: sleep-states: Fix a typo ("includig")

2018-04-25 Thread Jonathan Neuschäfer
Signed-off-by: Jonathan Neuschäfer --- Documentation/admin-guide/pm/sleep-states.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/admin-guide/pm/sleep-states.rst b/Documentation/admin-guide/pm/sleep-states.rst index 1e5c0f00cb2f..dbf5acd49f35 100644 --- a

Re: [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST

2018-03-23 Thread Jonathan Neuschäfer
On Fri, Mar 23, 2018 at 04:23:21AM +0100, Linus Walleij wrote: > On Fri, Mar 9, 2018 at 12:40 AM, Jonathan Neuschäfer > wrote: > > > Jonathan Neuschäfer (8): > > MAINTAINERS: GPIO: Add Documentation/driver-api/gpio/ > > Documentation: driver-api: Move

Re: [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST

2018-03-10 Thread Jonathan Neuschäfer
On Sat, Mar 10, 2018 at 12:50:46PM +0100, Linus Walleij wrote: > On Fri, Mar 9, 2018 at 12:40 AM, Jonathan Neuschäfer > wrote: > > > The aim of this patchset is to move the GPIO subsystem's documentation > > under Documentation/driver-api/gpio/ such that it is p

Re: [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST

2018-03-10 Thread Jonathan Neuschäfer
On Fri, Mar 09, 2018 at 10:41:20AM -0700, Jonathan Corbet wrote: > On Fri, 9 Mar 2018 00:40:16 +0100 > Jonathan Neuschäfer wrote: > > > The aim of this patchset is to move the GPIO subsystem's documentation > > under Documentation/driver-api/gpio/ such that it is p

[PATCH 4/8] Documentation: gpio: Move driver documentation to driver-api

2018-03-08 Thread Jonathan Neuschäfer
Move gpio/driver.txt to driver-api/gpio/driver.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer --- .../driver.txt => driver-api/gpio/driver.rst} | 80 +++--- Documentation/driver-api/gpio/index.rst| 1 + Documentation/gpio

[PATCH 7/8] Documentation: gpio: Move GPIO mapping documentation to driver-api

2018-03-08 Thread Jonathan Neuschäfer
Move gpio/board.txt to driver-api/gpio/board.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer --- .../{gpio/board.txt => driver-api/gpio/board.rst} | 39 -- Documentation/driver-api/gpio/index.rst| 1 + Documentation/gpio/00-IN

[PATCH 6/8] Documentation: gpio: Move gpiod_* consumer documentation to driver-api

2018-03-08 Thread Jonathan Neuschäfer
Move gpio/consumer.txt to driver-api/gpio/consumer.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer --- .../consumer.txt => driver-api/gpio/consumer.rst} | 85 +++--- Documentation/driver-api/gpio/index.rst| 1 + Documentation/gpio

[PATCH 2/8] Documentation: driver-api: Move gpio.rst to gpio/index.rst

2018-03-08 Thread Jonathan Neuschäfer
To make space for more files in the GPIO section, create a Documentation/driver-api/gpio/ directory. Signed-off-by: Jonathan Neuschäfer --- Documentation/driver-api/{gpio.rst => gpio/index.rst} | 0 Documentation/driver-api/index.rst| 2 +- 2 files changed, 1 insertion(+)

[PATCH 8/8] Documentation: gpio: Move drivers-on-gpio.txt to driver-api

2018-03-08 Thread Jonathan Neuschäfer
Move gpio/drivers-on-gpio.txt to driver-api/gpio/drivers-on-gpio.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer --- This patch applies cleanly on top of 93db446a424c ("mtd: nand: move raw NAND related code to the raw/ subdir") --- .../drivers-o

[PATCH 5/8] Documentation: gpio: Move legacy documentation to driver-api

2018-03-08 Thread Jonathan Neuschäfer
Move gpio/gpio-legacy.txt to driver-api/gpio/legacy.rst and make sure it builds cleanly as ReST. Also move the legacy API reference from index.rst to legacy.rst. Signed-off-by: Jonathan Neuschäfer --- Documentation/driver-api/gpio/index.rst| 10 +--- .../gpio-legacy.txt => dri

[PATCH 1/8] MAINTAINERS: GPIO: Add Documentation/driver-api/gpio/

2018-03-08 Thread Jonathan Neuschäfer
Steer patches to Documentation/driver-api/gpio/ into the right direction. Signed-off-by: Jonathan Neuschäfer --- MAINTAINERS | 1 + 1 file changed, 1 insertion(+) diff --git a/MAINTAINERS b/MAINTAINERS index d6a89d31e4a4..313c0907020c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -6029,6

[PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST

2018-03-08 Thread Jonathan Neuschäfer
even though they are part of the GPIO chapter. But the resulting TOC tree is consistent, and I did not want to change almost all headings. * Some of the files could use more :c:func:`...` references and general ReST polish. But I don't want to make this patchset too large. Jonathan Neus

[PATCH 3/8] Documentation: gpio: Move introduction to driver-api

2018-03-08 Thread Jonathan Neuschäfer
Move gpio/intro.txt to driver-api/gpio/intro.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer --- Documentation/driver-api/gpio/index.rst| 7 +++ Documentation/{gpio/gpio.txt => driver-api/gpio/intro.rst} | 9 +++-- Documentation/g

[PATCH] admin-guide: Fix list formatting in tained-kernels.html

2018-02-13 Thread Jonathan Neuschäfer
Without this patch, the points 1-9 in the list are rendered as an HTML blockquote containing a list, causing them to be indented further than the rest of the list. While at it, also fix the quotation marks around G and P. Signed-off-by: Jonathan Neuschäfer --- Documentation/admin-guide/tainted

[PATCH] Documentation/process/howto: Remove outdated info about bugzilla mailing lists

2018-02-13 Thread Jonathan Neuschäfer
The mailing list archives[1,2] show no activity since September 2011. [1]: https://lists.linuxfoundation.org/pipermail/bugme-new/ [2]: https://lists.linuxfoundation.org/pipermail/bugme-janitors/ Signed-off-by: Jonathan Neuschäfer --- Documentation/process/howto.rst | 8 1 file changed

[PATCH] Documentation: mono: Update links and s/CVS/Git/

2017-12-09 Thread Jonathan Neuschäfer
The URLs in mono.rst redirect to pages on www.mono-project.com, so let's update them. I took the liberty to update the compilation instructions to the Linux-specific version, because readers of the kernel documentation will most likely use Linux. Signed-off-by: Jonathan Neusc

Re: [PATCH 1/2] MAINTAINERS: regulator: Add Documentation/power/regulator/

2017-11-28 Thread Jonathan Neuschäfer
On Tue, Nov 28, 2017 at 03:15:37PM +, Mark Brown wrote: > On Tue, Nov 28, 2017 at 05:22:02AM +0100, Jonathan Neuschäfer wrote: > > On Sun, Nov 19, 2017 at 06:09:06AM +0100, Jonathan Neuschäfer wrote: > > > Signed-off-by: Jonathan Neuschäfer > > > --- > > &

Re: [PATCH] drm/i915/guc: Fix doc reference to intel_guc_fw.c

2017-11-28 Thread Jonathan Neuschäfer
On Tue, Nov 28, 2017 at 09:51:13AM +0100, Michal Wajdeczko wrote: > On Tue, 28 Nov 2017 07:50:52 +0100, Jonathan Neuschäfer > wrote: > > > Sphinx complains that it can't find intel_guc_loader.c, and rightly so: > > The file has been renamed. > > > > Fixe

[PATCH] drm/i915/guc: Fix doc reference to intel_guc_fw.c

2017-11-27 Thread Jonathan Neuschäfer
Sphinx complains that it can't find intel_guc_loader.c, and rightly so: The file has been renamed. Fixes: e8668bbcb0f9 ("drm/i915/guc: Rename intel_guc_loader.c to intel_guc_fw.c") Cc: Michal Wajdeczko Signed-off-by: Jonathan Neuschäfer --- Documentation/gpu/i915.rst | 4 ++--

[PATCH] genericirq.rst: Remove :c:func:`...` in code blocks

2017-11-27 Thread Jonathan Neuschäfer
s") Signed-off-by: Jonathan Neuschäfer --- Documentation/core-api/genericirq.rst | 16 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/core-api/genericirq.rst b/Documentation/core-api/genericirq.rst index 0054bd48be84..4da67b65cecf 100644 --- a/Doc

Re: [PATCH 1/2] MAINTAINERS: regulator: Add Documentation/power/regulator/

2017-11-27 Thread Jonathan Neuschäfer
On Sun, Nov 19, 2017 at 06:09:06AM +0100, Jonathan Neuschäfer wrote: > Signed-off-by: Jonathan Neuschäfer > --- > MAINTAINERS | 1 + > 1 file changed, 1 insertion(+) Ping. Should I resend this series with Cc: linux-doc@vger.kernel.org? > > diff --git a/MAINTAINERS b/M

[PATCH 5/6] Documentation: howto: Remove outdated info about bugzilla mailing lists

2017-05-15 Thread Jonathan Neuschäfer
The mailing list archives[1,2] show no activity since September 2011. [1]: https://lists.linuxfoundation.org/pipermail/bugme-new/ [2]: https://lists.linuxfoundation.org/pipermail/bugme-janitors/ Signed-off-by: Jonathan Neuschäfer --- Documentation/process/howto.rst | 8 1 file changed

[PATCH 4/6] Documentation: Remove outdated info about -git patches

2017-05-15 Thread Jonathan Neuschäfer
Since the 3.2 cycle, there were no -git patches/tarballs on kernel.org. Signed-off-by: Jonathan Neuschäfer --- Documentation/process/applying-patches.rst | 40 +- Documentation/process/howto.rst| 9 --- 2 files changed, 1 insertion(+), 48 deletions

[PATCH 3/6] Documentation: kernel-docs: Remove "Here is its" at the end of lines

2017-05-15 Thread Jonathan Neuschäfer
ake sense anymore, because the "Abstract:" is clearly separated. Signed-off-by: Jonathan Neuschäfer --- Documentation/process/kernel-docs.rst | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kerne

[PATCH 2/6] Documentation: kernel-docs: Move vfs.txt under "Docs at the Linux Kernel tree"

2017-05-15 Thread Jonathan Neuschäfer
It's unneccessary to point to an external mirror of the Documentation directory. Also, drop the date field, because in-kernel documentation is continually updated. Signed-off-by: Jonathan Neuschäfer --- Documentation/process/kernel-docs.rst | 23 +++ 1 file change

[PATCH 6/6] Documentation: mono: Update links and s/CVS/Git/

2017-05-15 Thread Jonathan Neuschäfer
The old URLs redirect to the new ones, so just update them in mono.rst. Signed-off-by: Jonathan Neuschäfer --- Documentation/admin-guide/mono.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/admin-guide/mono.rst b/Documentation/admin-guide/mono.rst

[PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering

2017-05-15 Thread Jonathan Neuschäfer
Without this patch, Sphinx renders the sentence as follows, thus hiding the backslashes: [...] end each string except the last with nt to properly indent the next instruction [...] Signed-off-by: Jonathan Neuschäfer --- Documentation/process/coding-style.rst | 2 +- 1 file