* Re: [Linux-kernel-mentees][PATCH] doc: RCU callback locks need only _bh, not necessarily _irq
From: Jonathan Corbet @ 2019-06-28 15:11 UTC (permalink / raw)
To: Jiunn Chang
Cc: skhan, linux-kernel-mentees, paulmck, josh, rostedt,
mathieu.desnoyers, jiangshanlai, joel, rcu, linux-doc,
linux-kernel
In-Reply-To: <20190627210147.19510-1-c0d1n61at3@gmail.com>
On Thu, 27 Jun 2019 16:01:47 -0500
Jiunn Chang <c0d1n61at3@gmail.com> wrote:
> The UP.rst file calls for locks acquired within RCU callback functions
> to use _irq variants (spin_lock_irqsave() or similar), which does work,
> but can be overkill. This commit therefore instead calls for _bh variants
> (spin_lock_bh() or similar), while noting that _irq does work.
>
> Signed-off-by: Paul E. McKenney <paulmck@linux.ibm.com>
> Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com>
> ---
> Documentation/RCU/UP.rst | 13 +++++++------
> 1 file changed, 7 insertions(+), 6 deletions(-)
Applied, thanks.
jon
^ permalink raw reply
* Re: [PATCH] docs: format kernel-parameters -- as code
From: Jonathan Corbet @ 2019-06-28 15:10 UTC (permalink / raw)
To: Stephen Kitt; +Cc: linux-doc, linux-kernel
In-Reply-To: <20190627135938.3722-1-steve@sk2.org>
On Thu, 27 Jun 2019 15:59:38 +0200
Stephen Kitt <steve@sk2.org> wrote:
> The current ReStructuredText formatting results in "--", used to
> indicate the end of the kernel command-line parameters, appearing as
> an en-dash instead of two hyphens; this patch formats them as code,
> "``--``", as done elsewhere in the documentation.
>
> Signed-off-by: Stephen Kitt <steve@sk2.org>
A worthy fix, I've applied it. This seems like the sort of annoyance that
will bite us over and over, though. We might want to find a more
comprehensive way to turn this behavior off.
Thanks,
jon
^ permalink raw reply
* Re: [linux-kernel-mentees] [PATCH v2] Doc : doc-guide : Fix a typo
From: Jonathan Corbet @ 2019-06-28 15:04 UTC (permalink / raw)
To: Sheriff Esseson; +Cc: skhan, linux-kernel, linux-kernel-mentees, linux-doc
In-Reply-To: <20190628062001.26085-1-sheriffesseson@gmail.com>
On Fri, 28 Jun 2019 07:20:01 +0100
Sheriff Esseson <sheriffesseson@gmail.com> wrote:
> fix the disjunction by replacing "of" with "or".
>
> Signed-off-by: Sheriff Esseson <sheriffesseson@gmail.com>
> ---
>
> changes in v2:
> - cc-ed Corbet.
>
> Documentation/doc-guide/kernel-doc.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
> index f96059767..192c36af3 100644
> --- a/Documentation/doc-guide/kernel-doc.rst
> +++ b/Documentation/doc-guide/kernel-doc.rst
> @@ -359,7 +359,7 @@ Domain`_ references.
> ``monospaced font``.
>
> Useful if you need to use special characters that would otherwise have some
> - meaning either by kernel-doc script of by reStructuredText.
> + meaning either by kernel-doc script or by reStructuredText.
>
> This is particularly useful if you need to use things like ``%ph`` inside
> a function description.
I have applied this, thanks.
jon
^ permalink raw reply
* [PATCH v3] Documentation:sh:convert register-banks.txt and new-machine.txt to rst format.
From: Vandana BN @ 2019-06-28 15:03 UTC (permalink / raw)
To: Yoshinori Sato, Rich Felker, Jonathan Corbet, linux-sh, linux-doc,
linux-kernel, mchehab
Cc: skhan, gregkh, linux-kernel-mentees, Vandana BN
In-Reply-To: <20190627063347.11137-1-bnvandana@gmail.com>
This patch converts new-machine.txt and register-banks.txt
to ReST format, No content change.
Added interfaces.rst to contain kernel-doc markups from index.rst
Added interfaces.rst,new-machine.rst and register-banks.rst to sh/index.rst
Signed-off-by: Vandana BN <bnvandana@gmail.com>
---
Documentation/sh/index.rst | 63 +------
Documentation/sh/interface.rst | 59 ++++++
.../sh/{new-machine.txt => new-machine.rst} | 171 +++++++++---------
...{register-banks.txt => register-banks.rst} | 8 +-
4 files changed, 161 insertions(+), 140 deletions(-)
create mode 100644 Documentation/sh/interface.rst
rename Documentation/sh/{new-machine.txt => new-machine.rst} (79%)
rename Documentation/sh/{register-banks.txt => register-banks.rst} (90%)
diff --git a/Documentation/sh/index.rst b/Documentation/sh/index.rst
index bc8db7ba894a..e9e4720cce0c 100644
--- a/Documentation/sh/index.rst
+++ b/Documentation/sh/index.rst
@@ -1,59 +1,12 @@
-=======================
-SuperH Interfaces Guide
-=======================
+====================
+SuperH Documentation
+====================
:Author: Paul Mundt
-Memory Management
-=================
+.. toctree::
+ :maxdepth: 2
-SH-4
-----
-
-Store Queue API
-~~~~~~~~~~~~~~~
-
-.. kernel-doc:: arch/sh/kernel/cpu/sh4/sq.c
- :export:
-
-SH-5
-----
-
-TLB Interfaces
-~~~~~~~~~~~~~~
-
-.. kernel-doc:: arch/sh/mm/tlb-sh5.c
- :internal:
-
-.. kernel-doc:: arch/sh/include/asm/tlb_64.h
- :internal:
-
-Machine Specific Interfaces
-===========================
-
-mach-dreamcast
---------------
-
-.. kernel-doc:: arch/sh/boards/mach-dreamcast/rtc.c
- :internal:
-
-mach-x3proto
-------------
-
-.. kernel-doc:: arch/sh/boards/mach-x3proto/ilsel.c
- :export:
-
-Busses
-======
-
-SuperHyway
-----------
-
-.. kernel-doc:: drivers/sh/superhyway/superhyway.c
- :export:
-
-Maple
------
-
-.. kernel-doc:: drivers/sh/maple/maple.c
- :export:
+ interface
+ new-machine
+ register-banks
diff --git a/Documentation/sh/interface.rst b/Documentation/sh/interface.rst
new file mode 100644
index 000000000000..bc8db7ba894a
--- /dev/null
+++ b/Documentation/sh/interface.rst
@@ -0,0 +1,59 @@
+=======================
+SuperH Interfaces Guide
+=======================
+
+:Author: Paul Mundt
+
+Memory Management
+=================
+
+SH-4
+----
+
+Store Queue API
+~~~~~~~~~~~~~~~
+
+.. kernel-doc:: arch/sh/kernel/cpu/sh4/sq.c
+ :export:
+
+SH-5
+----
+
+TLB Interfaces
+~~~~~~~~~~~~~~
+
+.. kernel-doc:: arch/sh/mm/tlb-sh5.c
+ :internal:
+
+.. kernel-doc:: arch/sh/include/asm/tlb_64.h
+ :internal:
+
+Machine Specific Interfaces
+===========================
+
+mach-dreamcast
+--------------
+
+.. kernel-doc:: arch/sh/boards/mach-dreamcast/rtc.c
+ :internal:
+
+mach-x3proto
+------------
+
+.. kernel-doc:: arch/sh/boards/mach-x3proto/ilsel.c
+ :export:
+
+Busses
+======
+
+SuperHyway
+----------
+
+.. kernel-doc:: drivers/sh/superhyway/superhyway.c
+ :export:
+
+Maple
+-----
+
+.. kernel-doc:: drivers/sh/maple/maple.c
+ :export:
diff --git a/Documentation/sh/new-machine.txt b/Documentation/sh/new-machine.rst
similarity index 79%
rename from Documentation/sh/new-machine.txt
rename to Documentation/sh/new-machine.rst
index e0961a66130b..b16c33342642 100644
--- a/Documentation/sh/new-machine.txt
+++ b/Documentation/sh/new-machine.rst
@@ -1,8 +1,8 @@
+================================
+Adding a new board to LinuxSH
+================================
- Adding a new board to LinuxSH
- ================================
-
- Paul Mundt <lethal@linux-sh.org>
+Paul Mundt <lethal@linux-sh.org>
This document attempts to outline what steps are necessary to add support
for new boards to the LinuxSH port under the new 2.5 and 2.6 kernels. This
@@ -19,65 +19,67 @@ include/asm-sh/. For the new kernel, things are broken out by board type,
companion chip type, and CPU type. Looking at a tree view of this directory
hierarchy looks like the following:
-Board-specific code:
-
-.
-|-- arch
-| `-- sh
-| `-- boards
-| |-- adx
-| | `-- board-specific files
-| |-- bigsur
-| | `-- board-specific files
-| |
-| ... more boards here ...
-|
-`-- include
- `-- asm-sh
- |-- adx
- | `-- board-specific headers
- |-- bigsur
- | `-- board-specific headers
- |
- .. more boards here ...
-
-Next, for companion chips:
-.
-`-- arch
- `-- sh
- `-- cchips
- `-- hd6446x
- `-- hd64461
- `-- cchip-specific files
+Board-specific code::
+
+ .
+ |-- arch
+ | `-- sh
+ | `-- boards
+ | |-- adx
+ | | `-- board-specific files
+ | |-- bigsur
+ | | `-- board-specific files
+ | |
+ | ... more boards here ...
+ |
+ `-- include
+ `-- asm-sh
+ |-- adx
+ | `-- board-specific headers
+ |-- bigsur
+ | `-- board-specific headers
+ |
+ .. more boards here ...
+
+Next, for companion chips::
+
+ .
+ `-- arch
+ `-- sh
+ `-- cchips
+ `-- hd6446x
+ `-- hd64461
+ `-- cchip-specific files
... and so on. Headers for the companion chips are treated the same way as
board-specific headers. Thus, include/asm-sh/hd64461 is home to all of the
hd64461-specific headers.
-Finally, CPU family support is also abstracted:
-.
-|-- arch
-| `-- sh
-| |-- kernel
-| | `-- cpu
-| | |-- sh2
-| | | `-- SH-2 generic files
-| | |-- sh3
-| | | `-- SH-3 generic files
-| | `-- sh4
-| | `-- SH-4 generic files
-| `-- mm
-| `-- This is also broken out per CPU family, so each family can
-| have their own set of cache/tlb functions.
-|
-`-- include
- `-- asm-sh
- |-- cpu-sh2
- | `-- SH-2 specific headers
- |-- cpu-sh3
- | `-- SH-3 specific headers
- `-- cpu-sh4
- `-- SH-4 specific headers
+Finally, CPU family support is also abstracted::
+
+ .
+ |-- arch
+ | `-- sh
+ | |-- kernel
+ | | `-- cpu
+ | | |-- sh2
+ | | | `-- SH-2 generic files
+ | | |-- sh3
+ | | | `-- SH-3 generic files
+ | | `-- sh4
+ | | `-- SH-4 generic files
+ | `-- mm
+ | `-- This is also broken out per CPU family, so each family can
+ | have their own set of cache/tlb functions.
+ |
+ `-- include
+ `-- asm-sh
+ |-- cpu-sh2
+ | `-- SH-2 specific headers
+ |-- cpu-sh3
+ | `-- SH-3 specific headers
+ `-- cpu-sh4
+ `-- SH-4 specific headers
It should be noted that CPU subtypes are _not_ abstracted. Thus, these still
need to be dealt with by the CPU family specific code.
@@ -112,18 +114,20 @@ setup code, we're required at the very least to provide definitions for
get_system_type() and platform_setup(). For our imaginary board, this
might look something like:
-/*
- * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
- */
-#include <linux/init.h>
+.. code-block:: c
+
+ /*
+ * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
+ */
+ #include <linux/init.h>
-const char *get_system_type(void)
-{
- return "FooTech Vaporboard";
-}
+ const char *get_system_type(void)
+ {
+ return "FooTech Vaporboard";
+ }
-int __init platform_setup(void)
-{
+ int __init platform_setup(void)
+ {
/*
* If our hardware actually existed, we would do real
* setup here. Though it's also sane to leave this empty
@@ -136,7 +140,8 @@ int __init platform_setup(void)
/* And whatever else ... */
return 0;
-}
+ }
+
Our new imaginary board will also have to tie into the machvec in order for it
to be of any use.
@@ -172,16 +177,17 @@ sufficient.
vector.
Note that these prototypes are generated automatically by setting
- __IO_PREFIX to something sensible. A typical example would be:
+ __IO_PREFIX to something sensible. A typical example would be::
#define __IO_PREFIX vapor
#include <asm/io_generic.h>
+
somewhere in the board-specific header. Any boards being ported that still
have a legacy io.h should remove it entirely and switch to the new model.
- Add machine vector definitions to the board's setup.c. At a bare minimum,
- this must be defined as something like:
+ this must be defined as something like::
struct sh_machine_vector mv_vapor __initmv = {
.mv_name = "vapor",
@@ -202,11 +208,11 @@ Large portions of the build system are now entirely dynamic, and merely
require the proper entry here and there in order to get things done.
The first thing to do is to add an entry to arch/sh/Kconfig, under the
-"System type" menu:
+"System type" menu::
-config SH_VAPOR
- bool "Vapor"
- help
+ config SH_VAPOR
+ bool "Vapor"
+ help
select Vapor if configuring for a FooTech Vaporboard.
next, this has to be added into arch/sh/Makefile. All boards require a
@@ -232,6 +238,8 @@ space restating it here. After this is done, you will be able to use
implicit checks for your board if you need this somewhere throughout the
common code, such as:
+::
+
/* Make sure we're on the FooTech Vaporboard */
if (!mach_is_vapor())
return -ENODEV;
@@ -253,12 +261,13 @@ build target, and it will be implicitly listed as such in the help text.
Looking at the 'make help' output, you should now see something like:
Architecture specific targets (sh):
- zImage - Compressed kernel image (arch/sh/boot/zImage)
- adx_defconfig - Build for adx
- cqreek_defconfig - Build for cqreek
- dreamcast_defconfig - Build for dreamcast
-...
- vapor_defconfig - Build for vapor
+
+ - zImage - Compressed kernel image (arch/sh/boot/zImage)
+ - adx_defconfig - Build for adx
+ - cqreek_defconfig - Build for cqreek
+ - dreamcast_defconfig - Build for dreamcast
+ - ...
+ - vapor_defconfig - Build for vapor
which then allows you to do:
diff --git a/Documentation/sh/register-banks.txt b/Documentation/sh/register-banks.rst
similarity index 90%
rename from Documentation/sh/register-banks.txt
rename to Documentation/sh/register-banks.rst
index a6719f2f6594..acccfaf80355 100644
--- a/Documentation/sh/register-banks.txt
+++ b/Documentation/sh/register-banks.rst
@@ -1,8 +1,9 @@
- Notes on register bank usage in the kernel
- ==========================================
+==========================================
+Notes on register bank usage in the kernel
+==========================================
Introduction
-------------
+============
The SH-3 and SH-4 CPU families traditionally include a single partial register
bank (selected by SR.RB, only r0 ... r7 are banked), whereas other families
@@ -30,4 +31,3 @@ Presently the kernel uses several of these registers.
- The SR.IMASK interrupt handler makes use of this to set the
interrupt priority level (used by local_irq_enable())
- r7_bank (current)
-
--
2.17.1
^ permalink raw reply related
* Re: [PATCH 9/9] platform: x86: get rid of a non-existent document
From: Jonathan Corbet @ 2019-06-28 15:01 UTC (permalink / raw)
To: Andy Shevchenko
Cc: Mauro Carvalho Chehab, Linux Doc Mailing List,
Mauro Carvalho Chehab, Linux Kernel Mailing List, Darren Hart,
Andy Shevchenko, Platform Driver
In-Reply-To: <CAHp75VfkWkVvvufTje1G+w=7gjsr7D2On-NsOsOoTEBNLVLJzQ@mail.gmail.com>
On Fri, 28 Jun 2019 17:49:48 +0300
Andy Shevchenko <andy.shevchenko@gmail.com> wrote:
> On Fri, Jun 28, 2019 at 3:12 PM Mauro Carvalho Chehab
> <mchehab+samsung@kernel.org> wrote:
> >
> > Changeset 163ede97a9a2 ("Documentation: platform: Delete x86-laptop-drivers.txt")
> > removed the x86-laptop-drivers.txt file, but forgot to update its
> > Kconfig.
>
> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
The patch that brought this situation into being is in docs-next, so I
applied this one too.
jon
^ permalink raw reply
* Re: [PATCH 17/39] docs: admin-guide: add laptops documentation
From: Andy Shevchenko @ 2019-06-28 14:51 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab,
Linux Kernel Mailing List, Jonathan Corbet, Matan Ziv-Av,
Mattia Dongili, Arnd Bergmann, Greg Kroah-Hartman, Darren Hart,
Andy Shevchenko, Platform Driver
In-Reply-To: <f5c35189e421a5fa02075d611f58506bffe77028.1561724493.git.mchehab+samsung@kernel.org>
On Fri, Jun 28, 2019 at 3:30 PM Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
>
> The docs under Documentation/laptops contain users specific
> information.
>
Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
> Documentation/ABI/testing/sysfs-block-device | 2 +-
> Documentation/ABI/testing/sysfs-platform-asus-laptop | 2 +-
> Documentation/admin-guide/index.rst | 1 +
> Documentation/admin-guide/kernel-parameters.txt | 2 +-
> Documentation/{ => admin-guide}/laptops/asus-laptop.rst | 0
> .../{ => admin-guide}/laptops/disk-shock-protection.rst | 0
> Documentation/{ => admin-guide}/laptops/index.rst | 1 -
> Documentation/{ => admin-guide}/laptops/laptop-mode.rst | 0
> Documentation/{ => admin-guide}/laptops/lg-laptop.rst | 1 -
> Documentation/{ => admin-guide}/laptops/sony-laptop.rst | 0
> Documentation/{ => admin-guide}/laptops/sonypi.rst | 0
> Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst | 0
> Documentation/{ => admin-guide}/laptops/toshiba_haps.rst | 0
> Documentation/admin-guide/sysctl/vm.rst | 4 ++--
> MAINTAINERS | 4 ++--
> drivers/char/Kconfig | 2 +-
> drivers/platform/x86/Kconfig | 4 ++--
> 17 files changed, 11 insertions(+), 12 deletions(-)
> rename Documentation/{ => admin-guide}/laptops/asus-laptop.rst (100%)
> rename Documentation/{ => admin-guide}/laptops/disk-shock-protection.rst (100%)
> rename Documentation/{ => admin-guide}/laptops/index.rst (95%)
> rename Documentation/{ => admin-guide}/laptops/laptop-mode.rst (100%)
> rename Documentation/{ => admin-guide}/laptops/lg-laptop.rst (99%)
> rename Documentation/{ => admin-guide}/laptops/sony-laptop.rst (100%)
> rename Documentation/{ => admin-guide}/laptops/sonypi.rst (100%)
> rename Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst (100%)
> rename Documentation/{ => admin-guide}/laptops/toshiba_haps.rst (100%)
>
> diff --git a/Documentation/ABI/testing/sysfs-block-device b/Documentation/ABI/testing/sysfs-block-device
> index 0d57bbb4fddc..17f2bc7dd261 100644
> --- a/Documentation/ABI/testing/sysfs-block-device
> +++ b/Documentation/ABI/testing/sysfs-block-device
> @@ -45,7 +45,7 @@ Description:
> - Values below -2 are rejected with -EINVAL
>
> For more information, see
> - Documentation/laptops/disk-shock-protection.rst
> + Documentation/admin-guide/laptops/disk-shock-protection.rst
>
>
> What: /sys/block/*/device/ncq_prio_enable
> diff --git a/Documentation/ABI/testing/sysfs-platform-asus-laptop b/Documentation/ABI/testing/sysfs-platform-asus-laptop
> index d67fa4bafa70..8b0e8205a6a2 100644
> --- a/Documentation/ABI/testing/sysfs-platform-asus-laptop
> +++ b/Documentation/ABI/testing/sysfs-platform-asus-laptop
> @@ -31,7 +31,7 @@ Description:
> To control the LED display, use the following :
> echo 0x0T000DDD > /sys/devices/platform/asus_laptop/
> where T control the 3 letters display, and DDD the 3 digits display.
> - The DDD table can be found in Documentation/laptops/asus-laptop.rst
> + The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst
>
> What: /sys/devices/platform/asus_laptop/bluetooth
> Date: January 2007
> diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
> index acd0efa46e9d..9899b78dbe50 100644
> --- a/Documentation/admin-guide/index.rst
> +++ b/Documentation/admin-guide/index.rst
> @@ -81,6 +81,7 @@ configure specific aspects of kernel behavior to your liking.
> perf-security
> acpi/index
> device-mapper/index
> + laptops/index
>
> .. only:: subproject and html
>
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index a3d3da5baacb..e38b96d061f4 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -4373,7 +4373,7 @@
> Format: <integer>
>
> sonypi.*= [HW] Sony Programmable I/O Control Device driver
> - See Documentation/laptops/sonypi.rst
> + See Documentation/admin-guide/laptops/sonypi.rst
>
> spectre_v2= [X86] Control mitigation of Spectre variant 2
> (indirect branch speculation) vulnerability.
> diff --git a/Documentation/laptops/asus-laptop.rst b/Documentation/admin-guide/laptops/asus-laptop.rst
> similarity index 100%
> rename from Documentation/laptops/asus-laptop.rst
> rename to Documentation/admin-guide/laptops/asus-laptop.rst
> diff --git a/Documentation/laptops/disk-shock-protection.rst b/Documentation/admin-guide/laptops/disk-shock-protection.rst
> similarity index 100%
> rename from Documentation/laptops/disk-shock-protection.rst
> rename to Documentation/admin-guide/laptops/disk-shock-protection.rst
> diff --git a/Documentation/laptops/index.rst b/Documentation/admin-guide/laptops/index.rst
> similarity index 95%
> rename from Documentation/laptops/index.rst
> rename to Documentation/admin-guide/laptops/index.rst
> index 001a30910d09..6b554e39863b 100644
> --- a/Documentation/laptops/index.rst
> +++ b/Documentation/admin-guide/laptops/index.rst
> @@ -1,4 +1,3 @@
> -:orphan:
>
> ==============
> Laptop Drivers
> diff --git a/Documentation/laptops/laptop-mode.rst b/Documentation/admin-guide/laptops/laptop-mode.rst
> similarity index 100%
> rename from Documentation/laptops/laptop-mode.rst
> rename to Documentation/admin-guide/laptops/laptop-mode.rst
> diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/admin-guide/laptops/lg-laptop.rst
> similarity index 99%
> rename from Documentation/laptops/lg-laptop.rst
> rename to Documentation/admin-guide/laptops/lg-laptop.rst
> index f2c2ffe31101..ce9b14671cb9 100644
> --- a/Documentation/laptops/lg-laptop.rst
> +++ b/Documentation/admin-guide/laptops/lg-laptop.rst
> @@ -1,6 +1,5 @@
> .. SPDX-License-Identifier: GPL-2.0+
>
> -:orphan:
>
> LG Gram laptop extra features
> =============================
> diff --git a/Documentation/laptops/sony-laptop.rst b/Documentation/admin-guide/laptops/sony-laptop.rst
> similarity index 100%
> rename from Documentation/laptops/sony-laptop.rst
> rename to Documentation/admin-guide/laptops/sony-laptop.rst
> diff --git a/Documentation/laptops/sonypi.rst b/Documentation/admin-guide/laptops/sonypi.rst
> similarity index 100%
> rename from Documentation/laptops/sonypi.rst
> rename to Documentation/admin-guide/laptops/sonypi.rst
> diff --git a/Documentation/laptops/thinkpad-acpi.rst b/Documentation/admin-guide/laptops/thinkpad-acpi.rst
> similarity index 100%
> rename from Documentation/laptops/thinkpad-acpi.rst
> rename to Documentation/admin-guide/laptops/thinkpad-acpi.rst
> diff --git a/Documentation/laptops/toshiba_haps.rst b/Documentation/admin-guide/laptops/toshiba_haps.rst
> similarity index 100%
> rename from Documentation/laptops/toshiba_haps.rst
> rename to Documentation/admin-guide/laptops/toshiba_haps.rst
> diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
> index 5aceb5cd5ce7..64aeee1009ca 100644
> --- a/Documentation/admin-guide/sysctl/vm.rst
> +++ b/Documentation/admin-guide/sysctl/vm.rst
> @@ -108,7 +108,7 @@ block_dump
> ==========
>
> block_dump enables block I/O debugging when set to a nonzero value. More
> -information on block I/O debugging is in Documentation/laptops/laptop-mode.rst.
> +information on block I/O debugging is in Documentation/admin-guide/laptops/laptop-mode.rst.
>
>
> compact_memory
> @@ -298,7 +298,7 @@ laptop_mode
> ===========
>
> laptop_mode is a knob that controls "laptop mode". All the things that are
> -controlled by this knob are discussed in Documentation/laptops/laptop-mode.rst.
> +controlled by this knob are discussed in Documentation/admin-guide/laptops/laptop-mode.rst.
>
>
> legacy_va_layout
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 40d057631004..d35ff73f718a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -8978,7 +8978,7 @@ M: Matan Ziv-Av <matan@svgalib.org>
> L: platform-driver-x86@vger.kernel.org
> S: Maintained
> F: Documentation/ABI/testing/sysfs-platform-lg-laptop
> -F: Documentation/laptops/lg-laptop.rst
> +F: Documentation/admin-guide/laptops/lg-laptop.rst
> F: drivers/platform/x86/lg-laptop.c
>
> LG2160 MEDIA DRIVER
> @@ -14830,7 +14830,7 @@ M: Mattia Dongili <malattia@linux.it>
> L: platform-driver-x86@vger.kernel.org
> W: http://www.linux.it/~malattia/wiki/index.php/Sony_drivers
> S: Maintained
> -F: Documentation/laptops/sony-laptop.rst
> +F: Documentation/admin-guide/laptops/sony-laptop.rst
> F: drivers/char/sonypi.c
> F: drivers/platform/x86/sony-laptop.c
> F: include/linux/sony-laptop.h
> diff --git a/drivers/char/Kconfig b/drivers/char/Kconfig
> index bb734066075f..442403abd73a 100644
> --- a/drivers/char/Kconfig
> +++ b/drivers/char/Kconfig
> @@ -382,7 +382,7 @@ config SONYPI
> Device which can be found in many (all ?) Sony Vaio laptops.
>
> If you have one of those laptops, read
> - <file:Documentation/laptops/sonypi.rst>, and say Y or M here.
> + <file:Documentation/admin-guide/laptops/sonypi.rst>, and say Y or M here.
>
> To compile this driver as a module, choose M here: the
> module will be called sonypi.
> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> index 1f616844fb87..85101c678693 100644
> --- a/drivers/platform/x86/Kconfig
> +++ b/drivers/platform/x86/Kconfig
> @@ -448,7 +448,7 @@ config SONY_LAPTOP
> screen brightness control, Fn keys and allows powering on/off some
> devices.
>
> - Read <file:Documentation/laptops/sony-laptop.rst> for more information.
> + Read <file:Documentation/admin-guide/laptops/sony-laptop.rst> for more information.
>
> config SONYPI_COMPAT
> bool "Sonypi compatibility"
> @@ -500,7 +500,7 @@ config THINKPAD_ACPI
> support for Fn-Fx key combinations, Bluetooth control, video
> output switching, ThinkLight control, UltraBay eject and more.
> For more information about this driver see
> - <file:Documentation/laptops/thinkpad-acpi.rst> and
> + <file:Documentation/admin-guide/laptops/thinkpad-acpi.rst> and
> <http://ibm-acpi.sf.net/> .
>
> This driver was formerly known as ibm-acpi.
> --
> 2.21.0
>
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply
* Re: [PATCH 9/9] platform: x86: get rid of a non-existent document
From: Andy Shevchenko @ 2019-06-28 14:49 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab,
Linux Kernel Mailing List, Jonathan Corbet, Darren Hart,
Andy Shevchenko, Platform Driver
In-Reply-To: <9472251c3ff159b832b4e82d77836c44f89b49b0.1561723736.git.mchehab+samsung@kernel.org>
On Fri, Jun 28, 2019 at 3:12 PM Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
>
> Changeset 163ede97a9a2 ("Documentation: platform: Delete x86-laptop-drivers.txt")
> removed the x86-laptop-drivers.txt file, but forgot to update its
> Kconfig.
Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
>
> Fixes: 163ede97a9a2 ("Documentation: platform: Delete x86-laptop-drivers.txt")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
> drivers/platform/x86/Kconfig | 3 ---
> 1 file changed, 3 deletions(-)
>
> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> index bd15b47abcb4..c318501773bc 100644
> --- a/drivers/platform/x86/Kconfig
> +++ b/drivers/platform/x86/Kconfig
> @@ -433,9 +433,6 @@ config COMPAL_LAPTOP
> It adds support for rfkill, Bluetooth, WLAN, LCD brightness, hwmon
> and battery charging level control.
>
> - For a (possibly incomplete) list of supported laptops, please refer
> - to: Documentation/platform/x86-laptop-drivers.txt
> -
> config SONY_LAPTOP
> tristate "Sony Laptop Extras"
> depends on ACPI
> --
> 2.21.0
>
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply
* Re: [PATCH 42/43] docs: move gcc_plugins.txt to core-api and rename to .rst
From: Kees Cook @ 2019-06-28 14:47 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Emese Revfy
In-Reply-To: <bfcbd5a6cbbbdb10122b30176c3bb907bf1731fc.1561723980.git.mchehab+samsung@kernel.org>
On Fri, Jun 28, 2019 at 09:20:38AM -0300, Mauro Carvalho Chehab wrote:
> The gcc_plugins.txt file is already a ReST file. Move it
> to the core-api book while renaming it.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Kees Cook <keescook@chromium.org>
-Kees
> ---
> Documentation/{gcc-plugins.txt => core-api/gcc-plugins.rst} | 0
> Documentation/core-api/index.rst | 2 +-
> MAINTAINERS | 2 +-
> scripts/gcc-plugins/Kconfig | 2 +-
> 4 files changed, 3 insertions(+), 3 deletions(-)
> rename Documentation/{gcc-plugins.txt => core-api/gcc-plugins.rst} (100%)
>
> diff --git a/Documentation/gcc-plugins.txt b/Documentation/core-api/gcc-plugins.rst
> similarity index 100%
> rename from Documentation/gcc-plugins.txt
> rename to Documentation/core-api/gcc-plugins.rst
> diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
> index 2466a4c51031..d1e5b95bf86d 100644
> --- a/Documentation/core-api/index.rst
> +++ b/Documentation/core-api/index.rst
> @@ -35,7 +35,7 @@ Core utilities
> boot-time-mm
> memory-hotplug
> protection-keys
> -
> + gcc-plugins
>
> Interfaces for kernel debugging
> ===============================
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 2cf8abf6d48e..7ba6d174f49f 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -6609,7 +6609,7 @@ S: Maintained
> F: scripts/gcc-plugins/
> F: scripts/gcc-plugin.sh
> F: scripts/Makefile.gcc-plugins
> -F: Documentation/gcc-plugins.txt
> +F: Documentation/core-api/gcc-plugins.rst
>
> GASKET DRIVER FRAMEWORK
> M: Rob Springer <rspringer@google.com>
> diff --git a/scripts/gcc-plugins/Kconfig b/scripts/gcc-plugins/Kconfig
> index e9c677a53c74..d33de0b9f4f5 100644
> --- a/scripts/gcc-plugins/Kconfig
> +++ b/scripts/gcc-plugins/Kconfig
> @@ -23,7 +23,7 @@ config GCC_PLUGINS
> GCC plugins are loadable modules that provide extra features to the
> compiler. They are useful for runtime instrumentation and static analysis.
>
> - See Documentation/gcc-plugins.txt for details.
> + See Documentation/core-api/gcc-plugins.rst for details.
>
> menu "GCC plugins"
> depends on GCC_PLUGINS
> --
> 2.21.0
>
--
Kees Cook
^ permalink raw reply
* Re: [PATCH v2] Documentation:sh:convert register-banks.txt and new-machine.txt to rst format.
From: Vandana BN @ 2019-06-28 14:37 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Yoshinori Sato, Rich Felker, Jonathan Corbet, linux-sh, linux-doc,
linux-kernel, skhan, gregkh, linux-kernel-mentees
In-Reply-To: <20190628103915.3ce83637@coco.lan>
On 28/06/19 7:09 PM, Mauro Carvalho Chehab wrote:
> Em Fri, 28 Jun 2019 18:54:59 +0530
> Vandana BN <bnvandana@gmail.com> escreveu:
>
>> This patch converts new-machine.txt and register-banks.txt to ReST format, No content
>> change.
>> Added new-machine.rst and register-banks.rst to sh/index.rst
>>
>> Signed-off-by: Vandana BN <bnvandana@gmail.com>
>> ---
>> Documentation/sh/index.rst | 6 +
>> .../sh/{new-machine.txt => new-machine.rst} | 171 +++++++++---------
>> ...{register-banks.txt => register-banks.rst} | 8 +-
>> 3 files changed, 100 insertions(+), 85 deletions(-)
>> rename Documentation/sh/{new-machine.txt => new-machine.rst} (79%)
>> rename Documentation/sh/{register-banks.txt => register-banks.rst} (90%)
>>
>> diff --git a/Documentation/sh/index.rst b/Documentation/sh/index.rst
>> index bc8db7ba894a..25471d3fc294 100644
>> --- a/Documentation/sh/index.rst
>> +++ b/Documentation/sh/index.rst
>> @@ -57,3 +57,9 @@ Maple
>>
>> .. kernel-doc:: drivers/sh/maple/maple.c
>> :export:
>> +
>> +.. toctree::
>> + :maxdepth: 2
>> +
>> + new-machine
>> + register-banks
> Hmm... adding a toctree at the end doesn't seem the best thing to do.
>
> Adding it at the beginning (just after the title) would be a little
> better, but IMHO, moving the kernel-doc markups to another file
> would make it to look better.
>
> The remaining patch looks ok on my eyes.
Thanks Mauro,
will create a new interfaces.rst file to move the kernel-doc markups. and have index.rst to have toctree .
Will send a patch with these changes.
>
>> diff --git a/Documentation/sh/new-machine.txt b/Documentation/sh/new-machine.rst
>> similarity index 79%
>> rename from Documentation/sh/new-machine.txt
>> rename to Documentation/sh/new-machine.rst
>> index e0961a66130b..b16c33342642 100644
>> --- a/Documentation/sh/new-machine.txt
>> +++ b/Documentation/sh/new-machine.rst
>> @@ -1,8 +1,8 @@
>> +================================
>> +Adding a new board to LinuxSH
>> +================================
>>
>> - Adding a new board to LinuxSH
>> - ================================
>> -
>> - Paul Mundt <lethal@linux-sh.org>
>> +Paul Mundt <lethal@linux-sh.org>
>>
>> This document attempts to outline what steps are necessary to add support
>> for new boards to the LinuxSH port under the new 2.5 and 2.6 kernels. This
>> @@ -19,65 +19,67 @@ include/asm-sh/. For the new kernel, things are broken out by board type,
>> companion chip type, and CPU type. Looking at a tree view of this directory
>> hierarchy looks like the following:
>>
>> -Board-specific code:
>> -
>> -.
>> -|-- arch
>> -| `-- sh
>> -| `-- boards
>> -| |-- adx
>> -| | `-- board-specific files
>> -| |-- bigsur
>> -| | `-- board-specific files
>> -| |
>> -| ... more boards here ...
>> -|
>> -`-- include
>> - `-- asm-sh
>> - |-- adx
>> - | `-- board-specific headers
>> - |-- bigsur
>> - | `-- board-specific headers
>> - |
>> - .. more boards here ...
>> -
>> -Next, for companion chips:
>> -.
>> -`-- arch
>> - `-- sh
>> - `-- cchips
>> - `-- hd6446x
>> - `-- hd64461
>> - `-- cchip-specific files
>> +Board-specific code::
>> +
>> + .
>> + |-- arch
>> + | `-- sh
>> + | `-- boards
>> + | |-- adx
>> + | | `-- board-specific files
>> + | |-- bigsur
>> + | | `-- board-specific files
>> + | |
>> + | ... more boards here ...
>> + |
>> + `-- include
>> + `-- asm-sh
>> + |-- adx
>> + | `-- board-specific headers
>> + |-- bigsur
>> + | `-- board-specific headers
>> + |
>> + .. more boards here ...
>> +
>> +Next, for companion chips::
>> +
>> + .
>> + `-- arch
>> + `-- sh
>> + `-- cchips
>> + `-- hd6446x
>> + `-- hd64461
>> + `-- cchip-specific files
>>
>> ... and so on. Headers for the companion chips are treated the same way as
>> board-specific headers. Thus, include/asm-sh/hd64461 is home to all of the
>> hd64461-specific headers.
>>
>> -Finally, CPU family support is also abstracted:
>> -.
>> -|-- arch
>> -| `-- sh
>> -| |-- kernel
>> -| | `-- cpu
>> -| | |-- sh2
>> -| | | `-- SH-2 generic files
>> -| | |-- sh3
>> -| | | `-- SH-3 generic files
>> -| | `-- sh4
>> -| | `-- SH-4 generic files
>> -| `-- mm
>> -| `-- This is also broken out per CPU family, so each family can
>> -| have their own set of cache/tlb functions.
>> -|
>> -`-- include
>> - `-- asm-sh
>> - |-- cpu-sh2
>> - | `-- SH-2 specific headers
>> - |-- cpu-sh3
>> - | `-- SH-3 specific headers
>> - `-- cpu-sh4
>> - `-- SH-4 specific headers
>> +Finally, CPU family support is also abstracted::
>> +
>> + .
>> + |-- arch
>> + | `-- sh
>> + | |-- kernel
>> + | | `-- cpu
>> + | | |-- sh2
>> + | | | `-- SH-2 generic files
>> + | | |-- sh3
>> + | | | `-- SH-3 generic files
>> + | | `-- sh4
>> + | | `-- SH-4 generic files
>> + | `-- mm
>> + | `-- This is also broken out per CPU family, so each family can
>> + | have their own set of cache/tlb functions.
>> + |
>> + `-- include
>> + `-- asm-sh
>> + |-- cpu-sh2
>> + | `-- SH-2 specific headers
>> + |-- cpu-sh3
>> + | `-- SH-3 specific headers
>> + `-- cpu-sh4
>> + `-- SH-4 specific headers
>>
>> It should be noted that CPU subtypes are _not_ abstracted. Thus, these still
>> need to be dealt with by the CPU family specific code.
>> @@ -112,18 +114,20 @@ setup code, we're required at the very least to provide definitions for
>> get_system_type() and platform_setup(). For our imaginary board, this
>> might look something like:
>>
>> -/*
>> - * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
>> - */
>> -#include <linux/init.h>
>> +.. code-block:: c
>> +
>> + /*
>> + * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
>> + */
>> + #include <linux/init.h>
>>
>> -const char *get_system_type(void)
>> -{
>> - return "FooTech Vaporboard";
>> -}
>> + const char *get_system_type(void)
>> + {
>> + return "FooTech Vaporboard";
>> + }
>>
>> -int __init platform_setup(void)
>> -{
>> + int __init platform_setup(void)
>> + {
>> /*
>> * If our hardware actually existed, we would do real
>> * setup here. Though it's also sane to leave this empty
>> @@ -136,7 +140,8 @@ int __init platform_setup(void)
>> /* And whatever else ... */
>>
>> return 0;
>> -}
>> + }
>> +
>>
>> Our new imaginary board will also have to tie into the machvec in order for it
>> to be of any use.
>> @@ -172,16 +177,17 @@ sufficient.
>> vector.
>>
>> Note that these prototypes are generated automatically by setting
>> - __IO_PREFIX to something sensible. A typical example would be:
>> + __IO_PREFIX to something sensible. A typical example would be::
>>
>> #define __IO_PREFIX vapor
>> #include <asm/io_generic.h>
>>
>> +
>> somewhere in the board-specific header. Any boards being ported that still
>> have a legacy io.h should remove it entirely and switch to the new model.
>>
>> - Add machine vector definitions to the board's setup.c. At a bare minimum,
>> - this must be defined as something like:
>> + this must be defined as something like::
>>
>> struct sh_machine_vector mv_vapor __initmv = {
>> .mv_name = "vapor",
>> @@ -202,11 +208,11 @@ Large portions of the build system are now entirely dynamic, and merely
>> require the proper entry here and there in order to get things done.
>>
>> The first thing to do is to add an entry to arch/sh/Kconfig, under the
>> -"System type" menu:
>> +"System type" menu::
>>
>> -config SH_VAPOR
>> - bool "Vapor"
>> - help
>> + config SH_VAPOR
>> + bool "Vapor"
>> + help
>> select Vapor if configuring for a FooTech Vaporboard.
>>
>> next, this has to be added into arch/sh/Makefile. All boards require a
>> @@ -232,6 +238,8 @@ space restating it here. After this is done, you will be able to use
>> implicit checks for your board if you need this somewhere throughout the
>> common code, such as:
>>
>> +::
>> +
>> /* Make sure we're on the FooTech Vaporboard */
>> if (!mach_is_vapor())
>> return -ENODEV;
>> @@ -253,12 +261,13 @@ build target, and it will be implicitly listed as such in the help text.
>> Looking at the 'make help' output, you should now see something like:
>>
>> Architecture specific targets (sh):
>> - zImage - Compressed kernel image (arch/sh/boot/zImage)
>> - adx_defconfig - Build for adx
>> - cqreek_defconfig - Build for cqreek
>> - dreamcast_defconfig - Build for dreamcast
>> -...
>> - vapor_defconfig - Build for vapor
>> +
>> + - zImage - Compressed kernel image (arch/sh/boot/zImage)
>> + - adx_defconfig - Build for adx
>> + - cqreek_defconfig - Build for cqreek
>> + - dreamcast_defconfig - Build for dreamcast
>> + - ...
>> + - vapor_defconfig - Build for vapor
>>
>> which then allows you to do:
>>
>> diff --git a/Documentation/sh/register-banks.txt b/Documentation/sh/register-banks.rst
>> similarity index 90%
>> rename from Documentation/sh/register-banks.txt
>> rename to Documentation/sh/register-banks.rst
>> index a6719f2f6594..acccfaf80355 100644
>> --- a/Documentation/sh/register-banks.txt
>> +++ b/Documentation/sh/register-banks.rst
>> @@ -1,8 +1,9 @@
>> - Notes on register bank usage in the kernel
>> - ==========================================
>> +==========================================
>> +Notes on register bank usage in the kernel
>> +==========================================
>>
>> Introduction
>> -------------
>> +============
>>
>> The SH-3 and SH-4 CPU families traditionally include a single partial register
>> bank (selected by SR.RB, only r0 ... r7 are banked), whereas other families
>> @@ -30,4 +31,3 @@ Presently the kernel uses several of these registers.
>> - The SR.IMASK interrupt handler makes use of this to set the
>> interrupt priority level (used by local_irq_enable())
>> - r7_bank (current)
>> -
>> --
>> 2.17.1
>>
>
>
> Thanks,
> Mauro
Regards,
Vandana.
^ permalink raw reply
* Re: [PATCH 12/39] docs: interconnect.rst: add it to the driver-api guide
From: Georgi Djakov @ 2019-06-28 13:55 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, linux-pm
In-Reply-To: <feb5e217face2ff3f2ccd5c3726192bf1250dd0d.1561724493.git.mchehab+samsung@kernel.org>
On 6/28/19 15:30, Mauro Carvalho Chehab wrote:
> This is intented for Kernel hackers audience.
s/intented/intended/
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Reviewed-by: Georgi Djakov <georgi.djakov@linaro.org>
Thanks!
Georgi
> ---
> Documentation/driver-api/index.rst | 1 +
> Documentation/{interconnect => driver-api}/interconnect.rst | 2 --
> MAINTAINERS | 2 +-
> 3 files changed, 2 insertions(+), 3 deletions(-)
> rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)
>
> diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
> index 2a0b57f12d1a..97bab578ea72 100644
> --- a/Documentation/driver-api/index.rst
> +++ b/Documentation/driver-api/index.rst
> @@ -35,6 +35,7 @@ available subsections can be seen below.
> spi
> i2c
> i3c/index
> + interconnect
> hsi
> edac
> scsi
> diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/driver-api/interconnect.rst
> similarity index 99%
> rename from Documentation/interconnect/interconnect.rst
> rename to Documentation/driver-api/interconnect.rst
> index 56e331dab70e..c3e004893796 100644
> --- a/Documentation/interconnect/interconnect.rst
> +++ b/Documentation/driver-api/interconnect.rst
> @@ -1,7 +1,5 @@
> .. SPDX-License-Identifier: GPL-2.0
>
> -:orphan:
> -
> =====================================
> GENERIC SYSTEM INTERCONNECT SUBSYSTEM
> =====================================
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 55996c9f2e0a..524e2c4300dc 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -8273,7 +8273,7 @@ INTERCONNECT API
> M: Georgi Djakov <georgi.djakov@linaro.org>
> L: linux-pm@vger.kernel.org
> S: Maintained
> -F: Documentation/interconnect/
> +F: Documentation/driver-api/interconnect.rst
> F: Documentation/devicetree/bindings/interconnect/
> F: drivers/interconnect/
> F: include/dt-bindings/interconnect/
>
^ permalink raw reply
* Re: [PATCH v2] Documentation:sh:convert register-banks.txt and new-machine.txt to rst format.
From: Mauro Carvalho Chehab @ 2019-06-28 13:39 UTC (permalink / raw)
To: Vandana BN
Cc: Yoshinori Sato, Rich Felker, Jonathan Corbet, linux-sh, linux-doc,
linux-kernel, skhan, gregkh, linux-kernel-mentees
In-Reply-To: <20190628132459.5409-1-bnvandana@gmail.com>
Em Fri, 28 Jun 2019 18:54:59 +0530
Vandana BN <bnvandana@gmail.com> escreveu:
> This patch converts new-machine.txt and register-banks.txt to ReST format, No content
> change.
> Added new-machine.rst and register-banks.rst to sh/index.rst
>
> Signed-off-by: Vandana BN <bnvandana@gmail.com>
> ---
> Documentation/sh/index.rst | 6 +
> .../sh/{new-machine.txt => new-machine.rst} | 171 +++++++++---------
> ...{register-banks.txt => register-banks.rst} | 8 +-
> 3 files changed, 100 insertions(+), 85 deletions(-)
> rename Documentation/sh/{new-machine.txt => new-machine.rst} (79%)
> rename Documentation/sh/{register-banks.txt => register-banks.rst} (90%)
>
> diff --git a/Documentation/sh/index.rst b/Documentation/sh/index.rst
> index bc8db7ba894a..25471d3fc294 100644
> --- a/Documentation/sh/index.rst
> +++ b/Documentation/sh/index.rst
> @@ -57,3 +57,9 @@ Maple
>
> .. kernel-doc:: drivers/sh/maple/maple.c
> :export:
> +
> +.. toctree::
> + :maxdepth: 2
> +
> + new-machine
> + register-banks
Hmm... adding a toctree at the end doesn't seem the best thing to do.
Adding it at the beginning (just after the title) would be a little
better, but IMHO, moving the kernel-doc markups to another file
would make it to look better.
The remaining patch looks ok on my eyes.
> diff --git a/Documentation/sh/new-machine.txt b/Documentation/sh/new-machine.rst
> similarity index 79%
> rename from Documentation/sh/new-machine.txt
> rename to Documentation/sh/new-machine.rst
> index e0961a66130b..b16c33342642 100644
> --- a/Documentation/sh/new-machine.txt
> +++ b/Documentation/sh/new-machine.rst
> @@ -1,8 +1,8 @@
> +================================
> +Adding a new board to LinuxSH
> +================================
>
> - Adding a new board to LinuxSH
> - ================================
> -
> - Paul Mundt <lethal@linux-sh.org>
> +Paul Mundt <lethal@linux-sh.org>
>
> This document attempts to outline what steps are necessary to add support
> for new boards to the LinuxSH port under the new 2.5 and 2.6 kernels. This
> @@ -19,65 +19,67 @@ include/asm-sh/. For the new kernel, things are broken out by board type,
> companion chip type, and CPU type. Looking at a tree view of this directory
> hierarchy looks like the following:
>
> -Board-specific code:
> -
> -.
> -|-- arch
> -| `-- sh
> -| `-- boards
> -| |-- adx
> -| | `-- board-specific files
> -| |-- bigsur
> -| | `-- board-specific files
> -| |
> -| ... more boards here ...
> -|
> -`-- include
> - `-- asm-sh
> - |-- adx
> - | `-- board-specific headers
> - |-- bigsur
> - | `-- board-specific headers
> - |
> - .. more boards here ...
> -
> -Next, for companion chips:
> -.
> -`-- arch
> - `-- sh
> - `-- cchips
> - `-- hd6446x
> - `-- hd64461
> - `-- cchip-specific files
> +Board-specific code::
> +
> + .
> + |-- arch
> + | `-- sh
> + | `-- boards
> + | |-- adx
> + | | `-- board-specific files
> + | |-- bigsur
> + | | `-- board-specific files
> + | |
> + | ... more boards here ...
> + |
> + `-- include
> + `-- asm-sh
> + |-- adx
> + | `-- board-specific headers
> + |-- bigsur
> + | `-- board-specific headers
> + |
> + .. more boards here ...
> +
> +Next, for companion chips::
> +
> + .
> + `-- arch
> + `-- sh
> + `-- cchips
> + `-- hd6446x
> + `-- hd64461
> + `-- cchip-specific files
>
> ... and so on. Headers for the companion chips are treated the same way as
> board-specific headers. Thus, include/asm-sh/hd64461 is home to all of the
> hd64461-specific headers.
>
> -Finally, CPU family support is also abstracted:
> -.
> -|-- arch
> -| `-- sh
> -| |-- kernel
> -| | `-- cpu
> -| | |-- sh2
> -| | | `-- SH-2 generic files
> -| | |-- sh3
> -| | | `-- SH-3 generic files
> -| | `-- sh4
> -| | `-- SH-4 generic files
> -| `-- mm
> -| `-- This is also broken out per CPU family, so each family can
> -| have their own set of cache/tlb functions.
> -|
> -`-- include
> - `-- asm-sh
> - |-- cpu-sh2
> - | `-- SH-2 specific headers
> - |-- cpu-sh3
> - | `-- SH-3 specific headers
> - `-- cpu-sh4
> - `-- SH-4 specific headers
> +Finally, CPU family support is also abstracted::
> +
> + .
> + |-- arch
> + | `-- sh
> + | |-- kernel
> + | | `-- cpu
> + | | |-- sh2
> + | | | `-- SH-2 generic files
> + | | |-- sh3
> + | | | `-- SH-3 generic files
> + | | `-- sh4
> + | | `-- SH-4 generic files
> + | `-- mm
> + | `-- This is also broken out per CPU family, so each family can
> + | have their own set of cache/tlb functions.
> + |
> + `-- include
> + `-- asm-sh
> + |-- cpu-sh2
> + | `-- SH-2 specific headers
> + |-- cpu-sh3
> + | `-- SH-3 specific headers
> + `-- cpu-sh4
> + `-- SH-4 specific headers
>
> It should be noted that CPU subtypes are _not_ abstracted. Thus, these still
> need to be dealt with by the CPU family specific code.
> @@ -112,18 +114,20 @@ setup code, we're required at the very least to provide definitions for
> get_system_type() and platform_setup(). For our imaginary board, this
> might look something like:
>
> -/*
> - * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
> - */
> -#include <linux/init.h>
> +.. code-block:: c
> +
> + /*
> + * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
> + */
> + #include <linux/init.h>
>
> -const char *get_system_type(void)
> -{
> - return "FooTech Vaporboard";
> -}
> + const char *get_system_type(void)
> + {
> + return "FooTech Vaporboard";
> + }
>
> -int __init platform_setup(void)
> -{
> + int __init platform_setup(void)
> + {
> /*
> * If our hardware actually existed, we would do real
> * setup here. Though it's also sane to leave this empty
> @@ -136,7 +140,8 @@ int __init platform_setup(void)
> /* And whatever else ... */
>
> return 0;
> -}
> + }
> +
>
> Our new imaginary board will also have to tie into the machvec in order for it
> to be of any use.
> @@ -172,16 +177,17 @@ sufficient.
> vector.
>
> Note that these prototypes are generated automatically by setting
> - __IO_PREFIX to something sensible. A typical example would be:
> + __IO_PREFIX to something sensible. A typical example would be::
>
> #define __IO_PREFIX vapor
> #include <asm/io_generic.h>
>
> +
> somewhere in the board-specific header. Any boards being ported that still
> have a legacy io.h should remove it entirely and switch to the new model.
>
> - Add machine vector definitions to the board's setup.c. At a bare minimum,
> - this must be defined as something like:
> + this must be defined as something like::
>
> struct sh_machine_vector mv_vapor __initmv = {
> .mv_name = "vapor",
> @@ -202,11 +208,11 @@ Large portions of the build system are now entirely dynamic, and merely
> require the proper entry here and there in order to get things done.
>
> The first thing to do is to add an entry to arch/sh/Kconfig, under the
> -"System type" menu:
> +"System type" menu::
>
> -config SH_VAPOR
> - bool "Vapor"
> - help
> + config SH_VAPOR
> + bool "Vapor"
> + help
> select Vapor if configuring for a FooTech Vaporboard.
>
> next, this has to be added into arch/sh/Makefile. All boards require a
> @@ -232,6 +238,8 @@ space restating it here. After this is done, you will be able to use
> implicit checks for your board if you need this somewhere throughout the
> common code, such as:
>
> +::
> +
> /* Make sure we're on the FooTech Vaporboard */
> if (!mach_is_vapor())
> return -ENODEV;
> @@ -253,12 +261,13 @@ build target, and it will be implicitly listed as such in the help text.
> Looking at the 'make help' output, you should now see something like:
>
> Architecture specific targets (sh):
> - zImage - Compressed kernel image (arch/sh/boot/zImage)
> - adx_defconfig - Build for adx
> - cqreek_defconfig - Build for cqreek
> - dreamcast_defconfig - Build for dreamcast
> -...
> - vapor_defconfig - Build for vapor
> +
> + - zImage - Compressed kernel image (arch/sh/boot/zImage)
> + - adx_defconfig - Build for adx
> + - cqreek_defconfig - Build for cqreek
> + - dreamcast_defconfig - Build for dreamcast
> + - ...
> + - vapor_defconfig - Build for vapor
>
> which then allows you to do:
>
> diff --git a/Documentation/sh/register-banks.txt b/Documentation/sh/register-banks.rst
> similarity index 90%
> rename from Documentation/sh/register-banks.txt
> rename to Documentation/sh/register-banks.rst
> index a6719f2f6594..acccfaf80355 100644
> --- a/Documentation/sh/register-banks.txt
> +++ b/Documentation/sh/register-banks.rst
> @@ -1,8 +1,9 @@
> - Notes on register bank usage in the kernel
> - ==========================================
> +==========================================
> +Notes on register bank usage in the kernel
> +==========================================
>
> Introduction
> -------------
> +============
>
> The SH-3 and SH-4 CPU families traditionally include a single partial register
> bank (selected by SR.RB, only r0 ... r7 are banked), whereas other families
> @@ -30,4 +31,3 @@ Presently the kernel uses several of these registers.
> - The SR.IMASK interrupt handler makes use of this to set the
> interrupt priority level (used by local_irq_enable())
> - r7_bank (current)
> -
> --
> 2.17.1
>
Thanks,
Mauro
^ permalink raw reply
* [PATCH v2] Documentation:sh:convert register-banks.txt and new-machine.txt to rst format.
From: Vandana BN @ 2019-06-28 13:24 UTC (permalink / raw)
To: Yoshinori Sato, Rich Felker, Jonathan Corbet, linux-sh, linux-doc,
linux-kernel, mchehab
Cc: skhan, gregkh, linux-kernel-mentees, Vandana BN
In-Reply-To: <20190627063347.11137-1-bnvandana@gmail.com>
This patch converts new-machine.txt and register-banks.txt to ReST format, No content
change.
Added new-machine.rst and register-banks.rst to sh/index.rst
Signed-off-by: Vandana BN <bnvandana@gmail.com>
---
Documentation/sh/index.rst | 6 +
.../sh/{new-machine.txt => new-machine.rst} | 171 +++++++++---------
...{register-banks.txt => register-banks.rst} | 8 +-
3 files changed, 100 insertions(+), 85 deletions(-)
rename Documentation/sh/{new-machine.txt => new-machine.rst} (79%)
rename Documentation/sh/{register-banks.txt => register-banks.rst} (90%)
diff --git a/Documentation/sh/index.rst b/Documentation/sh/index.rst
index bc8db7ba894a..25471d3fc294 100644
--- a/Documentation/sh/index.rst
+++ b/Documentation/sh/index.rst
@@ -57,3 +57,9 @@ Maple
.. kernel-doc:: drivers/sh/maple/maple.c
:export:
+
+.. toctree::
+ :maxdepth: 2
+
+ new-machine
+ register-banks
diff --git a/Documentation/sh/new-machine.txt b/Documentation/sh/new-machine.rst
similarity index 79%
rename from Documentation/sh/new-machine.txt
rename to Documentation/sh/new-machine.rst
index e0961a66130b..b16c33342642 100644
--- a/Documentation/sh/new-machine.txt
+++ b/Documentation/sh/new-machine.rst
@@ -1,8 +1,8 @@
+================================
+Adding a new board to LinuxSH
+================================
- Adding a new board to LinuxSH
- ================================
-
- Paul Mundt <lethal@linux-sh.org>
+Paul Mundt <lethal@linux-sh.org>
This document attempts to outline what steps are necessary to add support
for new boards to the LinuxSH port under the new 2.5 and 2.6 kernels. This
@@ -19,65 +19,67 @@ include/asm-sh/. For the new kernel, things are broken out by board type,
companion chip type, and CPU type. Looking at a tree view of this directory
hierarchy looks like the following:
-Board-specific code:
-
-.
-|-- arch
-| `-- sh
-| `-- boards
-| |-- adx
-| | `-- board-specific files
-| |-- bigsur
-| | `-- board-specific files
-| |
-| ... more boards here ...
-|
-`-- include
- `-- asm-sh
- |-- adx
- | `-- board-specific headers
- |-- bigsur
- | `-- board-specific headers
- |
- .. more boards here ...
-
-Next, for companion chips:
-.
-`-- arch
- `-- sh
- `-- cchips
- `-- hd6446x
- `-- hd64461
- `-- cchip-specific files
+Board-specific code::
+
+ .
+ |-- arch
+ | `-- sh
+ | `-- boards
+ | |-- adx
+ | | `-- board-specific files
+ | |-- bigsur
+ | | `-- board-specific files
+ | |
+ | ... more boards here ...
+ |
+ `-- include
+ `-- asm-sh
+ |-- adx
+ | `-- board-specific headers
+ |-- bigsur
+ | `-- board-specific headers
+ |
+ .. more boards here ...
+
+Next, for companion chips::
+
+ .
+ `-- arch
+ `-- sh
+ `-- cchips
+ `-- hd6446x
+ `-- hd64461
+ `-- cchip-specific files
... and so on. Headers for the companion chips are treated the same way as
board-specific headers. Thus, include/asm-sh/hd64461 is home to all of the
hd64461-specific headers.
-Finally, CPU family support is also abstracted:
-.
-|-- arch
-| `-- sh
-| |-- kernel
-| | `-- cpu
-| | |-- sh2
-| | | `-- SH-2 generic files
-| | |-- sh3
-| | | `-- SH-3 generic files
-| | `-- sh4
-| | `-- SH-4 generic files
-| `-- mm
-| `-- This is also broken out per CPU family, so each family can
-| have their own set of cache/tlb functions.
-|
-`-- include
- `-- asm-sh
- |-- cpu-sh2
- | `-- SH-2 specific headers
- |-- cpu-sh3
- | `-- SH-3 specific headers
- `-- cpu-sh4
- `-- SH-4 specific headers
+Finally, CPU family support is also abstracted::
+
+ .
+ |-- arch
+ | `-- sh
+ | |-- kernel
+ | | `-- cpu
+ | | |-- sh2
+ | | | `-- SH-2 generic files
+ | | |-- sh3
+ | | | `-- SH-3 generic files
+ | | `-- sh4
+ | | `-- SH-4 generic files
+ | `-- mm
+ | `-- This is also broken out per CPU family, so each family can
+ | have their own set of cache/tlb functions.
+ |
+ `-- include
+ `-- asm-sh
+ |-- cpu-sh2
+ | `-- SH-2 specific headers
+ |-- cpu-sh3
+ | `-- SH-3 specific headers
+ `-- cpu-sh4
+ `-- SH-4 specific headers
It should be noted that CPU subtypes are _not_ abstracted. Thus, these still
need to be dealt with by the CPU family specific code.
@@ -112,18 +114,20 @@ setup code, we're required at the very least to provide definitions for
get_system_type() and platform_setup(). For our imaginary board, this
might look something like:
-/*
- * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
- */
-#include <linux/init.h>
+.. code-block:: c
+
+ /*
+ * arch/sh/boards/vapor/setup.c - Setup code for imaginary board
+ */
+ #include <linux/init.h>
-const char *get_system_type(void)
-{
- return "FooTech Vaporboard";
-}
+ const char *get_system_type(void)
+ {
+ return "FooTech Vaporboard";
+ }
-int __init platform_setup(void)
-{
+ int __init platform_setup(void)
+ {
/*
* If our hardware actually existed, we would do real
* setup here. Though it's also sane to leave this empty
@@ -136,7 +140,8 @@ int __init platform_setup(void)
/* And whatever else ... */
return 0;
-}
+ }
+
Our new imaginary board will also have to tie into the machvec in order for it
to be of any use.
@@ -172,16 +177,17 @@ sufficient.
vector.
Note that these prototypes are generated automatically by setting
- __IO_PREFIX to something sensible. A typical example would be:
+ __IO_PREFIX to something sensible. A typical example would be::
#define __IO_PREFIX vapor
#include <asm/io_generic.h>
+
somewhere in the board-specific header. Any boards being ported that still
have a legacy io.h should remove it entirely and switch to the new model.
- Add machine vector definitions to the board's setup.c. At a bare minimum,
- this must be defined as something like:
+ this must be defined as something like::
struct sh_machine_vector mv_vapor __initmv = {
.mv_name = "vapor",
@@ -202,11 +208,11 @@ Large portions of the build system are now entirely dynamic, and merely
require the proper entry here and there in order to get things done.
The first thing to do is to add an entry to arch/sh/Kconfig, under the
-"System type" menu:
+"System type" menu::
-config SH_VAPOR
- bool "Vapor"
- help
+ config SH_VAPOR
+ bool "Vapor"
+ help
select Vapor if configuring for a FooTech Vaporboard.
next, this has to be added into arch/sh/Makefile. All boards require a
@@ -232,6 +238,8 @@ space restating it here. After this is done, you will be able to use
implicit checks for your board if you need this somewhere throughout the
common code, such as:
+::
+
/* Make sure we're on the FooTech Vaporboard */
if (!mach_is_vapor())
return -ENODEV;
@@ -253,12 +261,13 @@ build target, and it will be implicitly listed as such in the help text.
Looking at the 'make help' output, you should now see something like:
Architecture specific targets (sh):
- zImage - Compressed kernel image (arch/sh/boot/zImage)
- adx_defconfig - Build for adx
- cqreek_defconfig - Build for cqreek
- dreamcast_defconfig - Build for dreamcast
-...
- vapor_defconfig - Build for vapor
+
+ - zImage - Compressed kernel image (arch/sh/boot/zImage)
+ - adx_defconfig - Build for adx
+ - cqreek_defconfig - Build for cqreek
+ - dreamcast_defconfig - Build for dreamcast
+ - ...
+ - vapor_defconfig - Build for vapor
which then allows you to do:
diff --git a/Documentation/sh/register-banks.txt b/Documentation/sh/register-banks.rst
similarity index 90%
rename from Documentation/sh/register-banks.txt
rename to Documentation/sh/register-banks.rst
index a6719f2f6594..acccfaf80355 100644
--- a/Documentation/sh/register-banks.txt
+++ b/Documentation/sh/register-banks.rst
@@ -1,8 +1,9 @@
- Notes on register bank usage in the kernel
- ==========================================
+==========================================
+Notes on register bank usage in the kernel
+==========================================
Introduction
-------------
+============
The SH-3 and SH-4 CPU families traditionally include a single partial register
bank (selected by SR.RB, only r0 ... r7 are banked), whereas other families
@@ -30,4 +31,3 @@ Presently the kernel uses several of these registers.
- The SR.IMASK interrupt handler makes use of this to set the
interrupt priority level (used by local_irq_enable())
- r7_bank (current)
-
--
2.17.1
^ permalink raw reply related
* Re: [tip:timers/core] hrtimer: Use a bullet for the returns bullet list
From: Mauro Carvalho Chehab @ 2019-06-28 13:10 UTC (permalink / raw)
To: Joe Perches
Cc: corbet, linux-doc, tglx, mingo, hpa, linux-kernel,
mchehab+samsung, linux-tip-commits, docutils-develop
In-Reply-To: <2f1c88882fde00beebb6066e9bd561287f5932c5.camel@perches.com>
Em Thu, 27 Jun 2019 19:40:24 -0700
Joe Perches <joe@perches.com> escreveu:
> On Thu, 2019-06-27 at 21:39 -0300, Mauro Carvalho Chehab wrote:
> > Em Thu, 27 Jun 2019 15:08:59 -0700
> > Joe Perches <joe@perches.com> escreveu:
> []
> > > > hrtimer: Use a bullet for the returns bullet list
> > > >
> > > > That gets rid of this warning:
> > > >
> > > > ./kernel/time/hrtimer.c:1119: WARNING: Block quote ends without a blank line; unexpected unindent.
> > >
> > > Doesn't this form occur multiple dozens of times in
> > > kernel sources?
> > >
> > > For instance:
> > >
> > > $ git grep -B3 -A5 -P "^ \* Returns:?$" | \
> > > grep -P -A8 '\-\s+\*\s*@\w+:'
> >
> > Yes, this is a common pattern, but not all patterns that match the above
> > regex are broken.
> >
> > > I think the warning is odd at best and docutils might
> > > be updated or the warning ignored or suppressed.
> > >
> > > > and displays nicely both at the source code and at the produced
> > > > documentation.
> >
> > The warnings are painful - and they're the main reason why I wrote this
> > change: - I wanted to avoid new warnings actually unrelated to my
> > changes that were sometimes appearing while doing incremental
> > "make htmldocs" on a big patchset that I've been rebasing almost every
> > week over the last two months.
> >
> > -
> >
> > Yet, did you try to look how this pattern will appear at the html and pdf
> > output?
>
> No I did not.
>
> I just would like to avoid changing perfectly intelligible
> kernel-doc content into something less directly readable for
> the sake of external output.
>
> I don't use the externally generated formatted output docs.
> I read and use the source when necessary.
Yeah, I do the same too, except when I want to se the hole
picture or on complex subsystems. You can't really understand
media subsystems if you don't read it from the docs, as
the rationale for a lot of things are there.
Yet, for newcomers that are studying a new subsystem, a
good documentation helps a lot.
>
> Automatic creation of bulleted blocks from relatively
> unformatted content is a hard problem.
>
> I appreciate the work Mauro, I just would like to minimize
> the necessary changes if possible.
Yeah, me too.
>
> The grep I did was trivial, I'm sure there are better tools
> to isolate the kernel-doc bits where the Return: block
> is emitted.
>
>
> > Something like this:
> >
> > sound/soc/codecs/wm8960.c: * Returns:
> > sound/soc/codecs/wm8960.c- * -1, in case no sysclk frequency available found
> > sound/soc/codecs/wm8960.c- * >=0, in case we could derive bclk and lrclk from sysclk using
> > sound/soc/codecs/wm8960.c- * (@sysclk_idx, @dac_idx, @bclk_idx) dividers
> >
> >
> > Will be displayed as:
> >
> > **Returns:**
> > -1, in case no sysclk frequency available found **>=0, in case we could derive bclk and lrclk from sysclk using** (@sysclk_idx, @dac_idx, @bclk_idx) dividers
> > (where **foo**) means that "foo" will be printed in bold.>
>
> That's a yuck from me.
Agreed, but, when writing text docs, doing something like:
parameter
parameter description
and getting the first line bolded helps to reduce the need of
adding explicit bold markups and produce a nice visual.
>
> > While it would likely be possible to improve kernel-doc to present better
> > results, I'm afraid that it would be too complex for simple regex
> > expressions, and hard to tune, as it would be a hint-based approach,
> > and doing a natural language processing would be too much effort.
>
> Yeah, tough problem. I don't envy it.
>
> cheers and g'luck...
Thank you!
Thanks,
Mauro
^ permalink raw reply
* Re: [PATCH 1/9] hrtimer: Use a bullet for the returns bullet list
From: Mauro Carvalho Chehab @ 2019-06-28 13:03 UTC (permalink / raw)
To: Joe Perches
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Thomas Gleixner
In-Reply-To: <951e47de7dd6d86516c25ceb855c4b64f13fb65d.camel@perches.com>
Em Fri, 28 Jun 2019 05:39:25 -0700
Joe Perches <joe@perches.com> escreveu:
> On Fri, 2019-06-28 at 09:12 -0300, Mauro Carvalho Chehab wrote:
> > That gets rid of this warning:
> >
> > ./kernel/time/hrtimer.c:1119: WARNING: Block quote ends without a blank line; unexpected unindent.
> >
> > and displays nicely both at the source code and at the produced
> > documentation.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> > kernel/time/hrtimer.c | 7 ++++---
> > 1 file changed, 4 insertions(+), 3 deletions(-)
> >
> > diff --git a/kernel/time/hrtimer.c b/kernel/time/hrtimer.c
> > index edb230aba3d1..5ee77f1a8a92 100644
> > --- a/kernel/time/hrtimer.c
> > +++ b/kernel/time/hrtimer.c
> > @@ -1114,9 +1114,10 @@ EXPORT_SYMBOL_GPL(hrtimer_start_range_ns);
> > * @timer: hrtimer to stop
> > *
> > * Returns:
> > - * 0 when the timer was not active
> > - * 1 when the timer was active
> > - * -1 when the timer is currently executing the callback function and
> > + *
> > + * * 0 when the timer was not active
> > + * * 1 when the timer was active
> > + * * -1 when the timer is currently executing the callback function and
> > * cannot be stopped
>
> I think this last line should be indented 3 more spaces too
That would produce a warning, and will change the font for the content of
the first line to bold.
ReST is pedantic with whitespaces, as it uses it to identify continuation
lines.
For it to consider one line as a continuation of the previous one, the texts
on both lines (after markups) should start at the same place.
So, on:
* foo
bar
"bar" is considered a continuation of the first line. So, identical to:
* foo bar
But:
* foo bar
foobar
the whitespace doesn't match. it will change the font for the first line
to bold, and place foobar on a separate line.
(yeah, I know that, for kernel-doc, this sucks)
Thanks,
Mauro
^ permalink raw reply
* Re: [PATCH 37/39] docs: adds some directories to the main documentation index
From: Bartlomiej Zolnierkiewicz @ 2019-06-28 12:55 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Jens Axboe, Akinobu Mita, Moritz Fischer,
David S. Miller, Masahiro Yamada, Michal Marek, Josh Poimboeuf,
Jiri Kosina, Miroslav Benes, Petr Mladek, Joe Lawrence,
Paul Moore, Dominik Brodowski, Rafael J. Wysocki, Len Brown,
Pavel Machek, Martin K. Petersen, Thomas Gleixner,
Wim Van Sebroeck, Guenter Roeck, dri-devel, linux-fbdev,
linux-fpga, linux-ide, linux-kbuild, live-patching, netdev,
linux-security-module, linux-pm, linux-scsi, target-devel,
linux-watchdog
In-Reply-To: <b26fc645cb2c81fe88ab13616c65664d2c3cead5.1561724493.git.mchehab+samsung@kernel.org>
On 6/28/19 2:30 PM, Mauro Carvalho Chehab wrote:
> The contents of those directories were orphaned at the documentation
> body.
>
> While those directories could likely be moved to be inside some guide,
> I'm opting to just adding their indexes to the main one, removing the
> :orphan: and adding the SPDX header.
>
> For the drivers, the rationale is that the documentation contains
> a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on
> separate directories, as we've be doing with similar subsystem-specific
> docs that were not split yet.
>
> For the others, well... I'm too lazy to do the move. Also, it
> seems to make sense to keep at least some of those at the main
> dir (like kbuild, for example). In any case, a latter patch
> could do the move.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
> ---
> Documentation/cdrom/index.rst | 2 +-
> Documentation/fault-injection/index.rst | 2 +-
> Documentation/fb/index.rst | 2 +-
> Documentation/fpga/index.rst | 2 +-
> Documentation/ide/index.rst | 2 +-
> Documentation/index.rst | 14 ++++++++++++++
> Documentation/kbuild/index.rst | 2 +-
> Documentation/livepatch/index.rst | 2 +-
> Documentation/netlabel/index.rst | 2 +-
> Documentation/pcmcia/index.rst | 2 +-
> Documentation/power/index.rst | 2 +-
> Documentation/target/index.rst | 2 +-
> Documentation/timers/index.rst | 2 +-
> Documentation/watchdog/index.rst | 2 +-
> 14 files changed, 27 insertions(+), 13 deletions(-)
Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics
^ permalink raw reply
* Re: [PATCH 28/39] docs: admin-guide: add a series of orphaned documents
From: Bartlomiej Zolnierkiewicz @ 2019-06-28 12:54 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Alasdair Kergon, Mike Snitzer, dm-devel,
Ard Biesheuvel, Matt Mackall, Herbert Xu, Willy Tarreau,
Ksenija Stanojevic, Richard Russon (FlatCap), Alessandro Zummo,
Alexandre Belloni, Martin Mares, Thomas Gleixner, Ingo Molnar,
Borislav Petkov, H. Peter Anvin, x86, Russell King,
James E.J. Bottomley, Helge Deller, Yoshinori Sato, Rich Felker,
David S. Miller, Jens Axboe, Arnd Bergmann, Greg Kroah-Hartman,
linux-efi, linux-crypto, linux-ntfs-dev, linux-rtc, linux-video,
dri-devel, linux-fbdev, linux-arm-kernel, linux-parisc, linux-sh,
sparclinux, linux-block
In-Reply-To: <7ee0e33575633f689203f582259c2cbdce477176.1561724493.git.mchehab+samsung@kernel.org>
On 6/28/19 2:30 PM, Mauro Carvalho Chehab wrote:
> There are lots of documents that belong to the admin-guide but
> are on random places (most under Documentation root dir).
>
> Move them to the admin guide.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
> ---
> Documentation/ABI/stable/sysfs-devices-node | 2 +-
> Documentation/ABI/testing/procfs-diskstats | 2 +-
> Documentation/ABI/testing/sysfs-block | 2 +-
> .../ABI/testing/sysfs-devices-system-cpu | 4 ++--
> .../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
> .../clearing-warn-once.rst} | 0
> .../{cpu-load.txt => admin-guide/cpu-load.rst} | 0
> .../cputopology.rst} | 0
> .../admin-guide/device-mapper/statistics.rst | 4 ++--
> .../{efi-stub.txt => admin-guide/efi-stub.rst} | 0
> .../{highuid.txt => admin-guide/highuid.rst} | 0
> Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
> .../hw_random.rst} | 0
> Documentation/admin-guide/index.rst | 17 +++++++++++++++++
> .../{iostats.txt => admin-guide/iostats.rst} | 0
> Documentation/admin-guide/kernel-parameters.txt | 2 +-
> .../kernel-per-CPU-kthreads.rst} | 0
> .../lcd-panel-cgram.rst | 2 --
> Documentation/{ldm.txt => admin-guide/ldm.rst} | 0
> .../lockup-watchdogs.rst} | 0
> .../mm/cma_debugfs.rst} | 2 --
> Documentation/admin-guide/mm/index.rst | 1 +
> .../{numastat.txt => admin-guide/numastat.rst} | 0
> Documentation/{pnp.txt => admin-guide/pnp.rst} | 0
> Documentation/{rtc.txt => admin-guide/rtc.rst} | 0
> .../{svga.txt => admin-guide/svga.rst} | 0
> Documentation/admin-guide/sysctl/kernel.rst | 2 +-
> .../video-output.rst} | 0
> Documentation/fb/vesafb.rst | 2 +-
> Documentation/x86/topology.rst | 2 +-
> MAINTAINERS | 12 ++++++------
> arch/arm/Kconfig | 2 +-
> arch/parisc/Kconfig | 2 +-
> arch/sh/Kconfig | 2 +-
> arch/sparc/Kconfig | 2 +-
> arch/x86/Kconfig | 4 ++--
> block/partitions/Kconfig | 2 +-
> drivers/char/Kconfig | 4 ++--
> drivers/char/hw_random/core.c | 2 +-
> include/linux/hw_random.h | 2 +-
> 40 files changed, 47 insertions(+), 33 deletions(-)
> rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
> rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%)
> rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%)
> rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%)
> rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
> rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%)
> rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%)
> rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%)
> rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (100%)
> rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)
> rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%)
> rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%)
> rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
> rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%)
> rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%)
> rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%)
> rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
> rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)
Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics
^ permalink raw reply
* Re: [PATCH 11/43] docs: console.txt: convert docs to ReST and rename to *.rst
From: Bartlomiej Zolnierkiewicz @ 2019-06-28 12:53 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Greg Kroah-Hartman, Jiri Slaby, dri-devel,
linux-fbdev
In-Reply-To: <e8cee712026b042eacf3e003a57578d963f24ad8.1561723980.git.mchehab+samsung@kernel.org>
On 6/28/19 2:20 PM, Mauro Carvalho Chehab wrote:
> Convert this small file to ReST in preparation for adding it to
> the driver-api book.
>
> While this is not part of the driver-api book, mark it as
> :orphan:, in order to avoid build warnings.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
> ---
> .../console/{console.txt => console.rst} | 63 ++++++++++---------
> Documentation/fb/fbcon.rst | 4 +-
> drivers/tty/Kconfig | 2 +-
> 3 files changed, 38 insertions(+), 31 deletions(-)
> rename Documentation/console/{console.txt => console.rst} (80%)
Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics
^ permalink raw reply
* Re: [PATCH 28/39] docs: admin-guide: add a series of orphaned documents
From: Alexandre Belloni @ 2019-06-28 12:43 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Alasdair Kergon, Mike Snitzer, dm-devel,
Ard Biesheuvel, Matt Mackall, Herbert Xu, Willy Tarreau,
Ksenija Stanojevic, Richard Russon (FlatCap), Alessandro Zummo,
Martin Mares, Bartlomiej Zolnierkiewicz, Thomas Gleixner,
Ingo Molnar, Borislav Petkov, H. Peter Anvin, x86, Russell King,
James E.J. Bottomley, Helge Deller, Yoshinori Sato, Rich Felker,
David S. Miller, Jens Axboe, Arnd Bergmann, Greg Kroah-Hartman,
linux-efi, linux-crypto, linux-ntfs-dev, linux-rtc, linux-video,
dri-devel, linux-fbdev, linux-arm-kernel, linux-parisc, linux-sh,
sparclinux, linux-block
In-Reply-To: <7ee0e33575633f689203f582259c2cbdce477176.1561724493.git.mchehab+samsung@kernel.org>
On 28/06/2019 09:30:21-0300, Mauro Carvalho Chehab wrote:
> There are lots of documents that belong to the admin-guide but
> are on random places (most under Documentation root dir).
>
> Move them to the admin guide.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
> ---
> Documentation/ABI/stable/sysfs-devices-node | 2 +-
> Documentation/ABI/testing/procfs-diskstats | 2 +-
> Documentation/ABI/testing/sysfs-block | 2 +-
> .../ABI/testing/sysfs-devices-system-cpu | 4 ++--
> .../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
> .../clearing-warn-once.rst} | 0
> .../{cpu-load.txt => admin-guide/cpu-load.rst} | 0
> .../cputopology.rst} | 0
> .../admin-guide/device-mapper/statistics.rst | 4 ++--
> .../{efi-stub.txt => admin-guide/efi-stub.rst} | 0
> .../{highuid.txt => admin-guide/highuid.rst} | 0
> Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
> .../hw_random.rst} | 0
> Documentation/admin-guide/index.rst | 17 +++++++++++++++++
> .../{iostats.txt => admin-guide/iostats.rst} | 0
> Documentation/admin-guide/kernel-parameters.txt | 2 +-
> .../kernel-per-CPU-kthreads.rst} | 0
> .../lcd-panel-cgram.rst | 2 --
> Documentation/{ldm.txt => admin-guide/ldm.rst} | 0
> .../lockup-watchdogs.rst} | 0
> .../mm/cma_debugfs.rst} | 2 --
> Documentation/admin-guide/mm/index.rst | 1 +
> .../{numastat.txt => admin-guide/numastat.rst} | 0
> Documentation/{pnp.txt => admin-guide/pnp.rst} | 0
> Documentation/{rtc.txt => admin-guide/rtc.rst} | 0
> .../{svga.txt => admin-guide/svga.rst} | 0
> Documentation/admin-guide/sysctl/kernel.rst | 2 +-
> .../video-output.rst} | 0
> Documentation/fb/vesafb.rst | 2 +-
> Documentation/x86/topology.rst | 2 +-
> MAINTAINERS | 12 ++++++------
> arch/arm/Kconfig | 2 +-
> arch/parisc/Kconfig | 2 +-
> arch/sh/Kconfig | 2 +-
> arch/sparc/Kconfig | 2 +-
> arch/x86/Kconfig | 4 ++--
> block/partitions/Kconfig | 2 +-
> drivers/char/Kconfig | 4 ++--
> drivers/char/hw_random/core.c | 2 +-
> include/linux/hw_random.h | 2 +-
> 40 files changed, 47 insertions(+), 33 deletions(-)
> rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
> rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%)
> rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%)
> rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%)
> rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
> rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%)
> rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%)
> rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%)
> rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (100%)
> rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)
> rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%)
> rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%)
> rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
> rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%)
> rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%)
> rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%)
> rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
> rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)
>
> diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node
> index f7ce68fbd4b9..df8413cf1468 100644
> --- a/Documentation/ABI/stable/sysfs-devices-node
> +++ b/Documentation/ABI/stable/sysfs-devices-node
> @@ -61,7 +61,7 @@ Date: October 2002
> Contact: Linux Memory Management list <linux-mm@kvack.org>
> Description:
> The node's hit/miss statistics, in units of pages.
> - See Documentation/numastat.txt
> + See Documentation/admin-guide/numastat.rst
>
> What: /sys/devices/system/node/nodeX/distance
> Date: October 2002
> diff --git a/Documentation/ABI/testing/procfs-diskstats b/Documentation/ABI/testing/procfs-diskstats
> index abac31d216de..2c44b4f1b060 100644
> --- a/Documentation/ABI/testing/procfs-diskstats
> +++ b/Documentation/ABI/testing/procfs-diskstats
> @@ -29,4 +29,4 @@ Description:
> 17 - sectors discarded
> 18 - time spent discarding
>
> - For more details refer to Documentation/iostats.txt
> + For more details refer to Documentation/admin-guide/iostats.rst
> diff --git a/Documentation/ABI/testing/sysfs-block b/Documentation/ABI/testing/sysfs-block
> index dfad7427817c..f8c7c7126bb1 100644
> --- a/Documentation/ABI/testing/sysfs-block
> +++ b/Documentation/ABI/testing/sysfs-block
> @@ -15,7 +15,7 @@ Description:
> 9 - I/Os currently in progress
> 10 - time spent doing I/Os (ms)
> 11 - weighted time spent doing I/Os (ms)
> - For more details refer Documentation/iostats.txt
> + For more details refer Documentation/admin-guide/iostats.rst
>
>
> What: /sys/block/<disk>/<part>/stat
> diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu
> index d404603c6b52..5f7d7b14fa44 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-cpu
> +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu
> @@ -34,7 +34,7 @@ Description: CPU topology files that describe kernel limits related to
> present: cpus that have been identified as being present in
> the system.
>
> - See Documentation/cputopology.txt for more information.
> + See Documentation/admin-guide/cputopology.rst for more information.
>
>
> What: /sys/devices/system/cpu/probe
> @@ -103,7 +103,7 @@ Description: CPU topology files that describe a logical CPU's relationship
> thread_siblings_list: human-readable list of cpu#'s hardware
> threads within the same core as cpu#
>
> - See Documentation/cputopology.txt for more information.
> + See Documentation/admin-guide/cputopology.rst for more information.
>
>
> What: /sys/devices/system/cpu/cpuidle/current_driver
> diff --git a/Documentation/btmrvl.txt b/Documentation/admin-guide/btmrvl.rst
> similarity index 100%
> rename from Documentation/btmrvl.txt
> rename to Documentation/admin-guide/btmrvl.rst
> diff --git a/Documentation/clearing-warn-once.txt b/Documentation/admin-guide/clearing-warn-once.rst
> similarity index 100%
> rename from Documentation/clearing-warn-once.txt
> rename to Documentation/admin-guide/clearing-warn-once.rst
> diff --git a/Documentation/cpu-load.txt b/Documentation/admin-guide/cpu-load.rst
> similarity index 100%
> rename from Documentation/cpu-load.txt
> rename to Documentation/admin-guide/cpu-load.rst
> diff --git a/Documentation/cputopology.txt b/Documentation/admin-guide/cputopology.rst
> similarity index 100%
> rename from Documentation/cputopology.txt
> rename to Documentation/admin-guide/cputopology.rst
> diff --git a/Documentation/admin-guide/device-mapper/statistics.rst b/Documentation/admin-guide/device-mapper/statistics.rst
> index 3d80a9f850cc..41ded0bc5933 100644
> --- a/Documentation/admin-guide/device-mapper/statistics.rst
> +++ b/Documentation/admin-guide/device-mapper/statistics.rst
> @@ -13,7 +13,7 @@ the range specified.
>
> The I/O statistics counters for each step-sized area of a region are
> in the same format as `/sys/block/*/stat` or `/proc/diskstats` (see:
> -Documentation/iostats.txt). But two extra counters (12 and 13) are
> +Documentation/admin-guide/iostats.rst). But two extra counters (12 and 13) are
> provided: total time spent reading and writing. When the histogram
> argument is used, the 14th parameter is reported that represents the
> histogram of latencies. All these counters may be accessed by sending
> @@ -151,7 +151,7 @@ Messages
> The first 11 counters have the same meaning as
> `/sys/block/*/stat or /proc/diskstats`.
>
> - Please refer to Documentation/iostats.txt for details.
> + Please refer to Documentation/admin-guide/iostats.rst for details.
>
> 1. the number of reads completed
> 2. the number of reads merged
> diff --git a/Documentation/efi-stub.txt b/Documentation/admin-guide/efi-stub.rst
> similarity index 100%
> rename from Documentation/efi-stub.txt
> rename to Documentation/admin-guide/efi-stub.rst
> diff --git a/Documentation/highuid.txt b/Documentation/admin-guide/highuid.rst
> similarity index 100%
> rename from Documentation/highuid.txt
> rename to Documentation/admin-guide/highuid.rst
> diff --git a/Documentation/admin-guide/hw-vuln/l1tf.rst b/Documentation/admin-guide/hw-vuln/l1tf.rst
> index 656aee262e23..f83212fae4d5 100644
> --- a/Documentation/admin-guide/hw-vuln/l1tf.rst
> +++ b/Documentation/admin-guide/hw-vuln/l1tf.rst
> @@ -241,7 +241,7 @@ Guest mitigation mechanisms
> For further information about confining guests to a single or to a group
> of cores consult the cpusets documentation:
>
> - https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.rst
> + https://www.kernel.org/doc/Documentation/admin-guide/cgroup-v1/cpusets.rst
>
> .. _interrupt_isolation:
>
> diff --git a/Documentation/hw_random.txt b/Documentation/admin-guide/hw_random.rst
> similarity index 100%
> rename from Documentation/hw_random.txt
> rename to Documentation/admin-guide/hw_random.rst
> diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
> index d5064f1802c1..2c20607e90cd 100644
> --- a/Documentation/admin-guide/index.rst
> +++ b/Documentation/admin-guide/index.rst
> @@ -84,8 +84,25 @@ configure specific aspects of kernel behavior to your liking.
> perf-security
> acpi/index
> aoe/index
> + btmrvl
> + clearing-warn-once
> + cpu-load
> + cputopology
> device-mapper/index
> + efi-stub
> + highuid
> + hw_random
> + iostats
> + kernel-per-CPU-kthreads
> laptops/index
> + lcd-panel-cgram
> + ldm
> + lockup-watchdogs
> + numastat
> + pnp
> + rtc
> + svga
> + video-output
>
> .. only:: subproject and html
>
> diff --git a/Documentation/iostats.txt b/Documentation/admin-guide/iostats.rst
> similarity index 100%
> rename from Documentation/iostats.txt
> rename to Documentation/admin-guide/iostats.rst
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index e833133c8897..713d6f378fbe 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -5092,7 +5092,7 @@
>
> vga= [BOOT,X86-32] Select a particular video mode
> See Documentation/x86/boot.rst and
> - Documentation/svga.txt.
> + Documentation/admin-guide/svga.rst.
> Use vga=ask for menu.
> This is actually a boot loader parameter; the value is
> passed to the kernel using a special protocol.
> diff --git a/Documentation/kernel-per-CPU-kthreads.txt b/Documentation/admin-guide/kernel-per-CPU-kthreads.rst
> similarity index 100%
> rename from Documentation/kernel-per-CPU-kthreads.txt
> rename to Documentation/admin-guide/kernel-per-CPU-kthreads.rst
> diff --git a/Documentation/auxdisplay/lcd-panel-cgram.rst b/Documentation/admin-guide/lcd-panel-cgram.rst
> similarity index 99%
> rename from Documentation/auxdisplay/lcd-panel-cgram.rst
> rename to Documentation/admin-guide/lcd-panel-cgram.rst
> index dfef50286018..a3eb00c62f53 100644
> --- a/Documentation/auxdisplay/lcd-panel-cgram.rst
> +++ b/Documentation/admin-guide/lcd-panel-cgram.rst
> @@ -1,5 +1,3 @@
> -:orphan:
> -
> ======================================
> Parallel port LCD/Keypad Panel support
> ======================================
> diff --git a/Documentation/ldm.txt b/Documentation/admin-guide/ldm.rst
> similarity index 100%
> rename from Documentation/ldm.txt
> rename to Documentation/admin-guide/ldm.rst
> diff --git a/Documentation/lockup-watchdogs.txt b/Documentation/admin-guide/lockup-watchdogs.rst
> similarity index 100%
> rename from Documentation/lockup-watchdogs.txt
> rename to Documentation/admin-guide/lockup-watchdogs.rst
> diff --git a/Documentation/cma/debugfs.rst b/Documentation/admin-guide/mm/cma_debugfs.rst
> similarity index 98%
> rename from Documentation/cma/debugfs.rst
> rename to Documentation/admin-guide/mm/cma_debugfs.rst
> index 518fe401b5ee..4e06ffabd78a 100644
> --- a/Documentation/cma/debugfs.rst
> +++ b/Documentation/admin-guide/mm/cma_debugfs.rst
> @@ -1,5 +1,3 @@
> -:orphan:
> -
> =====================
> CMA Debugfs Interface
> =====================
> diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
> index 5f61a6c429e0..11db46448354 100644
> --- a/Documentation/admin-guide/mm/index.rst
> +++ b/Documentation/admin-guide/mm/index.rst
> @@ -26,6 +26,7 @@ the Linux memory management.
> :maxdepth: 1
>
> concepts
> + cma_debugfs
> hugetlbpage
> idle_page_tracking
> ksm
> diff --git a/Documentation/numastat.txt b/Documentation/admin-guide/numastat.rst
> similarity index 100%
> rename from Documentation/numastat.txt
> rename to Documentation/admin-guide/numastat.rst
> diff --git a/Documentation/pnp.txt b/Documentation/admin-guide/pnp.rst
> similarity index 100%
> rename from Documentation/pnp.txt
> rename to Documentation/admin-guide/pnp.rst
> diff --git a/Documentation/rtc.txt b/Documentation/admin-guide/rtc.rst
> similarity index 100%
> rename from Documentation/rtc.txt
> rename to Documentation/admin-guide/rtc.rst
> diff --git a/Documentation/svga.txt b/Documentation/admin-guide/svga.rst
> similarity index 100%
> rename from Documentation/svga.txt
> rename to Documentation/admin-guide/svga.rst
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index a0c1d4ce403a..032c7cd3cede 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -327,7 +327,7 @@ when a hard lockup is detected.
> 0 - don't panic on hard lockup
> 1 - panic on hard lockup
>
> -See Documentation/lockup-watchdogs.txt for more information. This can
> +See Documentation/admin-guide/lockup-watchdogs.rst for more information. This can
> also be set using the nmi_watchdog kernel parameter.
>
>
> diff --git a/Documentation/video-output.txt b/Documentation/admin-guide/video-output.rst
> similarity index 100%
> rename from Documentation/video-output.txt
> rename to Documentation/admin-guide/video-output.rst
> diff --git a/Documentation/fb/vesafb.rst b/Documentation/fb/vesafb.rst
> index 2ed0dfb661cf..6821c87b7893 100644
> --- a/Documentation/fb/vesafb.rst
> +++ b/Documentation/fb/vesafb.rst
> @@ -30,7 +30,7 @@ How to use it?
> ==============
>
> Switching modes is done using the vga=... boot parameter. Read
> -Documentation/svga.txt for details.
> +Documentation/admin-guide/svga.rst for details.
>
> You should compile in both vgacon (for text mode) and vesafb (for
> graphics mode). Which of them takes over the console depends on
> diff --git a/Documentation/x86/topology.rst b/Documentation/x86/topology.rst
> index 8e9704f61017..e29739904e37 100644
> --- a/Documentation/x86/topology.rst
> +++ b/Documentation/x86/topology.rst
> @@ -9,7 +9,7 @@ representation in the kernel. Update/change when doing changes to the
> respective code.
>
> The architecture-agnostic topology definitions are in
> -Documentation/cputopology.txt. This file holds x86-specific
> +Documentation/admin-guide/cputopology.rst. This file holds x86-specific
> differences/specialities which must not necessarily apply to the generic
> definitions. Thus, the way to read up on Linux topology on x86 is to start
> with the generic one and look at this one in parallel for the x86 specifics.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 82222aa618c5..76b52a20663e 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -6054,7 +6054,7 @@ M: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> L: linux-efi@vger.kernel.org
> T: git git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi.git
> S: Maintained
> -F: Documentation/efi-stub.txt
> +F: Documentation/admin-guide/efi-stub.rst
> F: arch/*/kernel/efi.c
> F: arch/x86/boot/compressed/eboot.[ch]
> F: arch/*/include/asm/efi.h
> @@ -7033,7 +7033,7 @@ M: Herbert Xu <herbert@gondor.apana.org.au>
> L: linux-crypto@vger.kernel.org
> S: Odd fixes
> F: Documentation/devicetree/bindings/rng/
> -F: Documentation/hw_random.txt
> +F: Documentation/admin-guide/hw_random.rst
> F: drivers/char/hw_random/
> F: include/linux/hw_random.h
>
> @@ -9347,7 +9347,7 @@ M: "Richard Russon (FlatCap)" <ldm@flatcap.org>
> L: linux-ntfs-dev@lists.sourceforge.net
> W: http://www.linux-ntfs.org/content/view/19/37/
> S: Maintained
> -F: Documentation/ldm.txt
> +F: Documentation/admin-guide/ldm.rst
> F: block/partitions/ldm.*
>
> LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI)
> @@ -12000,7 +12000,7 @@ PARALLEL LCD/KEYPAD PANEL DRIVER
> M: Willy Tarreau <willy@haproxy.com>
> M: Ksenija Stanojevic <ksenija.stanojevic@gmail.com>
> S: Odd Fixes
> -F: Documentation/auxdisplay/lcd-panel-cgram.rst
> +F: Documentation/admin-guide/lcd-panel-cgram.rst
> F: drivers/auxdisplay/panel.c
>
> PARALLEL PORT SUBSYSTEM
> @@ -13419,7 +13419,7 @@ Q: http://patchwork.ozlabs.org/project/rtc-linux/list/
> T: git git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux.git
> S: Maintained
> F: Documentation/devicetree/bindings/rtc/
> -F: Documentation/rtc.txt
> +F: Documentation/admin-guide/rtc.rst
> F: drivers/rtc/
> F: include/linux/rtc.h
> F: include/uapi/linux/rtc.h
> @@ -15248,7 +15248,7 @@ SVGA HANDLING
> M: Martin Mares <mj@ucw.cz>
> L: linux-video@atrey.karlin.mff.cuni.cz
> S: Maintained
> -F: Documentation/svga.txt
> +F: Documentation/admin-guide/svga.rst
> F: arch/x86/boot/video*
>
> SWIOTLB SUBSYSTEM
> diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig
> index d5bd4350fcbd..b1ab350b9d60 100644
> --- a/arch/arm/Kconfig
> +++ b/arch/arm/Kconfig
> @@ -1286,7 +1286,7 @@ config SMP
> will run faster if you say N here.
>
> See also <file:Documentation/x86/i386/IO-APIC.rst>,
> - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at
> + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at
> <http://tldp.org/HOWTO/SMP-HOWTO.html>.
>
> If you don't know what to do here, say N.
> diff --git a/arch/parisc/Kconfig b/arch/parisc/Kconfig
> index 42875ff15671..6d732e451071 100644
> --- a/arch/parisc/Kconfig
> +++ b/arch/parisc/Kconfig
> @@ -277,7 +277,7 @@ config SMP
> machines, but will use only one CPU of a multiprocessor machine.
> On a uniprocessor machine, the kernel will run faster if you say N.
>
> - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO
> + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO
> available at <http://www.tldp.org/docs.html#howto>.
>
> If you don't know what to do here, say N.
> diff --git a/arch/sh/Kconfig b/arch/sh/Kconfig
> index c2858ac6a46a..6b1b5941b618 100644
> --- a/arch/sh/Kconfig
> +++ b/arch/sh/Kconfig
> @@ -679,7 +679,7 @@ config SMP
> People using multiprocessor machines who say Y here should also say
> Y to "Enhanced Real Time Clock Support", below.
>
> - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO
> + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO
> available at <http://www.tldp.org/docs.html#howto>.
>
> If you don't know what to do here, say N.
> diff --git a/arch/sparc/Kconfig b/arch/sparc/Kconfig
> index e9f5d62e9817..7926a2e11bdc 100644
> --- a/arch/sparc/Kconfig
> +++ b/arch/sparc/Kconfig
> @@ -180,7 +180,7 @@ config SMP
> Y to "Enhanced Real Time Clock Support", below. The "Advanced Power
> Management" code will be disabled if you say Y here.
>
> - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO
> + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO
> available at <http://www.tldp.org/docs.html#howto>.
>
> If you don't know what to do here, say N.
> diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
> index 489fd833b980..2ca471ae6756 100644
> --- a/arch/x86/Kconfig
> +++ b/arch/x86/Kconfig
> @@ -402,7 +402,7 @@ config SMP
> Management" code will be disabled if you say Y here.
>
> See also <file:Documentation/x86/i386/IO-APIC.rst>,
> - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at
> + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at
> <http://www.tldp.org/docs.html#howto>.
>
> If you don't know what to do here, say N.
> @@ -1959,7 +1959,7 @@ config EFI_STUB
> This kernel feature allows a bzImage to be loaded directly
> by EFI firmware without the use of a bootloader.
>
> - See Documentation/efi-stub.txt for more information.
> + See Documentation/admin-guide/efi-stub.rst for more information.
>
> config EFI_MIXED
> bool "EFI mixed-mode support"
> diff --git a/block/partitions/Kconfig b/block/partitions/Kconfig
> index 37b9710cc80a..702689a628f0 100644
> --- a/block/partitions/Kconfig
> +++ b/block/partitions/Kconfig
> @@ -194,7 +194,7 @@ config LDM_PARTITION
> Normal partitions are now called Basic Disks under Windows 2000, XP,
> and Vista.
>
> - For a fuller description read <file:Documentation/ldm.txt>.
> + For a fuller description read <file:Documentation/admin-guide/ldm.rst>.
>
> If unsure, say N.
>
> diff --git a/drivers/char/Kconfig b/drivers/char/Kconfig
> index 442403abd73a..3e866885a405 100644
> --- a/drivers/char/Kconfig
> +++ b/drivers/char/Kconfig
> @@ -291,7 +291,7 @@ config RTC
> and set the RTC in an SMP compatible fashion.
>
> If you think you have a use for such a device (such as periodic data
> - sampling), then say Y here, and read <file:Documentation/rtc.txt>
> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst>
> for details.
>
> To compile this driver as a module, choose M here: the
> @@ -313,7 +313,7 @@ config JS_RTC
> /dev/rtc.
>
> If you think you have a use for such a device (such as periodic data
> - sampling), then say Y here, and read <file:Documentation/rtc.txt>
> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst>
> for details.
>
> To compile this driver as a module, choose M here: the
> diff --git a/drivers/char/hw_random/core.c b/drivers/char/hw_random/core.c
> index 95be7228f327..9044d31ab1a1 100644
> --- a/drivers/char/hw_random/core.c
> +++ b/drivers/char/hw_random/core.c
> @@ -4,7 +4,7 @@
> * Copyright 2006 Michael Buesch <m@bues.ch>
> * Copyright 2005 (c) MontaVista Software, Inc.
> *
> - * Please read Documentation/hw_random.txt for details on use.
> + * Please read Documentation/admin-guide/hw_random.rst for details on use.
> *
> * This software may be used and distributed according to the terms
> * of the GNU General Public License, incorporated herein by reference.
> diff --git a/include/linux/hw_random.h b/include/linux/hw_random.h
> index c0b93e0ff0c0..8e6dd908da21 100644
> --- a/include/linux/hw_random.h
> +++ b/include/linux/hw_random.h
> @@ -1,7 +1,7 @@
> /*
> Hardware Random Number Generator
>
> - Please read Documentation/hw_random.txt for details on use.
> + Please read Documentation/admin-guide/hw_random.rst for details on use.
>
> ----------------------------------------------------------
> This software may be used and distributed according to the terms
> --
> 2.21.0
>
--
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply
* Re: [PATCH 1/9] hrtimer: Use a bullet for the returns bullet list
From: Joe Perches @ 2019-06-28 12:39 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Thomas Gleixner
In-Reply-To: <8176c9089f66796de6f62e74499eb3d3015f785d.1561723736.git.mchehab+samsung@kernel.org>
On Fri, 2019-06-28 at 09:12 -0300, Mauro Carvalho Chehab wrote:
> That gets rid of this warning:
>
> ./kernel/time/hrtimer.c:1119: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> and displays nicely both at the source code and at the produced
> documentation.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
> kernel/time/hrtimer.c | 7 ++++---
> 1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/kernel/time/hrtimer.c b/kernel/time/hrtimer.c
> index edb230aba3d1..5ee77f1a8a92 100644
> --- a/kernel/time/hrtimer.c
> +++ b/kernel/time/hrtimer.c
> @@ -1114,9 +1114,10 @@ EXPORT_SYMBOL_GPL(hrtimer_start_range_ns);
> * @timer: hrtimer to stop
> *
> * Returns:
> - * 0 when the timer was not active
> - * 1 when the timer was active
> - * -1 when the timer is currently executing the callback function and
> + *
> + * * 0 when the timer was not active
> + * * 1 when the timer was active
> + * * -1 when the timer is currently executing the callback function and
> * cannot be stopped
I think this last line should be indented 3 more spaces too
^ permalink raw reply
* [PATCH 12/39] docs: interconnect.rst: add it to the driver-api guide
From: Mauro Carvalho Chehab @ 2019-06-28 12:30 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Georgi Djakov, linux-pm
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
This is intented for Kernel hackers audience.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{interconnect => driver-api}/interconnect.rst | 2 --
MAINTAINERS | 2 +-
3 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 2a0b57f12d1a..97bab578ea72 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -35,6 +35,7 @@ available subsections can be seen below.
spi
i2c
i3c/index
+ interconnect
hsi
edac
scsi
diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/driver-api/interconnect.rst
similarity index 99%
rename from Documentation/interconnect/interconnect.rst
rename to Documentation/driver-api/interconnect.rst
index 56e331dab70e..c3e004893796 100644
--- a/Documentation/interconnect/interconnect.rst
+++ b/Documentation/driver-api/interconnect.rst
@@ -1,7 +1,5 @@
.. SPDX-License-Identifier: GPL-2.0
-:orphan:
-
=====================================
GENERIC SYSTEM INTERCONNECT SUBSYSTEM
=====================================
diff --git a/MAINTAINERS b/MAINTAINERS
index 55996c9f2e0a..524e2c4300dc 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8273,7 +8273,7 @@ INTERCONNECT API
M: Georgi Djakov <georgi.djakov@linaro.org>
L: linux-pm@vger.kernel.org
S: Maintained
-F: Documentation/interconnect/
+F: Documentation/driver-api/interconnect.rst
F: Documentation/devicetree/bindings/interconnect/
F: drivers/interconnect/
F: include/dt-bindings/interconnect/
--
2.21.0
^ permalink raw reply related
* [PATCH 07/39] docs: nfc: add it to the driver-api book
From: Mauro Carvalho Chehab @ 2019-06-28 12:30 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
Most of the descriptions here are oriented to a Kernel developer.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/nfc/index.rst | 2 --
Documentation/{ => driver-api}/nfc/nfc-hci.rst | 0
Documentation/{ => driver-api}/nfc/nfc-pn544.rst | 0
4 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/nfc/index.rst (92%)
rename Documentation/{ => driver-api}/nfc/nfc-hci.rst (100%)
rename Documentation/{ => driver-api}/nfc/nfc-pn544.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 488c0347fa98..a8b3634287de 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -55,6 +55,7 @@ available subsections can be seen below.
pinctl
gpio/index
misc_devices
+ nfc/index
dmaengine/index
slimbus
soundwire/index
diff --git a/Documentation/nfc/index.rst b/Documentation/driver-api/nfc/index.rst
similarity index 92%
rename from Documentation/nfc/index.rst
rename to Documentation/driver-api/nfc/index.rst
index 4f4947fce80d..3afb2c0c2e3c 100644
--- a/Documentation/nfc/index.rst
+++ b/Documentation/driver-api/nfc/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
========================
Near Field Communication
========================
diff --git a/Documentation/nfc/nfc-hci.rst b/Documentation/driver-api/nfc/nfc-hci.rst
similarity index 100%
rename from Documentation/nfc/nfc-hci.rst
rename to Documentation/driver-api/nfc/nfc-hci.rst
diff --git a/Documentation/nfc/nfc-pn544.rst b/Documentation/driver-api/nfc/nfc-pn544.rst
similarity index 100%
rename from Documentation/nfc/nfc-pn544.rst
rename to Documentation/driver-api/nfc/nfc-pn544.rst
--
2.21.0
^ permalink raw reply related
* [PATCH 09/39] docs: md: move it to the driver-api book
From: Mauro Carvalho Chehab @ 2019-06-28 12:30 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The docs there were meant to be read by a Kernel developer.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/md/index.rst | 2 --
Documentation/{ => driver-api}/md/md-cluster.rst | 0
Documentation/{ => driver-api}/md/raid5-cache.rst | 0
Documentation/{ => driver-api}/md/raid5-ppl.rst | 0
5 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/md/index.rst (89%)
rename Documentation/{ => driver-api}/md/md-cluster.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-cache.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-ppl.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 55354eacc8bd..2a0b57f12d1a 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -55,6 +55,7 @@ available subsections can be seen below.
firmware/index
pinctl
gpio/index
+ md/index
misc_devices
nfc/index
dmaengine/index
diff --git a/Documentation/md/index.rst b/Documentation/driver-api/md/index.rst
similarity index 89%
rename from Documentation/md/index.rst
rename to Documentation/driver-api/md/index.rst
index c4db34ed327d..205080891a1a 100644
--- a/Documentation/md/index.rst
+++ b/Documentation/driver-api/md/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
====
RAID
====
diff --git a/Documentation/md/md-cluster.rst b/Documentation/driver-api/md/md-cluster.rst
similarity index 100%
rename from Documentation/md/md-cluster.rst
rename to Documentation/driver-api/md/md-cluster.rst
diff --git a/Documentation/md/raid5-cache.rst b/Documentation/driver-api/md/raid5-cache.rst
similarity index 100%
rename from Documentation/md/raid5-cache.rst
rename to Documentation/driver-api/md/raid5-cache.rst
diff --git a/Documentation/md/raid5-ppl.rst b/Documentation/driver-api/md/raid5-ppl.rst
similarity index 100%
rename from Documentation/md/raid5-ppl.rst
rename to Documentation/driver-api/md/raid5-ppl.rst
--
2.21.0
^ permalink raw reply related
* [PATCH 05/39] docs: namespace: move it to the admin-guide
From: Mauro Carvalho Chehab @ 2019-06-28 12:29 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
As stated at the documentation, this is meant to be for
users to better understand namespaces.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/admin-guide/index.rst | 1 +
.../{ => admin-guide}/namespaces/compatibility-list.rst | 0
Documentation/{ => admin-guide}/namespaces/index.rst | 2 --
Documentation/{ => admin-guide}/namespaces/resource-control.rst | 0
4 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => admin-guide}/namespaces/compatibility-list.rst (100%)
rename Documentation/{ => admin-guide}/namespaces/index.rst (91%)
rename Documentation/{ => admin-guide}/namespaces/resource-control.rst (100%)
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index b7e6d18f80ca..42819addebc6 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -76,6 +76,7 @@ configure specific aspects of kernel behavior to your liking.
thunderbolt
LSM/index
mm/index
+ namespaces/index
perf-security
acpi/index
diff --git a/Documentation/namespaces/compatibility-list.rst b/Documentation/admin-guide/namespaces/compatibility-list.rst
similarity index 100%
rename from Documentation/namespaces/compatibility-list.rst
rename to Documentation/admin-guide/namespaces/compatibility-list.rst
diff --git a/Documentation/namespaces/index.rst b/Documentation/admin-guide/namespaces/index.rst
similarity index 91%
rename from Documentation/namespaces/index.rst
rename to Documentation/admin-guide/namespaces/index.rst
index bf40625dd11a..713ec4949fa7 100644
--- a/Documentation/namespaces/index.rst
+++ b/Documentation/admin-guide/namespaces/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
==========
Namespaces
==========
diff --git a/Documentation/namespaces/resource-control.rst b/Documentation/admin-guide/namespaces/resource-control.rst
similarity index 100%
rename from Documentation/namespaces/resource-control.rst
rename to Documentation/admin-guide/namespaces/resource-control.rst
--
2.21.0
^ permalink raw reply related
* [PATCH 08/39] docs: mmc: move it to the driver-api
From: Mauro Carvalho Chehab @ 2019-06-28 12:30 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
Most of the stuff here is related to the kAPI.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/mmc/index.rst | 2 --
Documentation/{ => driver-api}/mmc/mmc-async-req.rst | 0
Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst | 0
Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst | 0
Documentation/{ => driver-api}/mmc/mmc-tools.rst | 0
6 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/mmc/index.rst (94%)
rename Documentation/{ => driver-api}/mmc/mmc-async-req.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-tools.rst (100%)
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index a8b3634287de..55354eacc8bd 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -44,6 +44,7 @@ available subsections can be seen below.
miscellaneous
mei/index
mtd/index
+ mmc/index
nvdimm/index
w1
rapidio/index
diff --git a/Documentation/mmc/index.rst b/Documentation/driver-api/mmc/index.rst
similarity index 94%
rename from Documentation/mmc/index.rst
rename to Documentation/driver-api/mmc/index.rst
index 3305478ddadb..9aaf64951a8c 100644
--- a/Documentation/mmc/index.rst
+++ b/Documentation/driver-api/mmc/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
========================
MMC/SD/SDIO card support
========================
diff --git a/Documentation/mmc/mmc-async-req.rst b/Documentation/driver-api/mmc/mmc-async-req.rst
similarity index 100%
rename from Documentation/mmc/mmc-async-req.rst
rename to Documentation/driver-api/mmc/mmc-async-req.rst
diff --git a/Documentation/mmc/mmc-dev-attrs.rst b/Documentation/driver-api/mmc/mmc-dev-attrs.rst
similarity index 100%
rename from Documentation/mmc/mmc-dev-attrs.rst
rename to Documentation/driver-api/mmc/mmc-dev-attrs.rst
diff --git a/Documentation/mmc/mmc-dev-parts.rst b/Documentation/driver-api/mmc/mmc-dev-parts.rst
similarity index 100%
rename from Documentation/mmc/mmc-dev-parts.rst
rename to Documentation/driver-api/mmc/mmc-dev-parts.rst
diff --git a/Documentation/mmc/mmc-tools.rst b/Documentation/driver-api/mmc/mmc-tools.rst
similarity index 100%
rename from Documentation/mmc/mmc-tools.rst
rename to Documentation/driver-api/mmc/mmc-tools.rst
--
2.21.0
^ permalink raw reply related
* [PATCH 16/39] docs: admin-guide: move sysctl directory to it
From: Mauro Carvalho Chehab @ 2019-06-28 12:30 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Alexey Dobriyan, David S. Miller, linux-fsdevel,
netdev, linux-mm
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>
The stuff under sysctl describes /sys interface from userspace
point of view. So, add it to the admin-guide and remove the
:orphan: from its index file.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
CREDITS | 2 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.txt | 2 +-
Documentation/admin-guide/mm/index.rst | 2 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
Documentation/{ => admin-guide}/sysctl/abi.rst | 0
Documentation/{ => admin-guide}/sysctl/fs.rst | 0
Documentation/{ => admin-guide}/sysctl/index.rst | 2 --
Documentation/{ => admin-guide}/sysctl/kernel.rst | 0
Documentation/{ => admin-guide}/sysctl/net.rst | 0
Documentation/{ => admin-guide}/sysctl/sunrpc.rst | 0
Documentation/{ => admin-guide}/sysctl/user.rst | 0
Documentation/{ => admin-guide}/sysctl/vm.rst | 0
Documentation/core-api/printk-formats.rst | 2 +-
Documentation/filesystems/proc.txt | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/vm/unevictable-lru.rst | 2 +-
fs/proc/Kconfig | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
20 files changed, 12 insertions(+), 13 deletions(-)
rename Documentation/{ => admin-guide}/sysctl/abi.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/fs.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/index.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/kernel.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/net.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/sunrpc.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/user.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/vm.rst (100%)
diff --git a/CREDITS b/CREDITS
index beac0c81d081..401c5092bbf9 100644
--- a/CREDITS
+++ b/CREDITS
@@ -3120,7 +3120,7 @@ S: France
N: Rik van Riel
E: riel@redhat.com
W: http://www.surriel.com/
-D: Linux-MM site, Documentation/sysctl/*, swap/mm readaround
+D: Linux-MM site, Documentation/admin-guide/sysctl/*, swap/mm readaround
D: kswapd fixes, random kernel hacker, rmap VM,
D: nl.linux.org administrator, minor scheduler additions
S: Red Hat Boston
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index e0763c51b024..acd0efa46e9d 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -16,6 +16,7 @@ etc.
README
kernel-parameters
devices
+ sysctl/index
This section describes CPU vulnerabilities and their mitigations.
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index b2007fb4daf0..a3d3da5baacb 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -3170,7 +3170,7 @@
numa_zonelist_order= [KNL, BOOT] Select zonelist order for NUMA.
'node', 'default' can be specified
This can be set from sysctl after boot.
- See Documentation/sysctl/vm.rst for details.
+ See Documentation/admin-guide/sysctl/vm.rst for details.
ohci1394_dma=early [HW] enable debugging via the ohci1394 driver.
See Documentation/debugging-via-ohci1394.txt for more
diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index f5e92f33f96e..5f61a6c429e0 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -11,7 +11,7 @@ processes address space and many other cool things.
Linux memory management is a complex system with many configurable
settings. Most of these settings are available via ``/proc``
filesystem and can be quired and adjusted using ``sysctl``. These APIs
-are described in Documentation/sysctl/vm.rst and in `man 5 proc`_.
+are described in Documentation/admin-guide/sysctl/vm.rst and in `man 5 proc`_.
.. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
diff --git a/Documentation/admin-guide/mm/ksm.rst b/Documentation/admin-guide/mm/ksm.rst
index 7b2b8767c0b4..874eb0c77d34 100644
--- a/Documentation/admin-guide/mm/ksm.rst
+++ b/Documentation/admin-guide/mm/ksm.rst
@@ -59,7 +59,7 @@ MADV_UNMERGEABLE is applied to a range which was never MADV_MERGEABLE.
If a region of memory must be split into at least one new MADV_MERGEABLE
or MADV_UNMERGEABLE region, the madvise may return ENOMEM if the process
-will exceed ``vm.max_map_count`` (see Documentation/sysctl/vm.rst).
+will exceed ``vm.max_map_count`` (see Documentation/admin-guide/sysctl/vm.rst).
Like other madvise calls, they are intended for use on mapped areas of
the user address space: they will report ENOMEM if the specified range
diff --git a/Documentation/sysctl/abi.rst b/Documentation/admin-guide/sysctl/abi.rst
similarity index 100%
rename from Documentation/sysctl/abi.rst
rename to Documentation/admin-guide/sysctl/abi.rst
diff --git a/Documentation/sysctl/fs.rst b/Documentation/admin-guide/sysctl/fs.rst
similarity index 100%
rename from Documentation/sysctl/fs.rst
rename to Documentation/admin-guide/sysctl/fs.rst
diff --git a/Documentation/sysctl/index.rst b/Documentation/admin-guide/sysctl/index.rst
similarity index 99%
rename from Documentation/sysctl/index.rst
rename to Documentation/admin-guide/sysctl/index.rst
index efbcde8c1c9c..03346f98c7b9 100644
--- a/Documentation/sysctl/index.rst
+++ b/Documentation/admin-guide/sysctl/index.rst
@@ -1,5 +1,3 @@
-:orphan:
-
===========================
Documentation for /proc/sys
===========================
diff --git a/Documentation/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
similarity index 100%
rename from Documentation/sysctl/kernel.rst
rename to Documentation/admin-guide/sysctl/kernel.rst
diff --git a/Documentation/sysctl/net.rst b/Documentation/admin-guide/sysctl/net.rst
similarity index 100%
rename from Documentation/sysctl/net.rst
rename to Documentation/admin-guide/sysctl/net.rst
diff --git a/Documentation/sysctl/sunrpc.rst b/Documentation/admin-guide/sysctl/sunrpc.rst
similarity index 100%
rename from Documentation/sysctl/sunrpc.rst
rename to Documentation/admin-guide/sysctl/sunrpc.rst
diff --git a/Documentation/sysctl/user.rst b/Documentation/admin-guide/sysctl/user.rst
similarity index 100%
rename from Documentation/sysctl/user.rst
rename to Documentation/admin-guide/sysctl/user.rst
diff --git a/Documentation/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
similarity index 100%
rename from Documentation/sysctl/vm.rst
rename to Documentation/admin-guide/sysctl/vm.rst
diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index 1d8e748f909f..c6224d039bcb 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -119,7 +119,7 @@ Kernel Pointers
For printing kernel pointers which should be hidden from unprivileged
users. The behaviour of %pK depends on the kptr_restrict sysctl - see
-Documentation/sysctl/kernel.rst for more details.
+Documentation/admin-guide/sysctl/kernel.rst for more details.
Unmodified Addresses
--------------------
diff --git a/Documentation/filesystems/proc.txt b/Documentation/filesystems/proc.txt
index 52ec004a4a8b..be56af8dbb88 100644
--- a/Documentation/filesystems/proc.txt
+++ b/Documentation/filesystems/proc.txt
@@ -1479,7 +1479,7 @@ review the kernel documentation in the directory /usr/src/linux/Documentation.
This chapter is heavily based on the documentation included in the pre 2.2
kernels, and became part of it in version 2.2.1 of the Linux kernel.
-Please see: Documentation/sysctl/ directory for descriptions of these
+Please see: Documentation/admin-guide/sysctl/ directory for descriptions of these
entries.
------------------------------------------------------------------------------
diff --git a/Documentation/networking/ip-sysctl.txt b/Documentation/networking/ip-sysctl.txt
index 0f8e1c544e1e..864a5921e9d7 100644
--- a/Documentation/networking/ip-sysctl.txt
+++ b/Documentation/networking/ip-sysctl.txt
@@ -2284,7 +2284,7 @@ addr_scope_policy - INTEGER
/proc/sys/net/core/*
- Please see: Documentation/sysctl/net.rst for descriptions of these entries.
+ Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.
/proc/sys/net/unix/*
diff --git a/Documentation/vm/unevictable-lru.rst b/Documentation/vm/unevictable-lru.rst
index 8ba656f37cd8..109052215bce 100644
--- a/Documentation/vm/unevictable-lru.rst
+++ b/Documentation/vm/unevictable-lru.rst
@@ -439,7 +439,7 @@ Compacting MLOCKED Pages
The unevictable LRU can be scanned for compactable regions and the default
behavior is to do so. /proc/sys/vm/compact_unevictable_allowed controls
-this behavior (see Documentation/sysctl/vm.rst). Once scanning of the
+this behavior (see Documentation/admin-guide/sysctl/vm.rst). Once scanning of the
unevictable LRU is enabled, the work of compaction is mostly handled by
the page migration code and the same work flow as described in MIGRATING
MLOCKED PAGES will apply.
diff --git a/fs/proc/Kconfig b/fs/proc/Kconfig
index cba429db95d9..cb5629bd5fff 100644
--- a/fs/proc/Kconfig
+++ b/fs/proc/Kconfig
@@ -73,7 +73,7 @@ config PROC_SYSCTL
interface is through /proc/sys. If you say Y here a tree of
modifiable sysctl entries will be generated beneath the
/proc/sys directory. They are explained in the files
- in <file:Documentation/sysctl/>. Note that enabling this
+ in <file:Documentation/admin-guide/sysctl/>. Note that enabling this
option will enlarge the kernel by at least 8 KB.
As it is generally a good thing, you should say Y here unless
diff --git a/kernel/panic.c b/kernel/panic.c
index e0ea74bbb41d..057540b6eee9 100644
--- a/kernel/panic.c
+++ b/kernel/panic.c
@@ -372,7 +372,7 @@ const struct taint_flag taint_flags[TAINT_FLAGS_COUNT] = {
/**
* print_tainted - return a string to represent the kernel taint state.
*
- * For individual taint flag meanings, see Documentation/sysctl/kernel.rst
+ * For individual taint flag meanings, see Documentation/admin-guide/sysctl/kernel.rst
*
* The string is overwritten by the next call to print_tainted(),
* but is always NULL terminated.
diff --git a/mm/swap.c b/mm/swap.c
index 83a2a15f4836..ae300397dfda 100644
--- a/mm/swap.c
+++ b/mm/swap.c
@@ -8,7 +8,7 @@
/*
* This file contains the default values for the operation of the
* Linux VM subsystem. Fine-tuning documentation can be found in
- * Documentation/sysctl/vm.rst.
+ * Documentation/admin-guide/sysctl/vm.rst.
* Started 18.12.91
* Swap aging added 23.2.95, Stephen Tweedie.
* Buffermem limits added 12.3.98, Rik van Riel.
--
2.21.0
^ permalink raw reply related
page: next (older) | prev (newer) | latest
- recent:[subjects (threaded)|topics (new)|topics (active)]
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox