[PATCH 13/39] docs: add arch doc directories to the index
Now that several arch documents were converted to ReST, add their indexes to Documentation/index.rst and remove the :orphan: from them. Signed-off-by: Mauro Carvalho Chehab --- Documentation/arm/index.rst | 2 -- Documentation/arm64/index.rst | 2 -- Documentation/ia64/index.rst| 2 -- Documentation/index.rst | 10 ++ Documentation/m68k/index.rst| 2 +- Documentation/powerpc/index.rst | 2 +- Documentation/riscv/index.rst | 2 -- Documentation/s390/index.rst| 2 -- Documentation/sparc/index.rst | 2 -- Documentation/xtensa/index.rst | 2 +- 10 files changed, 13 insertions(+), 15 deletions(-) diff --git a/Documentation/arm/index.rst b/Documentation/arm/index.rst index bd316d1a1802..9c2f781f4685 100644 --- a/Documentation/arm/index.rst +++ b/Documentation/arm/index.rst @@ -1,5 +1,3 @@ -:orphan: - ARM Architecture diff --git a/Documentation/arm64/index.rst b/Documentation/arm64/index.rst index 018b7836ecb7..96b696ba4e6c 100644 --- a/Documentation/arm64/index.rst +++ b/Documentation/arm64/index.rst @@ -1,5 +1,3 @@ -:orphan: - == ARM64 Architecture == diff --git a/Documentation/ia64/index.rst b/Documentation/ia64/index.rst index a3e3052ad6e2..ef99475f672b 100644 --- a/Documentation/ia64/index.rst +++ b/Documentation/ia64/index.rst @@ -1,5 +1,3 @@ -:orphan: - == IA-64 Architecture == diff --git a/Documentation/index.rst b/Documentation/index.rst index 95db26bf2899..f898def833f4 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -118,7 +118,17 @@ implementation. :maxdepth: 2 sh/index + arm/index + arm64/index + ia64/index + m68k/index + powerpc/index + riscv/index + s390/index + sh/index + sparc/index x86/index + xtensa/index Filesystem Documentation diff --git a/Documentation/m68k/index.rst b/Documentation/m68k/index.rst index f3273ec075c3..3a5ba7fe1703 100644 --- a/Documentation/m68k/index.rst +++ b/Documentation/m68k/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 = m68k Architecture diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst index 1ff17268db46..549b1cdd77ae 100644 --- a/Documentation/powerpc/index.rst +++ b/Documentation/powerpc/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 === powerpc diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst index c4b906d9b5a7..e3ca0922a8c2 100644 --- a/Documentation/riscv/index.rst +++ b/Documentation/riscv/index.rst @@ -1,5 +1,3 @@ -:orphan: - === RISC-V architecture === diff --git a/Documentation/s390/index.rst b/Documentation/s390/index.rst index 1a914da2a07b..4602312909d3 100644 --- a/Documentation/s390/index.rst +++ b/Documentation/s390/index.rst @@ -1,5 +1,3 @@ -:orphan: - = s390 Architecture = diff --git a/Documentation/sparc/index.rst b/Documentation/sparc/index.rst index 91f7d6643dd5..71cff621f243 100644 --- a/Documentation/sparc/index.rst +++ b/Documentation/sparc/index.rst @@ -1,5 +1,3 @@ -:orphan: - == Sparc Architecture == diff --git a/Documentation/xtensa/index.rst b/Documentation/xtensa/index.rst index 5a24e365e35f..52fa04eb39a3 100644 --- a/Documentation/xtensa/index.rst +++ b/Documentation/xtensa/index.rst @@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 === Xtensa Architecture -- 2.21.0
[PATCH v2 18/79] docs: kbuild: convert docs to ReST and rename to *.rst
The kbuild documentation clearly shows that the documents
there are written at different times: some use markdown,
some use their own peculiar logic to split sections.
Convert everything to ReST without affecting too much
the author's style and avoiding adding uneeded markups.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/admin-guide/README.rst | 2 +-
...eaders_install.txt => headers_install.rst} | 5 +-
Documentation/kbuild/index.rst| 27 +
Documentation/kbuild/issues.rst | 11 +
.../kbuild/{kbuild.txt => kbuild.rst} | 119 ++--
...nfig-language.txt => kconfig-language.rst} | 232
...anguage.txt => kconfig-macro-language.rst} | 37 +-
.../kbuild/{kconfig.txt => kconfig.rst} | 136 +++--
.../kbuild/{makefiles.txt => makefiles.rst} | 518 +++---
.../kbuild/{modules.txt => modules.rst} | 168 +++---
Documentation/kernel-hacking/hacking.rst | 4 +-
Documentation/process/coding-style.rst| 2 +-
Documentation/process/submit-checklist.rst| 2 +-
.../it_IT/kernel-hacking/hacking.rst | 4 +-
.../it_IT/process/submit-checklist.rst| 2 +-
.../zh_CN/process/coding-style.rst| 2 +-
.../zh_CN/process/submit-checklist.rst| 2 +-
Kconfig | 2 +-
arch/arc/plat-eznps/Kconfig | 2 +-
arch/c6x/Kconfig | 2 +-
arch/microblaze/Kconfig.debug | 2 +-
arch/microblaze/Kconfig.platform | 2 +-
arch/nds32/Kconfig| 2 +-
arch/openrisc/Kconfig | 2 +-
arch/powerpc/sysdev/Kconfig | 2 +-
arch/riscv/Kconfig| 2 +-
drivers/auxdisplay/Kconfig| 2 +-
drivers/firmware/Kconfig | 2 +-
drivers/mtd/devices/Kconfig | 2 +-
drivers/net/ethernet/smsc/Kconfig | 6 +-
drivers/net/wireless/intel/iwlegacy/Kconfig | 4 +-
drivers/net/wireless/intel/iwlwifi/Kconfig| 2 +-
drivers/parport/Kconfig | 2 +-
drivers/scsi/Kconfig | 4 +-
drivers/staging/sm750fb/Kconfig | 2 +-
drivers/usb/misc/Kconfig | 4 +-
drivers/video/fbdev/Kconfig | 14 +-
net/bridge/netfilter/Kconfig | 2 +-
net/ipv4/netfilter/Kconfig| 2 +-
net/ipv6/netfilter/Kconfig| 2 +-
net/netfilter/Kconfig | 16 +-
net/tipc/Kconfig | 2 +-
scripts/Kbuild.include| 4 +-
scripts/Makefile.host | 2 +-
scripts/kconfig/symbol.c | 2 +-
.../tests/err_recursive_dep/expected_stderr | 14 +-
sound/oss/dmasound/Kconfig| 6 +-
47 files changed, 826 insertions(+), 561 deletions(-)
rename Documentation/kbuild/{headers_install.txt => headers_install.rst} (96%)
create mode 100644 Documentation/kbuild/index.rst
create mode 100644 Documentation/kbuild/issues.rst
rename Documentation/kbuild/{kbuild.txt => kbuild.rst} (72%)
rename Documentation/kbuild/{kconfig-language.txt => kconfig-language.rst}
(85%)
rename Documentation/kbuild/{kconfig-macro-language.txt =>
kconfig-macro-language.rst} (94%)
rename Documentation/kbuild/{kconfig.txt => kconfig.rst} (80%)
rename Documentation/kbuild/{makefiles.txt => makefiles.rst} (84%)
rename Documentation/kbuild/{modules.txt => modules.rst} (84%)
diff --git a/Documentation/admin-guide/README.rst
b/Documentation/admin-guide/README.rst
index a582c780c3bd..cc6151fc0845 100644
--- a/Documentation/admin-guide/README.rst
+++ b/Documentation/admin-guide/README.rst
@@ -227,7 +227,7 @@ Configuring the kernel
"make tinyconfig" Configure the tiniest possible kernel.
You can find more information on using the Linux kernel config tools
- in Documentation/kbuild/kconfig.txt.
+ in Documentation/kbuild/kconfig.rst.
- NOTES on ``make config``:
diff --git a/Documentation/kbuild/headers_install.txt
b/Documentation/kbuild/headers_install.rst
similarity index 96%
rename from Documentation/kbuild/headers_install.txt
rename to Documentation/kbuild/headers_install.rst
index f0153adb95e2..1ab7294e41ac 100644
--- a/Documentation/kbuild/headers_install.txt
+++ b/Documentation/kbuild/headers_install.rst
@@ -1,3 +1,4 @@
+
Re: [PATCH v4 25/63] Documentation: add Linux PCI to Sphinx TOC tree
Em Wed, 24 Apr 2019 00:28:54 +0800 Changbin Du escreveu: > Add a index.rst for PCI subsystem. More docs will be added later. > > Signed-off-by: Changbin Du > Acked-by: Bjorn Helgaas > --- > Documentation/PCI/index.rst | 9 + On a past discussion at docs ML, we've agreed to use lowercase for new stuff. My suggestion here would be to use lowercase for "pci". Also, there's already a pci directory under driver-api, added on this commit: commit fcc78f9c22474d60c65d522e50ea07006ec1b9fc Author: Logan Gunthorpe Date: Thu Oct 4 15:27:39 2018 -0600 docs-rst: Add a new directory for PCI documentation I would just add a new section at Documentation/driver-api/pci/index.rst with something like: Legacy PCI documentation .. note:: The files here were written a long time ago and need some serious work. Use their contents with caution. .. toctree:: :maxdepth: 1 And add those documents from Documentation/PCI into it. > Documentation/index.rst | 1 + > 2 files changed, 10 insertions(+) > create mode 100644 Documentation/PCI/index.rst > > diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst > new file mode 100644 > index ..c2f8728d11cf > --- /dev/null > +++ b/Documentation/PCI/index.rst > @@ -0,0 +1,9 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +=== > +Linux PCI Bus Subsystem > +=== > + > +.. toctree:: > + :maxdepth: 2 > + :numbered: > diff --git a/Documentation/index.rst b/Documentation/index.rst > index fdfa85c56a50..d80138284e0f 100644 > --- a/Documentation/index.rst > +++ b/Documentation/index.rst > @@ -100,6 +100,7 @@ needed). > filesystems/index > vm/index > bpf/index > + PCI/index > misc-devices/index > > Architecture-specific documentation Thanks, Mauro
Re: [PATCH v4 26/63] Documentation: PCI: convert pci.txt to reST
Em Wed, 24 Apr 2019 00:28:55 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> Documentation/PCI/index.rst| 2 +
> Documentation/PCI/{pci.txt => pci.rst} | 267 +
> 2 files changed, 140 insertions(+), 129 deletions(-)
> rename Documentation/PCI/{pci.txt => pci.rst} (78%)
>
> diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst
> index c2f8728d11cf..7babf43709b0 100644
> --- a/Documentation/PCI/index.rst
> +++ b/Documentation/PCI/index.rst
> @@ -7,3 +7,5 @@ Linux PCI Bus Subsystem
> .. toctree::
> :maxdepth: 2
> :numbered:
> +
> + pci
See my comments to patch 25/63. It applies to all PCI stuff,
so I won't keep repeating it. Anyway, the final decision with
regards to file naming belongs to the docs maintainer and to
the PCI maintainer.
> diff --git a/Documentation/PCI/pci.txt b/Documentation/PCI/pci.rst
> similarity index 78%
> rename from Documentation/PCI/pci.txt
> rename to Documentation/PCI/pci.rst
> index badb26ac33dc..29ddd2e9177a 100644
> --- a/Documentation/PCI/pci.txt
> +++ b/Documentation/PCI/pci.rst
I would either rename this file or Documentation/driver-api/pci/pci.rst.
Even if the decision is to keep those on different directories, it
sounds a very bad idea on my eyes to keep two files with different
content and identical names on different directories that belong to
the same subsystem.
@PCI maintainers:
The MAINTAINERS file, at the PCI SUBSYSTEM part is missing
an entry for Documentation/driver-api/pci/.
> @@ -1,10 +1,12 @@
> +.. SPDX-License-Identifier: GPL-2.0
>
> - How To Write Linux PCI Drivers
> +==
> +How To Write Linux PCI Drivers
> +==
>
> - by Martin Mares on 07-Feb-2000
> - updated by Grant Grundler on 23-Dec-2006
> +:Authors: - Martin Mares
> + - Grant Grundler
>
> -
> The world of PCI is vast and full of (mostly unpleasant) surprises.
> Since each CPU architecture implements different chip-sets and PCI devices
> have different requirements (erm, "features"), the result is the PCI support
> @@ -26,8 +28,8 @@ Please send questions/comments/patches about Linux PCI API
> to the
>
>
>
> -0. Structure of PCI drivers
> -~~~
> +Structure of PCI drivers
> +
> PCI drivers "discover" PCI devices in a system via pci_register_driver().
> Actually, it's the other way around. When the PCI generic code discovers
> a new device, the driver with a matching "description" will be notified.
> @@ -42,24 +44,25 @@ pointers and thus dictates the high level structure of a
> driver.
> Once the driver knows about a PCI device and takes ownership, the
> driver generally needs to perform the following initialization:
>
> - Enable the device
> - Request MMIO/IOP resources
> - Set the DMA mask size (for both coherent and streaming DMA)
> - Allocate and initialize shared control data (pci_allocate_coherent())
> - Access device configuration space (if needed)
> - Register IRQ handler (request_irq())
> - Initialize non-PCI (i.e. LAN/SCSI/etc parts of the chip)
> - Enable DMA/processing engines
> + - Enable the device
> + - Request MMIO/IOP resources
> + - Set the DMA mask size (for both coherent and streaming DMA)
> + - Allocate and initialize shared control data (pci_allocate_coherent())
> + - Access device configuration space (if needed)
> + - Register IRQ handler (request_irq())
> + - Initialize non-PCI (i.e. LAN/SCSI/etc parts of the chip)
> + - Enable DMA/processing engines
>
> When done using the device, and perhaps the module needs to be unloaded,
> the driver needs to take the follow steps:
> - Disable the device from generating IRQs
> - Release the IRQ (free_irq())
> - Stop all DMA activity
> - Release DMA buffers (both streaming and coherent)
> - Unregister from other subsystems (e.g. scsi or netdev)
> - Release MMIO/IOP resources
> - Disable the device
> +
> + - Disable the device from generating IRQs
> + - Release the IRQ (free_irq())
> + - Stop all DMA activity
> + - Release DMA buffers (both streaming and coherent)
> + - Unregister from other subsystems (e.g. scsi or netdev)
> + - Release MMIO/IOP resources
> + - Disable the device
>
> Most of these topics are covered in the following sections.
> For the rest look at LDD3 or .
> @@ -70,13 +73,12 @@ completely empty or just returning an appropriate error
> codes to avoid
> lots of ifdefs in the drivers.
>
>
> -
> -1. pci_register_driver() call
> -~
> +pci_register_driver() call
> +==
>
> PCI device
Re: [PATCH v4 32/63] Documentation: PCI: convert pcieaer-howto.txt to reST
Em Wed, 24 Apr 2019 00:29:01 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> Documentation/PCI/index.rst | 1 +
> .../{pcieaer-howto.txt => pcieaer-howto.rst} | 110 --
> 2 files changed, 74 insertions(+), 37 deletions(-)
> rename Documentation/PCI/{pcieaer-howto.txt => pcieaer-howto.rst} (81%)
>
> diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst
> index 5ee4dba07116..86c76c22810b 100644
> --- a/Documentation/PCI/index.rst
> +++ b/Documentation/PCI/index.rst
> @@ -14,3 +14,4 @@ Linux PCI Bus Subsystem
> MSI-HOWTO
> acpi-info
> pci-error-recovery
> + pcieaer-howto
> diff --git a/Documentation/PCI/pcieaer-howto.txt
> b/Documentation/PCI/pcieaer-howto.rst
> similarity index 81%
> rename from Documentation/PCI/pcieaer-howto.txt
> rename to Documentation/PCI/pcieaer-howto.rst
> index 48ce7903e3c6..67f77ff76865 100644
> --- a/Documentation/PCI/pcieaer-howto.txt
> +++ b/Documentation/PCI/pcieaer-howto.rst
> @@ -1,21 +1,29 @@
> - The PCI Express Advanced Error Reporting Driver Guide HOWTO
> - T. Long Nguyen
> - Yanmin Zhang
> - 07/29/2006
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
>
> +===
> +The PCI Express Advanced Error Reporting Driver Guide HOWTO
> +===
>
> -1. Overview
> +:Authors: - T. Long Nguyen
> + - Yanmin Zhang
>
> -1.1 About this guide
> +:Copyright: |copy| 2006 Intel Corporation
> +
> +Overview
> +===
> +
> +About this guide
> +
>
> This guide describes the basics of the PCI Express Advanced Error
> Reporting (AER) driver and provides information on how to use it, as
> well as how to enable the drivers of endpoint devices to conform with
> PCI Express AER driver.
>
> -1.2 Copyright (C) Intel Corporation 2006.
>
> -1.3 What is the PCI Express AER Driver?
> +What is the PCI Express AER Driver?
> +---
>
> PCI Express error signaling can occur on the PCI Express link itself
> or on behalf of transactions initiated on the link. PCI Express
> @@ -30,17 +38,19 @@ The PCI Express AER driver provides the infrastructure to
> support PCI
> Express Advanced Error Reporting capability. The PCI Express AER
> driver provides three basic functions:
>
> --Gathers the comprehensive error information if errors occurred.
> --Reports error to the users.
> --Performs error recovery actions.
> + - Gathers the comprehensive error information if errors occurred.
> + - Reports error to the users.
> + - Performs error recovery actions.
>
> AER driver only attaches root ports which support PCI-Express AER
> capability.
>
>
> -2. User Guide
> +User Guide
> +==
>
> -2.1 Include the PCI Express AER Root Driver into the Linux Kernel
> +Include the PCI Express AER Root Driver into the Linux Kernel
> +-
>
> The PCI Express AER Root driver is a Root Port service driver attached
> to the PCI Express Port Bus driver. If a user wants to use it, the driver
> @@ -48,7 +58,8 @@ has to be compiled. Option CONFIG_PCIEAER supports this
> capability. It
> depends on CONFIG_PCIEPORTBUS, so pls. set CONFIG_PCIEPORTBUS=y and
> CONFIG_PCIEAER = y.
>
> -2.2 Load PCI Express AER Root Driver
> +Load PCI Express AER Root Driver
> +
>
> Some systems have AER support in firmware. Enabling Linux AER support at
> the same time the firmware handles AER may result in unpredictable
> @@ -56,30 +67,34 @@ behavior. Therefore, Linux does not handle AER events
> unless the firmware
> grants AER control to the OS via the ACPI _OSC method. See the PCI FW 3.0
> Specification for details regarding _OSC usage.
>
> -2.3 AER error output
> +AER error output
> +
>
> When a PCIe AER error is captured, an error message will be output to
> console. If it's a correctable error, it is output as a warning.
> Otherwise, it is printed as an error. So users could choose different
> log level to filter out correctable error messages.
>
> -Below shows an example:
> -:50:00.0: PCIe Bus Error: severity=Uncorrected (Fatal), type=Transaction
> Layer, id=0500(Requester ID)
> -:50:00.0: device [8086:0329] error status/mask=0010/
> -:50:00.0:[20] Unsupported Request(First)
> -:50:00.0: TLP Header: 0401 00200a03 0501 00050100
> +Below shows an example::
> +
> + :50:00.0: PCIe Bus Error: severity=Uncorrected (Fatal),
> type=Transaction Layer, id=0500(Requester ID)
> + :50:00.0: device [8086:0329] error status/mask=0010/
> +
Re: [PATCH v4 29/63] Documentation: PCI: convert MSI-HOWTO.txt to reST
Em Wed, 24 Apr 2019 00:28:58 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
>
> ---
> v2:
> o drop numbering.
> o simplify author list
> ---
> .../PCI/{MSI-HOWTO.txt => MSI-HOWTO.rst} | 83 +++
> Documentation/PCI/index.rst | 1 +
> 2 files changed, 50 insertions(+), 34 deletions(-)
> rename Documentation/PCI/{MSI-HOWTO.txt => MSI-HOWTO.rst} (88%)
Renamed names in lowercase, please.
>
> diff --git a/Documentation/PCI/MSI-HOWTO.txt b/Documentation/PCI/MSI-HOWTO.rst
> similarity index 88%
> rename from Documentation/PCI/MSI-HOWTO.txt
> rename to Documentation/PCI/MSI-HOWTO.rst
> index 618e13d5e276..18cc3700489b 100644
> --- a/Documentation/PCI/MSI-HOWTO.txt
> +++ b/Documentation/PCI/MSI-HOWTO.rst
> @@ -1,13 +1,14 @@
> - The MSI Driver Guide HOWTO
> - Tom L Nguyen tom.l.ngu...@intel.com
> - 10/03/2003
> - Revised Feb 12, 2004 by Martine Silbermann
> - email: martine.silberm...@hp.com
> - Revised Jun 25, 2004 by Tom L Nguyen
> - Revised Jul 9, 2008 by Matthew Wilcox
> - Copyright 2003, 2008 Intel Corporation
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
>
> -1. About this guide
> +==
> +The MSI Driver Guide HOWTO
> +==
> +
> +:Authors: Tom L Nguyen; Martine Silbermann; Matthew Wilcox
Not so sure about this, as you removed the author emails.
It seems you missed to keep:
Copyright 2003, 2008 Intel Corporation
After re-adding the missing copyright:
Reviewed-by: Mauro Carvalho Chehab
> +
> +About this guide
> +
>
> This guide describes the basics of Message Signaled Interrupts (MSIs),
> the advantages of using MSI over traditional interrupt mechanisms, how
> @@ -15,7 +16,8 @@ to change your driver to use MSI or MSI-X and some basic
> diagnostics to
> try if a device doesn't support MSIs.
>
>
> -2. What are MSIs?
> +What are MSIs?
> +==
>
> A Message Signaled Interrupt is a write from the device to a special
> address which causes an interrupt to be received by the CPU.
> @@ -29,7 +31,8 @@ Devices may support both MSI and MSI-X, but only one can be
> enabled at
> a time.
>
>
> -3. Why use MSIs?
> +Why use MSIs?
> +=
>
> There are three reasons why using MSIs can give an advantage over
> traditional pin-based interrupts.
> @@ -61,14 +64,16 @@ Other possible designs include giving one interrupt to
> each packet queue
> in a network card or each port in a storage controller.
>
>
> -4. How to use MSIs
> +How to use MSIs
> +===
>
> PCI devices are initialised to use pin-based interrupts. The device
> driver has to set up the device to use MSI or MSI-X. Not all machines
> support MSIs correctly, and for those machines, the APIs described below
> will simply fail and the device will continue to use pin-based interrupts.
>
> -4.1 Include kernel support for MSIs
> +Include kernel support for MSIs
> +---
>
> To support MSI or MSI-X, the kernel must be built with the CONFIG_PCI_MSI
> option enabled. This option is only available on some architectures,
> @@ -76,14 +81,15 @@ and it may depend on some other options also being set.
> For example,
> on x86, you must also enable X86_UP_APIC or SMP in order to see the
> CONFIG_PCI_MSI option.
>
> -4.2 Using MSI
> +Using MSI
> +-
>
> Most of the hard work is done for the driver in the PCI layer. The driver
> simply has to request that the PCI layer set up the MSI capability for this
> device.
>
> To automatically use MSI or MSI-X interrupt vectors, use the following
> -function:
> +function::
>
>int pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
> unsigned int max_vecs, unsigned int flags);
> @@ -101,12 +107,12 @@ any possible kind of interrupt. If the
> PCI_IRQ_AFFINITY flag is set,
> pci_alloc_irq_vectors() will spread the interrupts around the available CPUs.
>
> To get the Linux IRQ numbers passed to request_irq() and free_irq() and the
> -vectors, use the following function:
> +vectors, use the following function::
>
>int pci_irq_vector(struct pci_dev *dev, unsigned int nr);
>
> Any allocated resources should be freed before removing the device using
> -the following function:
> +the following function::
>
>void pci_free_irq_vectors(
Re: [PATCH v4 17/63] Documentation: ACPI: move method-tracing.txt to firmware-guide/acpi and convert to rsST
x80" > trace_debug_layer > + # echo "0x10" > trace_debug_level > + # echo "\..." > trace_method_name > + # echo "method-once" > trace_state > + > +d. Filter out the method/opcode start/stop "AML tracer" when the > + specified control method is being evaluated:: > + > + # cd /sys/module/acpi/parameters > + # echo "0x80" > trace_debug_layer > + # echo "0x10" > trace_debug_level > + # echo "\..." > trace_method_name > + # echo "opcode" > trace_state > + > +e. Filter out the method/opcode start/stop "AML tracer" when the > + specified control method is being evaluated for the first time:: > + > + # cd /sys/module/acpi/parameters > + # echo "0x80" > trace_debug_layer > + # echo "0x10" > trace_debug_level > + # echo "\..." > trace_method_name > + # echo "opcode-opcode" > trace_state > + > +Note that all above method tracing facility related module parameters can > +be used as the boot parameters, for example:: > + > + acpi.trace_debug_layer=0x80 acpi.trace_debug_level=0x10 \ > + acpi.trace_method_name=\_SB.LID0._LID acpi.trace_state=opcode-once > + > +2. Interface descriptions > += > + > +All method tracing functions can be configured via ACPI module > +parameters that are accessible at /sys/module/acpi/parameters/: > + > +trace_method_name > +The full path of the AML method that the user wants to trace. > +Note that the full path shouldn't contain the trailing "_"s in its > +name segments but may contain "\" to form an absolute path. > + > +trace_debug_layer > +The temporary debug_layer used when the tracing feature is enabled. > +Using ACPI_EXECUTER (0x80) by default, which is the debug_layer > +used to match all "AML tracer" logs. > + > +trace_debug_level > +The temporary debug_level used when the tracing feature is enabled. > +Using ACPI_LV_TRACE_POINT (0x10) by default, which is the > +debug_level used to match all "AML tracer" logs. > + > +trace_state > +The status of the tracing feature. > +Users can enable/disable this debug tracing feature by executing > +the following command:: For the above, please indent, in order to properly change the sysfs node font to bold. Also, mark paragraphs with a \n, e. g: trace_method_name The full path of the AML method that the user wants to trace. Note that the full path shouldn't contain the trailing "_"s in its name segments but may contain "\" to form an absolute path. trace_debug_layer The temporary debug_layer used when the tracing feature is enabled. Using ACPI_EXECUTER (0x80) by default, which is the debug_layer used to match all "AML tracer" logs. trace_debug_level The temporary debug_level used when the tracing feature is enabled. Using ACPI_LV_TRACE_POINT (0x10) by default, which is the debug_level used to match all "AML tracer" logs. trace_state The status of the tracing feature. Users can enable/disable this debug tracing feature by executing the following command:: After doing such changes: Reviewed-by: Mauro Carvalho Chehab > + > + # echo string > /sys/module/acpi/parameters/trace_state > + > +Where "string" should be one of the following: > + > +"disable" > + Disable the method tracing feature. > +"enable" > + Enable the method tracing feature. > + ACPICA debugging messages matching > + "trace_debug_layer/trace_debug_level" during any method > + execution will be logged. > +"method" > + Enable the method tracing feature. > + ACPICA debugging messages matching > + "trace_debug_layer/trace_debug_level" during method execution > + of "trace_method_name" will be logged. > +"method-once" > + Enable the method tracing feature. > + ACPICA debugging messages matching > + "trace_debug_layer/trace_debug_level" during method execution > + of "trace_method_name" will be logged only once. > +"opcode" > + Enable the method tracing feature. > + ACPICA debugging messages matching > + "trace_debug_layer/trace_debug_level" during method/opcode > + execution of "trace_method_name" will be logged. > +"opcode-once" > + Enable the method tracing feature. > + ACPICA debugging messages matching > + "trace_debug_layer/trace_debug_level" during method/opcode > + execution of "trace_method_name" will be logged only once. > + > +Note that, the difference between the "enable" and other feature > +enabling options are: > + > +1. When "enable" is specified, since > + "trace_debug_layer/trace_debug_level" shall apply to all control > + method evaluations, after configuring "trace_state" to "enable", > + "trace_method_name" will be reset to NULL. > +2. When "method/opcode" is specified, if > + "trace_method_name" is NULL when "trace_state" is configured to > + these options, the "trace_debug_layer/trace_debug_level" will > + apply to all control method evaluations. Thanks, Mauro
Re: [PATCH v4 20/63] Documentation: ACPI: move apei/einj.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:49 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> .../acpi/apei/einj.rst} | 98 ++-
> Documentation/firmware-guide/acpi/index.rst | 1 +
> 2 files changed, 53 insertions(+), 46 deletions(-)
> rename Documentation/{acpi/apei/einj.txt =>
> firmware-guide/acpi/apei/einj.rst} (67%)
>
> diff --git a/Documentation/acpi/apei/einj.txt
> b/Documentation/firmware-guide/acpi/apei/einj.rst
> similarity index 67%
> rename from Documentation/acpi/apei/einj.txt
> rename to Documentation/firmware-guide/acpi/apei/einj.rst
> index e550c8b98139..d85e2667155c 100644
> --- a/Documentation/acpi/apei/einj.txt
> +++ b/Documentation/firmware-guide/acpi/apei/einj.rst
> @@ -1,13 +1,16 @@
> - APEI Error INJection
> -
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +
> +APEI Error INJection
> +
>
> EINJ provides a hardware error injection mechanism. It is very useful
> for debugging and testing APEI and RAS features in general.
>
> You need to check whether your BIOS supports EINJ first. For that, look
> -for early boot messages similar to this one:
> +for early boot messages similar to this one::
>
> -ACPI: EINJ 0x7370A000 000150 (v01 INTEL 0001 INTL
> 0001)
> + ACPI: EINJ 0x7370A000 000150 (v01 INTEL 0001 INTL
> 0001)
>
> which shows that the BIOS is exposing an EINJ table - it is the
> mechanism through which the injection is done.
> @@ -23,11 +26,11 @@ order to see the APEI,EINJ,... functionality supported
> and exposed by
> the BIOS menu.
>
> To use EINJ, make sure the following are options enabled in your kernel
> -configuration:
> +configuration::
>
> -CONFIG_DEBUG_FS
> -CONFIG_ACPI_APEI
> -CONFIG_ACPI_APEI_EINJ
> + CONFIG_DEBUG_FS
> + CONFIG_ACPI_APEI
> + CONFIG_ACPI_APEI_EINJ
>
> The EINJ user interface is in /apei/einj.
>
> @@ -35,22 +38,22 @@ The following files belong to it:
>
> - available_error_type
>
> - This file shows which error types are supported:
> -
> - Error Type Value Error Description
> - =
> - 0x0001 Processor Correctable
> - 0x0002 Processor Uncorrectable non-fatal
> - 0x0004 Processor Uncorrectable fatal
> - 0x0008 Memory Correctable
> - 0x0010 Memory Uncorrectable non-fatal
> - 0x0020 Memory Uncorrectable fatal
> - 0x0040 PCI Express Correctable
> - 0x0080 PCI Express Uncorrectable fatal
> - 0x0100 PCI Express Uncorrectable non-fatal
> - 0x0200 Platform Correctable
> - 0x0400 Platform Uncorrectable non-fatal
> - 0x0800 Platform Uncorrectable fatal
> + This file shows which error types are supported::
> +
> +Error Type Value Error Description
> + =
> +0x0001 Processor Correctable
> +0x0002 Processor Uncorrectable non-fatal
> +0x0004 Processor Uncorrectable fatal
> +0x0008 Memory Correctable
> +0x0010 Memory Uncorrectable non-fatal
> +0x0020 Memory Uncorrectable fatal
> +0x0040 PCI Express Correctable
> +0x0080 PCI Express Uncorrectable fatal
> +0x0100 PCI Express Uncorrectable non-fatal
> +0x0200 Platform Correctable
> +0x0400 Platform Uncorrectable non-fatal
> +0x0800 Platform Uncorrectable fatal
This is a table and not a literal block.
The best here to preserve the author's intent is to just adjust the table
markups in order to make it parseable, e. g.:
This file shows which error types are supported:
===
Error Type Value Error Description
===
0x0001Processor Correctable
0x0002Processor Uncorrectable non-fatal
0x0004Processor Uncorrectable fatal
0x0008Memory Correctable
0x0010Memory Uncorrectable non-fatal
0x0020Memory Uncorrectable fatal
0x0040PCI Express Correctable
0x0080PCI Express Uncorrectable fatal
0x0100 PCI Express Uncorr
Re: [PATCH v4 23/63] Documentation: ACPI: move ssdt-overlays.txt to admin-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:52 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
Reviewed-by: Mauro Carvalho Chehab
> ---
> Documentation/acpi/ssdt-overlays.txt | 172 -
> Documentation/admin-guide/acpi/index.rst | 1 +
> .../admin-guide/acpi/ssdt-overlays.rst| 180 ++
> 3 files changed, 181 insertions(+), 172 deletions(-)
> delete mode 100644 Documentation/acpi/ssdt-overlays.txt
> create mode 100644 Documentation/admin-guide/acpi/ssdt-overlays.rst
>
> diff --git a/Documentation/acpi/ssdt-overlays.txt
> b/Documentation/acpi/ssdt-overlays.txt
> deleted file mode 100644
> index 5ae13f161ea2..
> --- a/Documentation/acpi/ssdt-overlays.txt
> +++ /dev/null
> @@ -1,172 +0,0 @@
> -
> -In order to support ACPI open-ended hardware configurations (e.g. development
> -boards) we need a way to augment the ACPI configuration provided by the
> firmware
> -image. A common example is connecting sensors on I2C / SPI buses on
> development
> -boards.
> -
> -Although this can be accomplished by creating a kernel platform driver or
> -recompiling the firmware image with updated ACPI tables, neither is
> practical:
> -the former proliferates board specific kernel code while the latter requires
> -access to firmware tools which are often not publicly available.
> -
> -Because ACPI supports external references in AML code a more practical
> -way to augment firmware ACPI configuration is by dynamically loading
> -user defined SSDT tables that contain the board specific information.
> -
> -For example, to enumerate a Bosch BMA222E accelerometer on the I2C bus of the
> -Minnowboard MAX development board exposed via the LSE connector [1], the
> -following ASL code can be used:
> -
> -DefinitionBlock ("minnowmax.aml", "SSDT", 1, "Vendor", "Accel", 0x0003)
> -{
> -External (\_SB.I2C6, DeviceObj)
> -
> -Scope (\_SB.I2C6)
> -{
> -Device (STAC)
> -{
> -Name (_ADR, Zero)
> -Name (_HID, "BMA222E")
> -
> -Method (_CRS, 0, Serialized)
> -{
> -Name (RBUF, ResourceTemplate ()
> -{
> -I2cSerialBus (0x0018, ControllerInitiated, 0x00061A80,
> - AddressingMode7Bit, "\\_SB.I2C6", 0x00,
> - ResourceConsumer, ,)
> -GpioInt (Edge, ActiveHigh, Exclusive, PullDown, 0x,
> - "\\_SB.GPO2", 0x00, ResourceConsumer, , )
> -{ // Pin list
> -0
> -}
> -})
> -Return (RBUF)
> -}
> -}
> -}
> -}
> -
> -which can then be compiled to AML binary format:
> -
> -$ iasl minnowmax.asl
> -
> -Intel ACPI Component Architecture
> -ASL Optimizing Compiler version 20140214-64 [Mar 29 2014]
> -Copyright (c) 2000 - 2014 Intel Corporation
> -
> -ASL Input: minnomax.asl - 30 lines, 614 bytes, 7 keywords
> -AML Output:minnowmax.aml - 165 bytes, 6 named objects, 1 executable
> opcodes
> -
> -[1]
> http://wiki.minnowboard.org/MinnowBoard_MAX#Low_Speed_Expansion_Connector_.28Top.29
> -
> -The resulting AML code can then be loaded by the kernel using one of the
> methods
> -below.
> -
> -== Loading ACPI SSDTs from initrd ==
> -
> -This option allows loading of user defined SSDTs from initrd and it is useful
> -when the system does not support EFI or when there is not enough EFI storage.
> -
> -It works in a similar way with initrd based ACPI tables override/upgrade:
> SSDT
> -aml code must be placed in the first, uncompressed, initrd under the
> -"kernel/firmware/acpi" path. Multiple files can be used and this will
> translate
> -in loading multiple tables. Only SSDT and OEM tables are allowed. See
> -initrd_table_override.txt for more details.
> -
> -Here is an example:
> -
> -# Add the raw ACPI tables to an uncompressed cpio archive.
> -# They must be put into a /kernel/firmware/acpi directory inside the
> -# cpio archive.
> -# The uncompressed cpio archive must be the first.
> -# Other, typically compressed cpio archives, must be
> -# concatenated on top of the uncompressed one.
> -mkdir -p kernel/firmware/acpi
> -cp ssdt.aml kernel/firmware/acpi
> -
> -# Create the uncompressed cpio archive and concatenate the original initrd
> -# on top:
> -find kernel |
Re: [PATCH v4 27/63] Documentation: PCI: convert PCIEBUS-HOWTO.txt to reST
Em Wed, 24 Apr 2019 00:28:56 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> .../{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst} | 140 ++
> Documentation/PCI/index.rst | 1 +
> 2 files changed, 82 insertions(+), 59 deletions(-)
> rename Documentation/PCI/{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst} (70%)
Names in lowercase after rename, please.
For the changes itself at the txt file:
Reviewed-by: Mauro Carvalho Chehab
>
> diff --git a/Documentation/PCI/PCIEBUS-HOWTO.txt
> b/Documentation/PCI/PCIEBUS-HOWTO.rst
> similarity index 70%
> rename from Documentation/PCI/PCIEBUS-HOWTO.txt
> rename to Documentation/PCI/PCIEBUS-HOWTO.rst
> index 15f0bb3b5045..f882ff62c51f 100644
> --- a/Documentation/PCI/PCIEBUS-HOWTO.txt
> +++ b/Documentation/PCI/PCIEBUS-HOWTO.rst
> @@ -1,16 +1,23 @@
> - The PCI Express Port Bus Driver Guide HOWTO
> - Tom L Nguyen tom.l.ngu...@intel.com
> - 11/03/2004
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
>
> -1. About this guide
> +===
> +The PCI Express Port Bus Driver Guide HOWTO
> +===
> +
> +:Author: Tom L Nguyen tom.l.ngu...@intel.com 11/03/2004
> +:Copyright: |copy| 2004 Intel Corporation
> +
> +About this guide
> +
>
> This guide describes the basics of the PCI Express Port Bus driver
> and provides information on how to enable the service drivers to
> register/unregister with the PCI Express Port Bus Driver.
>
> -2. Copyright 2004 Intel Corporation
>
> -3. What is the PCI Express Port Bus Driver
> +What is the PCI Express Port Bus Driver
> +===
>
> A PCI Express Port is a logical PCI-PCI Bridge structure. There
> are two types of PCI Express Port: the Root Port and the Switch
> @@ -30,7 +37,8 @@ support (AER), and virtual channel support (VC). These
> services may
> be handled by a single complex driver or be individually distributed
> and handled by corresponding service drivers.
>
> -4. Why use the PCI Express Port Bus Driver?
> +Why use the PCI Express Port Bus Driver?
> +
>
> In existing Linux kernels, the Linux Device Driver Model allows a
> physical device to be handled by only a single driver. The PCI
> @@ -51,28 +59,31 @@ PCI Express Ports and distributes all provided service
> requests
> to the corresponding service drivers as required. Some key
> advantages of using the PCI Express Port Bus driver are listed below:
>
> - - Allow multiple service drivers to run simultaneously on
> - a PCI-PCI Bridge Port device.
> + - Allow multiple service drivers to run simultaneously on
> +a PCI-PCI Bridge Port device.
>
> - - Allow service drivers implemented in an independent
> - staged approach.
> + - Allow service drivers implemented in an independent
> +staged approach.
>
> - - Allow one service driver to run on multiple PCI-PCI Bridge
> - Port devices.
> + - Allow one service driver to run on multiple PCI-PCI Bridge
> +Port devices.
>
> - - Manage and distribute resources of a PCI-PCI Bridge Port
> - device to requested service drivers.
> + - Manage and distribute resources of a PCI-PCI Bridge Port
> +device to requested service drivers.
>
> -5. Configuring the PCI Express Port Bus Driver vs. Service Drivers
> +Configuring the PCI Express Port Bus Driver vs. Service Drivers
> +===
>
> -5.1 Including the PCI Express Port Bus Driver Support into the Kernel
> +Including the PCI Express Port Bus Driver Support into the Kernel
> +-
>
> Including the PCI Express Port Bus driver depends on whether the PCI
> Express support is included in the kernel config. The kernel will
> automatically include the PCI Express Port Bus driver as a kernel
> driver when the PCI Express support is enabled in the kernel.
>
> -5.2 Enabling Service Driver Support
> +Enabling Service Driver Support
> +---
>
> PCI device drivers are implemented based on Linux Device Driver Model.
> All service drivers are PCI device drivers. As discussed above, it is
> @@ -89,9 +100,11 @@ header file /include/linux/pcieport_if.h, before calling
> these APIs.
> Failure to do so will result an identity mismatch, whi
Re: [PATCH v4 18/63] Documentation: ACPI: move aml-debugger.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:47 +0800 Changbin Du escreveu: > This converts the plain text documentation to reStructuredText format and > add it to Sphinx TOC tree. No essential content change. > > Signed-off-by: Changbin Du For the conversion changes: Reviewed-by: Mauro Carvalho Chehab > --- > Documentation/acpi/aml-debugger.txt | 66 > .../firmware-guide/acpi/aml-debugger.rst | 75 +++ > Documentation/firmware-guide/acpi/index.rst | 1 + > 3 files changed, 76 insertions(+), 66 deletions(-) > delete mode 100644 Documentation/acpi/aml-debugger.txt > create mode 100644 Documentation/firmware-guide/acpi/aml-debugger.rst > > diff --git a/Documentation/acpi/aml-debugger.txt > b/Documentation/acpi/aml-debugger.txt > deleted file mode 100644 > index 75ebeb64ab29.. > --- a/Documentation/acpi/aml-debugger.txt > +++ /dev/null > @@ -1,66 +0,0 @@ > -The AML Debugger > - > -Copyright (C) 2016, Intel Corporation > -Author: Lv Zheng > - > - > -This document describes the usage of the AML debugger embedded in the Linux > -kernel. > - > -1. Build the debugger > - > - The following kernel configuration items are required to enable the AML > - debugger interface from the Linux kernel: > - > - CONFIG_ACPI_DEBUGGER=y > - CONFIG_ACPI_DEBUGGER_USER=m > - > - The userspace utilities can be built from the kernel source tree using > - the following commands: > - > - $ cd tools > - $ make acpi > - > - The resultant userspace tool binary is then located at: > - > - tools/power/acpi/acpidbg > - > - It can be installed to system directories by running "make install" (as a > - sufficiently privileged user). > - > -2. Start the userspace debugger interface > - > - After booting the kernel with the debugger built-in, the debugger can be > - started by using the following commands: > - > - # mount -t debugfs none /sys/kernel/debug > - # modprobe acpi_dbg > - # tools/power/acpi/acpidbg > - > - That spawns the interactive AML debugger environment where you can execute > - debugger commands. > - > - The commands are documented in the "ACPICA Overview and Programmer > Reference" > - that can be downloaded from > - > - https://acpica.org/documentation > - > - The detailed debugger commands reference is located in Chapter 12 "ACPICA > - Debugger Reference". The "help" command can be used for a quick > reference. > - > -3. Stop the userspace debugger interface > - > - The interactive debugger interface can be closed by pressing Ctrl+C or > using > - the "quit" or "exit" commands. When finished, unload the module with: > - > - # rmmod acpi_dbg > - > - The module unloading may fail if there is an acpidbg instance running. > - > -4. Run the debugger in a script > - > - It may be useful to run the AML debugger in a test script. "acpidbg" > supports > - this in a special "batch" mode. For example, the following command > outputs > - the entire ACPI namespace: > - > - # acpidbg -b "namespace" > diff --git a/Documentation/firmware-guide/acpi/aml-debugger.rst > b/Documentation/firmware-guide/acpi/aml-debugger.rst > new file mode 100644 > index ..a889d43bc6c5 > --- /dev/null > +++ b/Documentation/firmware-guide/acpi/aml-debugger.rst > @@ -0,0 +1,75 @@ > +.. SPDX-License-Identifier: GPL-2.0 > +.. include:: > + > + > +The AML Debugger > + > + > +:Copyright: |copy| 2016, Intel Corporation > +:Author: Lv Zheng > + > + > +This document describes the usage of the AML debugger embedded in the Linux > +kernel. > + > +1. Build the debugger > += > + > +The following kernel configuration items are required to enable the AML > +debugger interface from the Linux kernel:: > + > + CONFIG_ACPI_DEBUGGER=y > + CONFIG_ACPI_DEBUGGER_USER=m > + > +The userspace utilities can be built from the kernel source tree using > +the following commands:: > + > + $ cd tools > + $ make acpi > + > +The resultant userspace tool binary is then located at:: > + > + tools/power/acpi/acpidbg > + > +It can be installed to system directories by running "make install" (as a > +sufficiently privileged user). > + > +2. Start the userspace debugger interface > += > + > +After booting the kernel with the debugger built-in, the debugger can be > +started by using the following commands:: > + > + # mount -t debugfs none /sys/
Re: [PATCH v4 21/63] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:50 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> .../acpi/cppc_sysfs.rst} | 71 ++-
> Documentation/admin-guide/acpi/index.rst | 1 +
> 2 files changed, 40 insertions(+), 32 deletions(-)
> rename Documentation/{acpi/cppc_sysfs.txt =>
> admin-guide/acpi/cppc_sysfs.rst} (51%)
>
> diff --git a/Documentation/acpi/cppc_sysfs.txt
> b/Documentation/admin-guide/acpi/cppc_sysfs.rst
> similarity index 51%
> rename from Documentation/acpi/cppc_sysfs.txt
> rename to Documentation/admin-guide/acpi/cppc_sysfs.rst
> index f20fb445135d..a4b99afbe331 100644
> --- a/Documentation/acpi/cppc_sysfs.txt
> +++ b/Documentation/admin-guide/acpi/cppc_sysfs.rst
> @@ -1,5 +1,11 @@
> +.. SPDX-License-Identifier: GPL-2.0
>
> - Collaborative Processor Performance Control (CPPC)
> +==
> +Collaborative Processor Performance Control (CPPC)
> +==
> +
> +CPPC
> +
>
> CPPC defined in the ACPI spec describes a mechanism for the OS to manage the
> performance of a logical processor on a contigious and abstract performance
> @@ -10,31 +16,28 @@ For more details on CPPC please refer to the ACPI
> specification at:
>
> http://uefi.org/specifications
>
> -Some of the CPPC registers are exposed via sysfs under:
> -
> -/sys/devices/system/cpu/cpuX/acpi_cppc/
> -
> -for each cpu X
Hmm... removed by mistake?
> +Some of the CPPC registers are exposed via sysfs under::
>
> -
> + /sys/devices/system/cpu/cpuX/acpi_cppc/
Did you parse this with Sphinx? It doesn't sound a valid ReST construction
to my eyes, as:
1) I've seen some versions of Sphinx to abort with severe errors when
there's no blank line after the horizontal bar markup;
2) It will very likely ignore the "::" (I didn't test it myself), as you're
not indenting the horizontal bar. End of indentation will mean the end
of an (empty) literal block.
So, I would stick with:
Some of the CPPC registers are exposed via sysfs under:
/sys/devices/system/cpu/cpuX/acpi_cppc/
-
for each cpu X::
or:
Some of the CPPC registers are exposed via sysfs under:
/sys/devices/system/cpu/cpuX/acpi_cppc/
for each cpu X
::
(with is closer to the original author's intent)
Same applies to the other similar changes on this document.
>
> -$ ls -lR /sys/devices/system/cpu/cpu0/acpi_cppc/
> -/sys/devices/system/cpu/cpu0/acpi_cppc/:
> -total 0
> --r--r--r-- 1 root root 65536 Mar 5 19:38 feedback_ctrs
> --r--r--r-- 1 root root 65536 Mar 5 19:38 highest_perf
> --r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_freq
> --r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_nonlinear_perf
> --r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_perf
> --r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_freq
> --r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_perf
> --r--r--r-- 1 root root 65536 Mar 5 19:38 reference_perf
> --r--r--r-- 1 root root 65536 Mar 5 19:38 wraparound_time
> +for each cpu X::
>
> -
> + $ ls -lR /sys/devices/system/cpu/cpu0/acpi_cppc/
> + /sys/devices/system/cpu/cpu0/acpi_cppc/:
> + total 0
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 feedback_ctrs
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 highest_perf
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_freq
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_nonlinear_perf
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_perf
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_freq
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_perf
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 reference_perf
> + -r--r--r-- 1 root root 65536 Mar 5 19:38 wraparound_time
>
> * highest_perf : Highest performance of this processor (abstract scale).
> -* nominal_perf : Highest sustained performance of this processor (abstract
> scale).
> +* nominal_perf : Highest sustained performance of this processor
> + (abstract scale).
> * lowest_nonlinear_perf : Lowest performance of this processor with nonlinear
>power savings (abstract scale).
> * lowest_perf : Lowest performance of this processor (abstract scale).
> @@ -48,22 +51,26 @@ total 0
> * feedback_ctrs : Includes both Reference and delivered performance counter.
>Reference counter ticks up proportional to processor's reference
> performance.
>Delivered counter ticks up proportional to processor's
Re: [PATCH v4 22/63] Documentation: ACPI: move lpit.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:51 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
Reviewed-by: Mauro Carvalho Chehab
> ---
> Documentation/firmware-guide/acpi/index.rst| 1 +
> .../lpit.txt => firmware-guide/acpi/lpit.rst} | 18 +-
> 2 files changed, 14 insertions(+), 5 deletions(-)
> rename Documentation/{acpi/lpit.txt => firmware-guide/acpi/lpit.rst} (68%)
>
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index fca854f017d8..0e60f4b7129a 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -22,3 +22,4 @@ ACPI Support
> gpio-properties
> i2c-muxes
> acpi-lid
> + lpit
> diff --git a/Documentation/acpi/lpit.txt
> b/Documentation/firmware-guide/acpi/lpit.rst
> similarity index 68%
> rename from Documentation/acpi/lpit.txt
> rename to Documentation/firmware-guide/acpi/lpit.rst
> index b426398d2e97..aca928fab027 100644
> --- a/Documentation/acpi/lpit.txt
> +++ b/Documentation/firmware-guide/acpi/lpit.rst
> @@ -1,3 +1,9 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===
> +Low Power Idle Table (LPIT)
> +===
> +
> To enumerate platform Low Power Idle states, Intel platforms are using
> “Low Power Idle Table” (LPIT). More details about this table can be
> downloaded from:
> @@ -8,13 +14,15 @@ Residencies for each low power state can be read via FFH
>
> On platforms supporting S0ix sleep states, there can be two types of
> residencies:
> -- CPU PKG C10 (Read via FFH interface)
> -- Platform Controller Hub (PCH) SLP_S0 (Read via memory mapped interface)
> +
> + - CPU PKG C10 (Read via FFH interface)
> + - Platform Controller Hub (PCH) SLP_S0 (Read via memory mapped interface)
>
> The following attributes are added dynamically to the cpuidle
> -sysfs attribute group:
> - /sys/devices/system/cpu/cpuidle/low_power_idle_cpu_residency_us
> - /sys/devices/system/cpu/cpuidle/low_power_idle_system_residency_us
> +sysfs attribute group::
> +
> + /sys/devices/system/cpu/cpuidle/low_power_idle_cpu_residency_us
> + /sys/devices/system/cpu/cpuidle/low_power_idle_system_residency_us
>
> The "low_power_idle_cpu_residency_us" attribute shows time spent
> by the CPU package in PKG C10
Thanks,
Mauro
Re: [PATCH v4 24/63] Documentation: ACPI: move video_extension.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:53 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> Documentation/firmware-guide/acpi/index.rst | 1 +
> .../acpi/video_extension.rst} | 63 ++-
> 2 files changed, 36 insertions(+), 28 deletions(-)
> rename Documentation/{acpi/video_extension.txt =>
> firmware-guide/acpi/video_extension.rst} (79%)
>
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 0e60f4b7129a..ae609eec4679 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -23,3 +23,4 @@ ACPI Support
> i2c-muxes
> acpi-lid
> lpit
> + video_extension
> diff --git a/Documentation/acpi/video_extension.txt
> b/Documentation/firmware-guide/acpi/video_extension.rst
> similarity index 79%
> rename from Documentation/acpi/video_extension.txt
> rename to Documentation/firmware-guide/acpi/video_extension.rst
> index 79bf6a4921be..06f7e3230b6e 100644
> --- a/Documentation/acpi/video_extension.txt
> +++ b/Documentation/firmware-guide/acpi/video_extension.rst
> @@ -1,5 +1,8 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=
> ACPI video extensions
> -~
> +=
>
> This driver implement the ACPI Extensions For Display Adapters for
> integrated graphics devices on motherboard, as specified in ACPI 2.0
> @@ -8,9 +11,10 @@ defining the video POST device, retrieving EDID information
> or to
> setup a video output, etc. Note that this is an ref. implementation
> only. It may or may not work for your integrated video device.
>
> -The ACPI video driver does 3 things regarding backlight control:
> +The ACPI video driver does 3 things regarding backlight control.
>
> -1 Export a sysfs interface for user space to control backlight level
> +1. Export a sysfs interface for user space to control backlight level
> +=
>
> If the ACPI table has a video device, and acpi_backlight=vendor kernel
> command line is not present, the driver will register a backlight device
Hmm... you didn't touch on this part of the document:
And what ACPI video driver does is:
actual_brightness: on read, control method _BQC will be evaluated to
get the brightness level the firmware thinks it is at;
bl_power: not implemented, will set the current brightness instead;
brightness: on write, control method _BCM will run to set the requested
brightness level;
max_brightness: Derived from the _BCL package(see below);
type: firmware
You should touch it. My suggestion here is:
And what ACPI video driver does is:
actual_brightness:
on read, control method _BQC will be evaluated to
get the brightness level the firmware thinks it is at;
bl_power:
not implemented, will set the current brightness instead;
brightness:
on write, control method _BCM will run to set the requested
brightness level;
max_brightness:
Derived from the _BCL package(see below);
type:
firmware
> @@ -32,26 +36,26 @@ type: firmware
>
> Note that ACPI video backlight driver will always use index for
> brightness, actual_brightness and max_brightness. So if we have
> -the following _BCL package:
> +the following _BCL package::
>
> -Method (_BCL, 0, NotSerialized)
> -{
> - Return (Package (0x0C)
> + Method (_BCL, 0, NotSerialized)
> {
> - 0x64,
> - 0x32,
> - 0x0A,
> - 0x14,
> - 0x1E,
> - 0x28,
> - 0x32,
> - 0x3C,
> - 0x46,
> - 0x50,
> - 0x5A,
> - 0x64
> - })
> -}
> + Return (Package (0x0C)
> + {
> + 0x64,
> + 0x32,
> + 0x0A,
> + 0x14,
> + 0x1E,
> + 0x28,
> + 0x32,
> + 0x3C,
> + 0x46,
> + 0x50,
> + 0x5A,
> + 0x64
> + })
> + }
>
> The first two levels are for when laptop are on AC or on battery and are
> not used by Linux currently. The remaining 10 levels are supported levels
> @@ -62,13 +66,15 @@ as a "brightness level" indicator. Thus from the user
> space perspective
> the range of available brightness levels is from 0 to 9 (max_brightness)
> inclusive.
>
> -2 Notify user space about hotkey event
> +2. Notify user space about hotkey event
>
Re: [PATCH v4 30/63] Documentation: PCI: convert acpi-info.txt to reST
Em Wed, 24 Apr 2019 00:28:59 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> Documentation/PCI/{acpi-info.txt => acpi-info.rst} | 11 ---
> Documentation/PCI/index.rst| 1 +
> 2 files changed, 9 insertions(+), 3 deletions(-)
> rename Documentation/PCI/{acpi-info.txt => acpi-info.rst} (97%)
>
> diff --git a/Documentation/PCI/acpi-info.txt b/Documentation/PCI/acpi-info.rst
> similarity index 97%
> rename from Documentation/PCI/acpi-info.txt
> rename to Documentation/PCI/acpi-info.rst
> index 3ffa3b03970e..f7dabb7ca255 100644
> --- a/Documentation/PCI/acpi-info.txt
> +++ b/Documentation/PCI/acpi-info.rst
> @@ -1,4 +1,8 @@
> - ACPI considerations for PCI host bridges
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +
> +ACPI considerations for PCI host bridges
> +
>
> The general rule is that the ACPI namespace should describe everything the
> OS might use unless there's another way for the OS to find it [1, 2].
> @@ -135,8 +139,9 @@ address always corresponds to bus 0, even if the bus
> range below the bridge
>
> Extended Address Space Descriptor (.4)
> General Flags: Bit [0] Consumer/Producer:
> - 1–This device consumes this resource
> - 0–This device produces and consumes this resource
> +
> +* 1 – This device consumes this resource
> +* 0 – This device produces and consumes this resource
Hmm.. I think that you would need to add some extra blank lines before
the above, e. g., something like:
[4] ACPI 6.2, sec 6.4.3.5.1, 2, 3, 4:
QWord/DWord/Word Address Space Descriptor (.1, .2, .3)
General Flags: Bit [0] Ignored
Extended Address Space Descriptor (.4)
General Flags: Bit [0] Consumer/Producer:
* 1 – This device consumes this resource
* 0 – This device produces and consumes this resource
>
> [5] ACPI 6.2, sec 19.6.43:
> ResourceUsage specifies whether the Memory range is consumed by
> diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst
> index 1b25bcc1edca..c877a369481d 100644
> --- a/Documentation/PCI/index.rst
> +++ b/Documentation/PCI/index.rst
> @@ -12,3 +12,4 @@ Linux PCI Bus Subsystem
> PCIEBUS-HOWTO
> pci-iov-howto
> MSI-HOWTO
> + acpi-info
Thanks,
Mauro
Re: [PATCH v4 19/63] Documentation: ACPI: move apei/output_format.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:48 +0800 Changbin Du escreveu: > This converts the plain text documentation to reStructuredText format and > add it to Sphinx TOC tree. No essential content change. > > Signed-off-by: Changbin Du For the conversion changes: Reviewed-by: Mauro Carvalho Chehab > --- > Documentation/acpi/apei/output_format.txt | 147 - > .../acpi/apei/output_format.rst | 150 ++ > Documentation/firmware-guide/acpi/index.rst | 1 + > 3 files changed, 151 insertions(+), 147 deletions(-) > delete mode 100644 Documentation/acpi/apei/output_format.txt > create mode 100644 Documentation/firmware-guide/acpi/apei/output_format.rst > > diff --git a/Documentation/acpi/apei/output_format.txt > b/Documentation/acpi/apei/output_format.txt > deleted file mode 100644 > index 0c49c197c47a.. > --- a/Documentation/acpi/apei/output_format.txt > +++ /dev/null > @@ -1,147 +0,0 @@ > - APEI output format > - ~~ > - > -APEI uses printk as hardware error reporting interface, the output > -format is as follow. > - > - := > -APEI generic hardware error status > -severity: , > -section: , severity: , > -flags: > - > -fru_id: > -fru_text: > -section_type: > - > - > -* := recoverable | fatal | corrected | info > - > -# := > -[primary][, containment warning][, reset][, threshold exceeded]\ > -[, resource not accessible][, latent error] > - > - := generic processor error | memory error | \ > -PCIe error | unknown, > - > - := > - | | \ > - | > - > - := > -[processor_type: , ] > -[processor_isa: , ] > -[error_type: > -] > -[operation: , ] > -[flags: > -] > -[level: ] > -[version_info: ] > -[processor_id: ] > -[target_address: ] > -[requestor_id: ] > -[responder_id: ] > -[IP: ] > - > -* := IA32/X64 | IA64 > - > -* := IA32 | IA64 | X64 > - > -# := > -[cache error][, TLB error][, bus error][, micro-architectural error] > - > -* := unknown or generic | data read | data write | \ > -instruction execution > - > -# := > -[restartable][, precise IP][, overflow][, corrected] > - > - := > -[error_status: ] > -[physical_address: ] > -[physical_address_mask: ] > -[node: ] > -[card: ] > -[module: ] > -[bank: ] > -[device: ] > -[row: ] > -[column: ] > -[bit_position: ] > -[requestor_id: ] > -[responder_id: ] > -[target_id: ] > -[error_type: , ] > - > -* := > -unknown | no error | single-bit ECC | multi-bit ECC | \ > -single-symbol chipkill ECC | multi-symbol chipkill ECC | master abort | \ > -target abort | parity error | watchdog timeout | invalid address | \ > -mirror Broken | memory sparing | scrub corrected error | \ > -scrub uncorrected error > - > - := > -[port_type: , ] > -[version: .] > -[command: , status: ] > -[device_id: ::. > -slot: > -secondary_bus: > -vendor_id: , device_id: > -class_code: ] > -[serial number: , ] > -[bridge: secondary_status: , control: ] > -[aer_status: , aer_mask: > - > -[aer_uncor_severity: ] > -aer_layer=, aer_agent= > -aer_tlp_header:] > - > -* := PCIe end point | legacy PCI end point | \ > -unknown | unknown | root port | upstream switch port | \ > -downstream switch port | PCIe to PCI/PCI-X bridge | \ > -PCI/PCI-X to PCIe bridge | root complex integrated endpoint device | \ > -root complex event collector > - > -if section severity is fatal or recoverable > -# := > -unknown | unknown | unknown | unknown | Data Link Protocol | \ > -unknown | unknown | unknown | unknown | unknown | unknown | unknown | \ > -Poisoned TLP | Flow Control Protocol | Completion Timeout | \ > -Completer Abort | Unexpected Completion | Receiver Overflow | \ > -Malformed TLP | ECRC | Unsupported Request > -else > -# := > -Receiver Error | unknown | unknown | unknown | unknown | unknown | \ > -Bad TLP | Bad DLLP | RELAY_NUM Rollover | unknown | unknown | unknown | \ > -Replay Timer Timeout | Advisory Non-Fatal > -fi > - > - := > -Physical Layer | Data Link Layer | Transaction Layer > - > - := > -Receiver ID | Requester ID | Completer ID | Transmitter ID > - > -Where, [] designate corresponding content is optional > - > -All description with * has the following format: > - > -field: , > - > -Where value of should be the position of "string" in -string> description. Otherwise, will be "unknown". > - > -All description with # has the following format: > - > -field: > - > - > -Where each string in corresponding to one set bit of > -. The bit position is the position of "string
Re: [PATCH v4 28/63] Documentation: PCI: convert pci-iov-howto.txt to reST
Em Wed, 24 Apr 2019 00:28:57 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> Documentation/PCI/index.rst | 1 +
> .../{pci-iov-howto.txt => pci-iov-howto.rst} | 161 ++
> 2 files changed, 94 insertions(+), 68 deletions(-)
> rename Documentation/PCI/{pci-iov-howto.txt => pci-iov-howto.rst} (63%)
Reviewed-by: Mauro Carvalho Chehab
>
> diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst
> index 452723318405..e1c19962a7f8 100644
> --- a/Documentation/PCI/index.rst
> +++ b/Documentation/PCI/index.rst
> @@ -10,3 +10,4 @@ Linux PCI Bus Subsystem
>
> pci
> PCIEBUS-HOWTO
> + pci-iov-howto
> diff --git a/Documentation/PCI/pci-iov-howto.txt
> b/Documentation/PCI/pci-iov-howto.rst
> similarity index 63%
> rename from Documentation/PCI/pci-iov-howto.txt
> rename to Documentation/PCI/pci-iov-howto.rst
> index d2a84151e99c..b9fd003206f1 100644
> --- a/Documentation/PCI/pci-iov-howto.txt
> +++ b/Documentation/PCI/pci-iov-howto.rst
> @@ -1,14 +1,19 @@
> - PCI Express I/O Virtualization Howto
> - Copyright (C) 2009 Intel Corporation
> - Yu Zhao
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
>
> - Update: November 2012
> - -- sysfs-based SRIOV enable-/disable-ment
> - Donald Dutile
> +
> +PCI Express I/O Virtualization Howto
> +
>
> -1. Overview
> +:Copyright: |copy| 2009 Intel Corporation
> +:Authors: - Yu Zhao
> + - Donald Dutile
>
> -1.1 What is SR-IOV
> +Overview
> +
> +
> +What is SR-IOV
> +--
>
> Single Root I/O Virtualization (SR-IOV) is a PCI Express Extended
> capability which makes one physical device appear as multiple virtual
> @@ -23,9 +28,11 @@ Memory Space, which is used to map its register set. VF
> device driver
> operates on the register set so it can be functional and appear as a
> real existing PCI device.
>
> -2. User Guide
> +User Guide
> +==
>
> -2.1 How can I enable SR-IOV capability
> +How can I enable SR-IOV capability
> +--
>
> Multiple methods are available for SR-IOV enablement.
> In the first method, the device driver (PF driver) will control the
> @@ -43,105 +50,123 @@ checks, e.g., check numvfs == 0 if enabling VFs, ensure
> numvfs <= totalvfs.
> The second method is the recommended method for new/future VF devices.
>
> -2.2 How can I use the Virtual Functions
> +How can I use the Virtual Functions
> +---
>
> The VF is treated as hot-plugged PCI devices in the kernel, so they
> should be able to work in the same way as real PCI devices. The VF
> requires device driver that is same as a normal PCI device's.
>
> -3. Developer Guide
> +Developer Guide
> +===
>
> -3.1 SR-IOV API
> +SR-IOV API
> +--
>
> To enable SR-IOV capability:
> -(a) For the first method, in the driver:
> +
> +(a) For the first method, in the driver::
> +
> int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
> - 'nr_virtfn' is number of VFs to be enabled.
> -(b) For the second method, from sysfs:
> +
> +'nr_virtfn' is number of VFs to be enabled.
> +
> +(b) For the second method, from sysfs::
> +
> echo 'nr_virtfn' > \
> /sys/bus/pci/devices//sriov_numvfs
>
> To disable SR-IOV capability:
> -(a) For the first method, in the driver:
> +
> +(a) For the first method, in the driver::
> +
> void pci_disable_sriov(struct pci_dev *dev);
> -(b) For the second method, from sysfs:
> +
> +(b) For the second method, from sysfs::
> +
> echo 0 > \
> /sys/bus/pci/devices//sriov_numvfs
>
> To enable auto probing VFs by a compatible driver on the host, run
> command below before enabling SR-IOV capabilities. This is the
> default behavior.
> +::
> +
> echo 1 > \
>
> /sys/bus/pci/devices//sriov_drivers_autoprobe
>
> To disable auto probing VFs by a compatible driver on the host, run
> command below before enabling SR-IOV capabilities. Updating this
> entry will not affect VFs which are already probed.
> +::
> +
> echo 0 > \
>
> /sys/bus/pci/devices//sriov_drivers_autoprobe
>
> -3.2 Usage example
> +Usage example
> +-
Re: [PATCH v4 31/63] Documentation: PCI: convert pci-error-recovery.txt to reST
Em Wed, 24 Apr 2019 00:29:00 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> Documentation/PCI/index.rst | 1 +
> ...or-recovery.txt => pci-error-recovery.rst} | 178 +-
> MAINTAINERS | 2 +-
> 3 files changed, 94 insertions(+), 87 deletions(-)
> rename Documentation/PCI/{pci-error-recovery.txt => pci-error-recovery.rst}
> (80%)
>
> diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst
> index c877a369481d..5ee4dba07116 100644
> --- a/Documentation/PCI/index.rst
> +++ b/Documentation/PCI/index.rst
> @@ -13,3 +13,4 @@ Linux PCI Bus Subsystem
> pci-iov-howto
> MSI-HOWTO
> acpi-info
> + pci-error-recovery
> diff --git a/Documentation/PCI/pci-error-recovery.txt
> b/Documentation/PCI/pci-error-recovery.rst
> similarity index 80%
> rename from Documentation/PCI/pci-error-recovery.txt
> rename to Documentation/PCI/pci-error-recovery.rst
> index 0b6bb3ef449e..533ec4035bf5 100644
> --- a/Documentation/PCI/pci-error-recovery.txt
> +++ b/Documentation/PCI/pci-error-recovery.rst
> @@ -1,12 +1,13 @@
> +.. SPDX-License-Identifier: GPL-2.0
>
> - PCI Error Recovery
> - --
> -February 2, 2006
> +==
> +PCI Error Recovery
> +==
>
> - Current document maintainer:
> - Linas Vepstas
> - updated by Richard Lary
> - and Mike Mason on 27-Jul-2009
Just wondering: wouldn't be good to preserve the date here?
> +
> +:Authors: - Linas Vepstas
> + - Richard Lary
> + - Mike Mason
>
>
> Many PCI bus controllers are able to detect a variety of hardware
> @@ -63,7 +64,8 @@ mechanisms for dealing with SCSI bus errors and SCSI bus
> resets.
>
>
> Detailed Design
>
> +===
> +
> Design and implementation details below, based on a chain of
> public email discussions with Ben Herrenschmidt, circa 5 April 2005.
>
> @@ -73,30 +75,33 @@ pci_driver. A driver that fails to provide the structure
> is "non-aware",
> and the actual recovery steps taken are platform dependent. The
> arch/powerpc implementation will simulate a PCI hotplug remove/add.
>
> -This structure has the form:
> -struct pci_error_handlers
> -{
> - int (*error_detected)(struct pci_dev *dev, enum pci_channel_state);
> - int (*mmio_enabled)(struct pci_dev *dev);
> - int (*slot_reset)(struct pci_dev *dev);
> - void (*resume)(struct pci_dev *dev);
> -};
> -
> -The possible channel states are:
> -enum pci_channel_state {
> - pci_channel_io_normal, /* I/O channel is in normal state */
> - pci_channel_io_frozen, /* I/O to channel is blocked */
> - pci_channel_io_perm_failure, /* PCI card is dead */
> -};
> -
> -Possible return values are:
> -enum pci_ers_result {
> - PCI_ERS_RESULT_NONE,/* no result/none/not supported in device
> driver */
> - PCI_ERS_RESULT_CAN_RECOVER, /* Device driver can recover without slot
> reset */
> - PCI_ERS_RESULT_NEED_RESET, /* Device driver wants slot to be reset. */
> - PCI_ERS_RESULT_DISCONNECT, /* Device has completely failed, is
> unrecoverable */
> - PCI_ERS_RESULT_RECOVERED, /* Device driver is fully recovered and
> operational */
> -};
> +This structure has the form::
> +
> + struct pci_error_handlers
> + {
> + int (*error_detected)(struct pci_dev *dev, enum
> pci_channel_state);
> + int (*mmio_enabled)(struct pci_dev *dev);
> + int (*slot_reset)(struct pci_dev *dev);
> + void (*resume)(struct pci_dev *dev);
> + };
> +
> +The possible channel states are::
> +
> + enum pci_channel_state {
> + pci_channel_io_normal, /* I/O channel is in normal state */
> + pci_channel_io_frozen, /* I/O to channel is blocked */
> + pci_channel_io_perm_failure, /* PCI card is dead */
> + };
> +
> +Possible return values are::
> +
> + enum pci_ers_result {
> + PCI_ERS_RESULT_NONE,/* no result/none/not supported in
> device driver */
> + PCI_ERS_RESULT_CAN_RECOVER, /* Device driver can recover
> without slot reset */
> + PCI_ERS_RESULT_NEED_RESET, /* Device driver wants slot to be
> reset. */
> + PCI_ERS_RESULT_DISCONNECT, /* Device has completely failed, is
> unrecoverable */
> + PCI_ERS_RESULT_RECOVERED, /* Device driver is fully recovered
> and operational */
> + };
>
> A driver does not have to implement all of these callbacks; however,
> if it implements any, it must implement error_detected(). If a callback
> @@ -134,16 +139,17 @@ shouldn't do any new IOs. Called in task context. This
> is
Re: [PATCH v4 33/63] Documentation: PCI: convert endpoint/pci-endpoint.txt to reST
Em Wed, 24 Apr 2019 00:29:02 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> Documentation/PCI/endpoint/index.rst | 10 ++
> .../{pci-endpoint.txt => pci-endpoint.rst}| 95 +++
> Documentation/PCI/index.rst | 1 +
> 3 files changed, 68 insertions(+), 38 deletions(-)
> create mode 100644 Documentation/PCI/endpoint/index.rst
> rename Documentation/PCI/endpoint/{pci-endpoint.txt => pci-endpoint.rst}
> (82%)
>
> diff --git a/Documentation/PCI/endpoint/index.rst
> b/Documentation/PCI/endpoint/index.rst
> new file mode 100644
> index ..0db4f2fcd7f0
> --- /dev/null
> +++ b/Documentation/PCI/endpoint/index.rst
> @@ -0,0 +1,10 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==
> +PCI Endpoint Framework
> +==
> +
> +.. toctree::
> + :maxdepth: 2
> +
> + pci-endpoint
> diff --git a/Documentation/PCI/endpoint/pci-endpoint.txt
> b/Documentation/PCI/endpoint/pci-endpoint.rst
> similarity index 82%
> rename from Documentation/PCI/endpoint/pci-endpoint.txt
> rename to Documentation/PCI/endpoint/pci-endpoint.rst
> index e86a96b66a6a..6674ce5425bf 100644
> --- a/Documentation/PCI/endpoint/pci-endpoint.txt
> +++ b/Documentation/PCI/endpoint/pci-endpoint.rst
> @@ -1,11 +1,17 @@
> - PCI ENDPOINT FRAMEWORK
> - Kishon Vijay Abraham I
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==
> +PCI Endpoint Framework
> +==
Hmm... considering that you decided to create an index file for the
endpoint, with the same title, I would just remove this from here.
> +
> +:Author: Kishon Vijay Abraham I
>
> This document is a guide to use the PCI Endpoint Framework in order to create
> endpoint controller driver, endpoint function driver, and using configfs
> interface to bind the function driver to the controller driver.
>
> -1. Introduction
> +Introduction
> +
>
> Linux has a comprehensive PCI subsystem to support PCI controllers that
> operates in Root Complex mode. The subsystem has capability to scan PCI bus,
> @@ -19,24 +25,27 @@ add endpoint mode support in Linux. This will help to run
> Linux in an
> EP system which can have a wide variety of use cases from testing or
> validation, co-processor accelerator, etc.
>
> -2. PCI Endpoint Core
> +PCI Endpoint Core
> +=
>
> The PCI Endpoint Core layer comprises 3 components: the Endpoint Controller
> library, the Endpoint Function library, and the configfs layer to bind the
> endpoint function with the endpoint controller.
>
> -2.1 PCI Endpoint Controller(EPC) Library
> +PCI Endpoint Controller(EPC) Library
> +
>
> The EPC library provides APIs to be used by the controller that can operate
> in endpoint mode. It also provides APIs to be used by function driver/library
> in order to implement a particular endpoint function.
>
> -2.1.1 APIs for the PCI controller Driver
> +APIs for the PCI controller Driver
> +~~
>
> This section lists the APIs that the PCI Endpoint core provides to be used
> by the PCI controller driver.
>
> -*) devm_pci_epc_create()/pci_epc_create()
> +* devm_pci_epc_create()/pci_epc_create()
I would, instead, promote this as a sub-level. E. g. something like:
devm_pci_epc_create()/pci_epc_create()
..
(if you do that, you'll need to also promote some similar function
documentation within this doc)
>
> The PCI controller driver should implement the following ops:
>* write_header: ops to populate configuration space header
Better to add a blank line between those two lines. There's no sense
(IMHO) on using bold font to the first line here.
> @@ -51,110 +60,116 @@ by the PCI controller driver.
> The PCI controller driver can then create a new EPC device by invoking
> devm_pci_epc_create()/pci_epc_create().
>
> -*) devm_pci_epc_destroy()/pci_epc_destroy()
> +* devm_pci_epc_destroy()/pci_epc_destroy()
>
> The PCI controller driver can destroy the EPC device created by either
> devm_pci_epc_create() or pci_epc_create() using devm_pci_epc_destroy() or
> pci_epc_destroy().
>
> -*) pci_epc_linkup()
> +* pci_epc_linkup()
>
> In order to notify all the function devices that the EPC device to which
> they are linked has established a link with the host, the PCI controller
> driver should invoke pci_epc_linkup().
>
> -*) pci_epc_mem_init()
> +* pci_epc_mem_init()
>
> Initialize the pci_epc_mem structure used for allocating EPC addr space.
>
> -*) pci_epc_mem_exit()
> +* pci_epc_mem_exit()
>
> Cleanup the pci_epc_mem structure allocated during pci_epc_mem_init().
>
> -2.1.2 APIs
Re: [PATCH v4 36/63] Documentation: PCI: convert endpoint/pci-test-howto.txt to reST
Em Wed, 24 Apr 2019 00:29:05 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
Reviewed-by: Mauro Carvalho Chehab
> ---
> Documentation/PCI/endpoint/index.rst | 1 +
> ...{pci-test-howto.txt => pci-test-howto.rst} | 81 +--
> 2 files changed, 56 insertions(+), 26 deletions(-)
> rename Documentation/PCI/endpoint/{pci-test-howto.txt => pci-test-howto.rst}
> (78%)
>
> diff --git a/Documentation/PCI/endpoint/index.rst
> b/Documentation/PCI/endpoint/index.rst
> index b680a3fc4fec..d114ea74b444 100644
> --- a/Documentation/PCI/endpoint/index.rst
> +++ b/Documentation/PCI/endpoint/index.rst
> @@ -10,3 +10,4 @@ PCI Endpoint Framework
> pci-endpoint
> pci-endpoint-cfs
> pci-test-function
> + pci-test-howto
> diff --git a/Documentation/PCI/endpoint/pci-test-howto.txt
> b/Documentation/PCI/endpoint/pci-test-howto.rst
> similarity index 78%
> rename from Documentation/PCI/endpoint/pci-test-howto.txt
> rename to Documentation/PCI/endpoint/pci-test-howto.rst
> index 040479f437a5..909f770a07d6 100644
> --- a/Documentation/PCI/endpoint/pci-test-howto.txt
> +++ b/Documentation/PCI/endpoint/pci-test-howto.rst
> @@ -1,38 +1,51 @@
> - PCI TEST USERGUIDE
> - Kishon Vijay Abraham I
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===
> +PCI Test User Guide
> +===
> +
> +:Author: Kishon Vijay Abraham I
>
> This document is a guide to help users use pci-epf-test function driver
> and pci_endpoint_test host driver for testing PCI. The list of steps to
> be followed in the host side and EP side is given below.
>
> -1. Endpoint Device
> +Endpoint Device
> +===
>
> -1.1 Endpoint Controller Devices
> +Endpoint Controller Devices
> +---
>
> -To find the list of endpoint controller devices in the system:
> +To find the list of endpoint controller devices in the system::
>
> # ls /sys/class/pci_epc/
> 5100.pcie_ep
>
> -If PCI_ENDPOINT_CONFIGFS is enabled
> +If PCI_ENDPOINT_CONFIGFS is enabled::
> +
> # ls /sys/kernel/config/pci_ep/controllers
> 5100.pcie_ep
>
> -1.2 Endpoint Function Drivers
>
> -To find the list of endpoint function drivers in the system:
> +Endpoint Function Drivers
> +-
> +
> +To find the list of endpoint function drivers in the system::
>
> # ls /sys/bus/pci-epf/drivers
> pci_epf_test
>
> -If PCI_ENDPOINT_CONFIGFS is enabled
> +If PCI_ENDPOINT_CONFIGFS is enabled::
> +
> # ls /sys/kernel/config/pci_ep/functions
> pci_epf_test
>
> -1.3 Creating pci-epf-test Device
> +
> +Creating pci-epf-test Device
> +
>
> PCI endpoint function device can be created using the configfs. To create
> -pci-epf-test device, the following commands can be used
> +pci-epf-test device, the following commands can be used::
>
> # mount -t configfs none /sys/kernel/config
> # cd /sys/kernel/config/pci_ep/
> @@ -42,7 +55,7 @@ The "mkdir func1" above creates the pci-epf-test function
> device that will
> be probed by pci_epf_test driver.
>
> The PCI endpoint framework populates the directory with the following
> -configurable fields.
> +configurable fields::
>
> # ls functions/pci_epf_test/func1
> baseclass_codeinterrupt_pin progif_code subsys_id
> @@ -51,67 +64,83 @@ configurable fields.
>
> The PCI endpoint function driver populates these entries with default values
> when the device is bound to the driver. The pci-epf-test driver populates
> -vendorid with 0x and interrupt_pin with 0x0001
> +vendorid with 0x and interrupt_pin with 0x0001::
>
> # cat functions/pci_epf_test/func1/vendorid
> 0x
> # cat functions/pci_epf_test/func1/interrupt_pin
> 0x0001
>
> -1.4 Configuring pci-epf-test Device
> +
> +Configuring pci-epf-test Device
> +---
>
> The user can configure the pci-epf-test device using configfs entry. In order
> to change the vendorid and the number of MSI interrupts used by the function
> -device, the following commands can be used.
> +device, the following commands can be used::
>
> # echo 0x104c > functions/pci_epf_test/func1/vendorid
> # echo 0xb500 > functions/pci_epf_test/func1/deviceid
> # echo 16 > functions/pci_
Re: [PATCH v4 38/63] Documentation: x86: convert boot.txt to reST
Em Wed, 24 Apr 2019 00:29:07 +0800 Changbin Du escreveu: > This converts the plain text documentation to reStructuredText format and > add it to Sphinx TOC tree. No essential content change. > > Signed-off-by: Changbin Du > --- > Documentation/x86/boot.rst | 1205 +++ > Documentation/x86/boot.txt | 1130 > Documentation/x86/index.rst |2 + > 3 files changed, 1207 insertions(+), 1130 deletions(-) > create mode 100644 Documentation/x86/boot.rst > delete mode 100644 Documentation/x86/boot.txt > > diff --git a/Documentation/x86/boot.rst b/Documentation/x86/boot.rst > new file mode 100644 > index ..9f55e832bc47 > --- /dev/null > +++ b/Documentation/x86/boot.rst > @@ -0,0 +1,1205 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +=== > +The Linux/x86 Boot Protocol > +=== > + > +On the x86 platform, the Linux kernel uses a rather complicated boot > +convention. This has evolved partially due to historical aspects, as > +well as the desire in the early days to have the kernel itself be a > +bootable image, the complicated PC memory model and due to changed > +expectations in the PC industry caused by the effective demise of > +real-mode DOS as a mainstream operating system. > + > +Currently, the following versions of the Linux/x86 boot protocol exist. > + > +Old kernels: > + zImage/Image support only. Some very early kernels > + may not even support a command line. > + > +Protocol 2.00: > + (Kernel 1.3.73) Added bzImage and initrd support, as > + well as a formalized way to communicate between the > + boot loader and the kernel. setup.S made relocatable, > + although the traditional setup area still assumed writable. > + > +Protocol 2.01: > + (Kernel 1.3.76) Added a heap overrun warning. > + > +Protocol 2.02: > + (Kernel 2.4.0-test3-pre3) New command line protocol. > + Lower the conventional memory ceiling. No overwrite > + of the traditional setup area, thus making booting > + safe for systems which use the EBDA from SMM or 32-bit > + BIOS entry points. zImage deprecated but still supported. > + > +Protocol 2.03: > + (Kernel 2.4.18-pre1) Explicitly makes the highest possible > + initrd address available to the bootloader. > + > +Protocol 2.04: > + (Kernel 2.6.14) Extend the syssize field to four bytes. > + > +Protocol 2.05: > + (Kernel 2.6.20) Make protected mode kernel relocatable. > + Introduce relocatable_kernel and kernel_alignment fields. > + > +Protocol 2.06: > + (Kernel 2.6.22) Added a field that contains the size of > + the boot command line. > + > +Protocol 2.07: > + (Kernel 2.6.24) Added paravirtualised boot protocol. > + Introduced hardware_subarch and hardware_subarch_data > + and KEEP_SEGMENTS flag in load_flags. > + > +Protocol 2.08: > + (Kernel 2.6.26) Added crc32 checksum and ELF format > + payload. Introduced payload_offset and payload_length > + fields to aid in locating the payload. > + > +Protocol 2.09: > + (Kernel 2.6.26) Added a field of 64-bit physical > + pointer to single linked list of structsetup_data. > + > +Protocol 2.10: > + (Kernel 2.6.31) Added a protocol for relaxed alignment > + beyond the kernel_alignment added, new init_size and > + pref_address fields. Added extended boot loader IDs. > + > +Protocol 2.11: > + (Kernel 3.6) Added a field for offset of EFI handover > + protocol entry point. > + > +Protocol 2.12: > + (Kernel 3.8) Added the xloadflags field and extension fields > + to struct boot_params for loading bzImage and ramdisk > + above 4G in 64bit. This is a side node, but you should really try to avoid replacing too many lines, as it makes a lot harder for reviewers for no good reason. For example, this is the way I would convert this changelog table: @@ -10,6 +11,7 @@ real-mode DOS as a mainstream operating system. Currently, the following versions of the Linux/x86 boot protocol exist. +=== === Old kernels: zImage/Image support only. Some very early kernels may not even support a command line. @@ -64,33 +66,35 @@ Protocol 2.12: (Kernel 3.8) Added the xloadflags field and extension fields Protocol 2.13: (Kernel 3.14) Support 32- and 64-bit flags being set in xloadflags to support booting a 64-bit kernel from 32-bit EFI +=== === This is simple enough, preserves the original author's intent and makes a lot easier for reviewers to check what you changed. > + > +MEMORY LAYOUT > += > + > +The traditional memory map for the kernel loader, used for Image or > +zImage kernels, typically looks like:: > + > +| | > + 0A ++ > +| Reserved for BIOS | Do not use. Reserved for BIOS EBDA. > + 09A000
Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
Em Wed, 24 Apr 2019 23:46:18 +0800 Changbin Du escreveu: > On Tue, Apr 23, 2019 at 12:36:44PM -0500, Bjorn Helgaas wrote: > > On Tue, Apr 23, 2019 at 06:39:47PM +0200, Rafael J. Wysocki wrote: > > > On Tue, Apr 23, 2019 at 6:30 PM Changbin Du wrote: > > > > Hi Corbet and All, > > > > The kernel now uses Sphinx to generate intelligent and beautiful > > > > documentation from reStructuredText files. I converted all of the Linux > > > > ACPI/PCI/X86 docs to reST format in this serias. > > > > > > > > In this version I combined ACPI and PCI docs, and added new x86 docs > > > > conversion. > > > > > > I'm not sure if combining all three into one big patch series has been > > > a good idea, honestly. > > > > Yeah, if you post this again, I would find it easier to deal with if > > linux-pci only got the PCI-related things. 63 patches is a little too > > much for one series. > > > sure, so I will resend them respectively. I reviewed up to patch 39. There are too many files on x86 that seems to be mangled by some tab->whitespace conversion, with caused very big diffs and lots of broken ascii artwork. Please ensure that the diffs will contain the minimal amount of stuff that would be required for them to be properly formatted as ReST files there. Ah, perhaps next time you could format the patches with a lower merge similarity logic (using, for example, the parameter -M10). Regards, Mauro > > > Bjorn > Thanks, Mauro
Re: [PATCH v4 34/63] Documentation: PCI: convert endpoint/pci-endpoint-cfs.txt to reST
Em Wed, 24 Apr 2019 00:29:03 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
Reviewed-by: Mauro Carvalho Chehab
> ---
> Documentation/PCI/endpoint/index.rst | 1 +
> ...-endpoint-cfs.txt => pci-endpoint-cfs.rst} | 99 +++
> 2 files changed, 57 insertions(+), 43 deletions(-)
> rename Documentation/PCI/endpoint/{pci-endpoint-cfs.txt =>
> pci-endpoint-cfs.rst} (64%)
>
> diff --git a/Documentation/PCI/endpoint/index.rst
> b/Documentation/PCI/endpoint/index.rst
> index 0db4f2fcd7f0..3951de9f923c 100644
> --- a/Documentation/PCI/endpoint/index.rst
> +++ b/Documentation/PCI/endpoint/index.rst
> @@ -8,3 +8,4 @@ PCI Endpoint Framework
> :maxdepth: 2
>
> pci-endpoint
> + pci-endpoint-cfs
> diff --git a/Documentation/PCI/endpoint/pci-endpoint-cfs.txt
> b/Documentation/PCI/endpoint/pci-endpoint-cfs.rst
> similarity index 64%
> rename from Documentation/PCI/endpoint/pci-endpoint-cfs.txt
> rename to Documentation/PCI/endpoint/pci-endpoint-cfs.rst
> index d740f29960a4..b6d39cdec56e 100644
> --- a/Documentation/PCI/endpoint/pci-endpoint-cfs.txt
> +++ b/Documentation/PCI/endpoint/pci-endpoint-cfs.rst
> @@ -1,41 +1,51 @@
> - CONFIGURING PCI ENDPOINT USING CONFIGFS
> -Kishon Vijay Abraham I
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===
> +Configuring PCI Endpoint Using CONFIGFS
> +===
> +
> +:Author: Kishon Vijay Abraham I
>
> The PCI Endpoint Core exposes configfs entry (pci_ep) to configure the
> PCI endpoint function and to bind the endpoint function
> with the endpoint controller. (For introducing other mechanisms to
> configure the PCI Endpoint Function refer to [1]).
>
> -*) Mounting configfs
> +Mounting configfs
> +=
>
> The PCI Endpoint Core layer creates pci_ep directory in the mounted configfs
> -directory. configfs can be mounted using the following command.
> +directory. configfs can be mounted using the following command::
>
> mount -t configfs none /sys/kernel/config
>
> -*) Directory Structure
> +Directory Structure
> +===
>
> The pci_ep configfs has two directories at its root: controllers and
> functions. Every EPC device present in the system will have an entry in
> the *controllers* directory and and every EPF driver present in the system
> will have an entry in the *functions* directory.
> +::
>
> -/sys/kernel/config/pci_ep/
> - .. controllers/
> - .. functions/
> + /sys/kernel/config/pci_ep/
> + .. controllers/
> + .. functions/
>
> -*) Creating EPF Device
> +Creating EPF Device
> +===
>
> Every registered EPF driver will be listed in controllers directory. The
> entries corresponding to EPF driver will be created by the EPF core.
> +::
>
> -/sys/kernel/config/pci_ep/functions/
> - .. /
> - ... /
> - ... /
> - .. /
> - ... /
> - ... /
> + /sys/kernel/config/pci_ep/functions/
> + .. /
> + ... /
> + ... /
> + .. /
> + ... /
> + ... /
>
> In order to create a of the type probed by , the
> user has to create a directory inside .
> @@ -44,34 +54,37 @@ Every directory consists of the following
> entries that can be
> used to configure the standard configuration header of the endpoint function.
> (These entries are created by the framework when any new is
> created)
> -
> - .. /
> - ... /
> - ... vendorid
> - ... deviceid
> - ... revid
> - ... progif_code
> - ... subclass_code
> - ... baseclass_code
> - ... cache_line_size
> - ... subsys_vendor_id
> - ... subsys_id
> - ... interrupt_pin
> -
> -*) EPC Device
> +::
> +
> + .. /
> + ... /
> + ... vendorid
> + ... deviceid
> + ... revid
> + ... progif_code
> + ... subclass_code
> + ... baseclass_code
> + ...
Re: [PATCH v4 09/63] Documentation: ACPI: move method-customizing.txt to firmware-guide/acpi and convert to reST
Em Thu, 25 Apr 2019 00:28:52 +0800 Changbin Du escreveu: > On Tue, Apr 23, 2019 at 06:03:16PM -0300, Mauro Carvalho Chehab wrote: > > Em Wed, 24 Apr 2019 00:28:38 +0800 > > Changbin Du escreveu: > > > > > +.. note:: Only ACPI METHOD can be overridden, any other object types like > > > + "Device", "OperationRegion", are not recognized. Methods > > > + declared inside scope operators are also not supported. > > > +.. note:: The same ACPI control method can be overridden for many times, > > > + and it's always the latest one that used by Linux/kernel. > > > +.. note:: To get the ACPI debug object output (Store (, Debug)), > > > + please run "echo 1 > /sys/module/acpi/parameters/aml_debug_output". > > > > Hmm... this may work (not sure if Sphinx would warn or not), but it > > is visually bad on text mode. I would code it, instead, with something > > like: > > > > .. note:: > > > > - Only ACPI METHOD can be overridden, any other object types like > > "Device", "OperationRegion", are not recognized. Methods > > declared inside scope operators are also not supported. > > > > - The same ACPI control method can be overridden for many times, > > and it's always the latest one that used by Linux/kernel. > > > > - To get the ACPI debug object output (Store (, Debug)), > > please run:: > > > > echo 1 > /sys/module/acpi/parameters/aml_debug_output > > > > As this would make it visually better on both text and html formats. > > > No warnings given. Interesting. I'm now wondering if it did the right thing or if it produced some weird output... Maybe the answer depends on the Sphinx version one would be using. > Your suggested style is better so applied it. Thanks! Thank you! Thanks, Mauro
Re: [PATCH v4 00/63] Include linux ACPI/PCI/X86 docs into Sphinx TOC tree
Em Wed, 24 Apr 2019 10:18:46 -0600 Jonathan Corbet escreveu: > On Wed, 24 Apr 2019 00:28:29 +0800 > Changbin Du wrote: > > > The kernel now uses Sphinx to generate intelligent and beautiful > > documentation > > from reStructuredText files. I converted all of the Linux ACPI/PCI/X86 docs > > to > > reST format in this serias. > > > > In this version I combined ACPI and PCI docs, and added new x86 docs > > conversion. > > As mentioned by others, this is a lot of stuff; I would really rather see > each of those groups as separate patch sets. Yeah, makes sense to me, either to split into separate patchsets or to group the changes per sub-dir (or both). > If you can do a reasonably quick turnaround with Mauro's suggestions > addressed and tags applied, we should be able to get at least some of this > into 5.2. Thanks, Mauro, for looking at all of this stuff! Anytime! Just to make clear, I'm still reviewing it... I'm at patch 35/63 now. So, expect more comments from my side. Thanks, Mauro
Re: [PATCH v4 37/63] Documentation: add Linux x86 docs to Sphinx TOC tree
Em Wed, 24 Apr 2019 00:29:06 +0800 Changbin Du escreveu: > Add a index.rst for x86 support. More docs will be added later. > > Signed-off-by: Changbin Du > --- > Documentation/index.rst | 1 + > Documentation/x86/index.rst | 9 + > 2 files changed, 10 insertions(+) > create mode 100644 Documentation/x86/index.rst > > diff --git a/Documentation/index.rst b/Documentation/index.rst > index d80138284e0f..f185c8040fa9 100644 > --- a/Documentation/index.rst > +++ b/Documentation/index.rst > @@ -112,6 +112,7 @@ implementation. > .. toctree:: > :maxdepth: 2 > > + x86/index > sh/index > > Filesystem Documentation > diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst > new file mode 100644 > index ..7612d3142b2a > --- /dev/null > +++ b/Documentation/x86/index.rst > @@ -0,0 +1,9 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > += > +Linux x86 Support > +===== > + > +.. toctree:: > + :maxdepth: 2 > + :numbered: Looks ok to me: Reviewed-by: Mauro Carvalho Chehab Just one reminder: after merging both this and my conversions, we may need to do some review at the architecture titles, in order to make them consistent. On mu conversion patches, I'm using == $arch Architecture == Probably also not the best title. Anyway, this can easily be fixed with a follow up patch once we get everything merged. Thanks, Mauro
Re: [PATCH v4 35/63] Documentation: PCI: convert endpoint/pci-test-function.txt to reST
Em Wed, 24 Apr 2019 00:29:04 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> Acked-by: Bjorn Helgaas
> ---
> Documentation/PCI/endpoint/index.rst | 1 +
> ...est-function.txt => pci-test-function.rst} | 32 +++
> 2 files changed, 20 insertions(+), 13 deletions(-)
> rename Documentation/PCI/endpoint/{pci-test-function.txt =>
> pci-test-function.rst} (84%)
>
> diff --git a/Documentation/PCI/endpoint/index.rst
> b/Documentation/PCI/endpoint/index.rst
> index 3951de9f923c..b680a3fc4fec 100644
> --- a/Documentation/PCI/endpoint/index.rst
> +++ b/Documentation/PCI/endpoint/index.rst
> @@ -9,3 +9,4 @@ PCI Endpoint Framework
>
> pci-endpoint
> pci-endpoint-cfs
> + pci-test-function
> diff --git a/Documentation/PCI/endpoint/pci-test-function.txt
> b/Documentation/PCI/endpoint/pci-test-function.rst
> similarity index 84%
> rename from Documentation/PCI/endpoint/pci-test-function.txt
> rename to Documentation/PCI/endpoint/pci-test-function.rst
> index 5916f1f592bb..ba02cddcec37 100644
> --- a/Documentation/PCI/endpoint/pci-test-function.txt
> +++ b/Documentation/PCI/endpoint/pci-test-function.rst
> @@ -1,5 +1,10 @@
> - PCI TEST
> - Kishon Vijay Abraham I
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=
> +PCI Test Function
> +=
> +
> +:Author: Kishon Vijay Abraham I
>
> Traditionally PCI RC has always been validated by using standard
> PCI cards like ethernet PCI cards or USB PCI cards or SATA PCI cards.
> @@ -23,30 +28,31 @@ The PCI endpoint test device has the following registers:
> 8) PCI_ENDPOINT_TEST_IRQ_TYPE
> 9) PCI_ENDPOINT_TEST_IRQ_NUMBER
>
> -*) PCI_ENDPOINT_TEST_MAGIC
> +* PCI_ENDPOINT_TEST_MAGIC
Same comment as on a previous patch. I suspect that the author's intention
for all stuff under Documentation/PCI/endpoint/ (or perhaps this is due
tothe markup language he uses) is to have:
*) foo
as a chapter, e. g. the right conversion would be, instead:
PCI_ENDPOINT_TEST_MAGIC
===
(same applies to the other similar markups here and on other files under
the endpoint/ directory)
>
> This register will be used to test BAR0. A known pattern will be written
> and read back from MAGIC register to verify BAR0.
>
> -*) PCI_ENDPOINT_TEST_COMMAND:
> +* PCI_ENDPOINT_TEST_COMMAND:
>
> This register will be used by the host driver to indicate the function
> that the endpoint device must perform.
>
> -Bitfield Description:
> +Bitfield Description::
> +
>Bit 0 : raise legacy IRQ
>Bit 1 : raise MSI IRQ
>Bit 2 : raise MSI-X IRQ
>Bit 3 : read command (read data from RC buffer)
>Bit 4 : write command (write data to RC buffer)
> - Bit 5 : copy command (copy data from one RC buffer to another
> - RC buffer)
> + Bit 5 : copy command (copy data from one RC buffer to another
> RC buffer)
Please use a table instead:
Bitfield Description:
= ===
Bit 0 raise legacy IRQ
Bit 1 raise MSI IRQ
Bit 2 raise MSI-X IRQ
Bit 3 read command (read data from RC buffer)
Bit 4 write command (write data to RC buffer)
Bit 5 copy command (copy data from one RC buffer to another
RC buffer)
= ===
>
> -*) PCI_ENDPOINT_TEST_STATUS
> +* PCI_ENDPOINT_TEST_STATUS
>
> This register reflects the status of the PCI endpoint device.
>
> -Bitfield Description:
> +Bitfield Description::
> +
>Bit 0 : read success
>Bit 1 : read fail
>Bit 2 : write success
> @@ -57,17 +63,17 @@ Bitfield Description:
>Bit 7 : source address is invalid
>Bit 8 : destination address is invalid
Same here:
Bitfield Description:
= ==
Bit 0 read success
Bit 1 read fail
Bit 2 write success
Bit 3 write fail
Bit 4 copy success
Bit 5 copy fail
Bit 6 IRQ raised
Bit 7 source address is invalid
Bit 8 destination address is invalid
= ==
>
> -*) PCI_ENDPOINT_TEST_SRC_ADDR
> +* PCI_ENDPOINT_TEST_SRC_ADDR
>
> This register contains the source address (RC buffer address) for the
> COPY/READ command.
>
> -*) PCI_ENDPOINT_TEST_DST_ADDR
> +* PCI_ENDPOINT_TEST_DST_ADDR
>
> This register contains the destination address (RC buffer address) for
> the COPY/WRITE command.
>
> -*) PCI_ENDPOINT_TEST_IRQ_TYPE
> +* PCI_ENDPOINT_TEST_IRQ_TYPE
>
> This
Re: [PATCH v4 39/63] Documentation: x86: convert topology.txt to reST
Em Wed, 24 Apr 2019 00:29:08 +0800 Changbin Du escreveu: > This converts the plain text documentation to reStructuredText format and > add it to Sphinx TOC tree. No essential content change. > > Signed-off-by: Changbin Du > --- > Documentation/x86/index.rst| 1 + > Documentation/x86/topology.rst | 228 + > Documentation/x86/topology.txt | 217 --- > 3 files changed, 229 insertions(+), 217 deletions(-) > create mode 100644 Documentation/x86/topology.rst > delete mode 100644 Documentation/x86/topology.txt Why? Please preserve as much as possible from the original file... it is really hard to see what you're doing. Most of those x86 files are already almost at ReST format (like this one). There's absolutely **no reason** why you would do so much radical changes that would below the 50% similarity threshold that would make git to recognize as a change on the same file! I'll give a quick review on this one, but it is really hard to be sure that something is missing, when the similarity is too low. > > diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst > index 8f08caf4fbbb..2033791e53bc 100644 > --- a/Documentation/x86/index.rst > +++ b/Documentation/x86/index.rst > @@ -9,3 +9,4 @@ Linux x86 Support > :numbered: > > boot > + topology > diff --git a/Documentation/x86/topology.rst b/Documentation/x86/topology.rst > new file mode 100644 > index ..1df5f56f4882 > --- /dev/null > +++ b/Documentation/x86/topology.rst > @@ -0,0 +1,228 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > + > +x86 Topology > + > + > +This documents and clarifies the main aspects of x86 topology modelling and > +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 > +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. > + > +Needless to say, code should use the generic functions - this file is *only* > +here to *document* the inner workings of x86 topology. > + > +Started by Thomas Gleixner and Borislav Petkov > . > + > +The main aim of the topology facilities is to present adequate interfaces to > +code which needs to know/query/use the structure of the running system wrt > +threads, cores, packages, etc. > + > +The kernel does not care about the concept of physical sockets because a > +socket has no relevance to software. It's an electromechanical component. In > +the past a socket always contained a single package (see below), but with the > +advent of Multi Chip Modules (MCM) a socket can hold more than one package. > So > +there might be still references to sockets in the code, but they are of > +historical nature and should be cleaned up. > + > +The topology of a system is described in the units of: > + > +- packages > +- cores > +- threads > + > +Package > +=== > + > +Packages contain a number of cores plus shared resources, e.g. DRAM > +controller, shared caches etc. > + > +AMD nomenclature for package is 'Node'. > + > +Package-related topology information in the kernel: > + > + - cpuinfo_x86.x86_max_cores: > + > +The number of cores in a package. This information is retrieved via > CPUID. > + > + - cpuinfo_x86.phys_proc_id: > + > +The physical ID of the package. This information is retrieved via CPUID > +and deduced from the APIC IDs of the cores in the package. > + > + - cpuinfo_x86.logical_id: > + > +The logical ID of the package. As we do not trust BIOSes to enumerate the > +packages in a consistent way, we introduced the concept of logical > package > +ID so we can sanely calculate the number of maximum possible packages in > +the system and have the packages enumerated linearly. > + > + - topology_max_packages(): > + > +The maximum possible number of packages in the system. Helpful for per > +package facilities to preallocate per package information. > + > + - cpu_llc_id: > + > +A per-CPU variable containing: > + > +- On Intel, the first APIC ID of the list of CPUs sharing the Last Level > + Cache. > + > +- On AMD, the Node ID or Core Complex ID containing the Last Level > + Cache. In general, it is a number identifying an LLC uniquely on the > + system. > + > +Cores > += > + > +A core consists of 1 or more threads. It does not matter whether the threads > +are SMT- or CMT-type threads. > + > +AMDs nomenclature for a CMT core is "Compute Unit". The kernel always uses > +"core". > + > +Core-related topology information in the kernel: > + > + - smp_num_siblings: > + > +The number of threads in a core. The number of threads in a package can > be > +
Re: [PATCH v4 21/63] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi and convert to reST
Em Thu, 25 Apr 2019 01:22:34 +0800
Changbin Du escreveu:
> On Wed, Apr 24, 2019 at 11:48:44AM -0300, Mauro Carvalho Chehab wrote:
> > Em Wed, 24 Apr 2019 00:28:50 +0800
> > Changbin Du escreveu:
> >
> > > This converts the plain text documentation to reStructuredText format and
> > > add it to Sphinx TOC tree. No essential content change.
> > >
> > > Signed-off-by: Changbin Du
> > > ---
> > > .../acpi/cppc_sysfs.rst} | 71 ++-
> > > Documentation/admin-guide/acpi/index.rst | 1 +
> > > 2 files changed, 40 insertions(+), 32 deletions(-)
> > > rename Documentation/{acpi/cppc_sysfs.txt =>
> > > admin-guide/acpi/cppc_sysfs.rst} (51%)
> > >
> > > diff --git a/Documentation/acpi/cppc_sysfs.txt
> > > b/Documentation/admin-guide/acpi/cppc_sysfs.rst
> > > similarity index 51%
> > > rename from Documentation/acpi/cppc_sysfs.txt
> > > rename to Documentation/admin-guide/acpi/cppc_sysfs.rst
> > > index f20fb445135d..a4b99afbe331 100644
> > > --- a/Documentation/acpi/cppc_sysfs.txt
> > > +++ b/Documentation/admin-guide/acpi/cppc_sysfs.rst
> > > @@ -1,5 +1,11 @@
> > > +.. SPDX-License-Identifier: GPL-2.0
> > >
> > > - Collaborative Processor Performance Control (CPPC)
> > > +==
> > > +Collaborative Processor Performance Control (CPPC)
> > > +==
> > > +
> > > +CPPC
> > > +
> > >
> > > CPPC defined in the ACPI spec describes a mechanism for the OS to manage
> > > the
> > > performance of a logical processor on a contigious and abstract
> > > performance
> > > @@ -10,31 +16,28 @@ For more details on CPPC please refer to the ACPI
> > > specification at:
> > >
> > > http://uefi.org/specifications
> > >
> > > -Some of the CPPC registers are exposed via sysfs under:
> > > -
> > > -/sys/devices/system/cpu/cpuX/acpi_cppc/
> > > -
> >
> >
> > > -for each cpu X
> >
> > Hmm... removed by mistake?
> >
> I comfirmed that no content removed.
At this patch, it looks that you removed the line: "for each cpu X"
(or am I reading it wrong?)
>
> > > +Some of the CPPC registers are exposed via sysfs under::
> > >
> > > -
> > > + /sys/devices/system/cpu/cpuX/acpi_cppc/
> >
> > Did you parse this with Sphinx? It doesn't sound a valid ReST construction
> > to my eyes, as:
> >
> > 1) I've seen some versions of Sphinx to abort with severe errors when
> >there's no blank line after the horizontal bar markup;
> >
> > 2) It will very likely ignore the "::" (I didn't test it myself), as you're
> >not indenting the horizontal bar. End of indentation will mean the end
> >of an (empty) literal block.
> >
> > So, I would stick with:
> >
> >
> > Some of the CPPC registers are exposed via sysfs under:
> >
> > /sys/devices/system/cpu/cpuX/acpi_cppc/
> >
> >
> > -
> >
> > for each cpu X::
> >
> >
> > or:
> >
> > Some of the CPPC registers are exposed via sysfs under:
> >
> > /sys/devices/system/cpu/cpuX/acpi_cppc/
> >
> > for each cpu X
> >
> >
> >
> >
> > ::
> >
> > (with is closer to the original author's intent)
> >
> > Same applies to the other similar changes on this document.
> >
> I didn't seen any warning here and the generated html is good. So I think it
> is
> ok.
Basically, what you're doing is:
::
foo
literal-block bar
(where "foo" is the horizontal bar markup)
I would avoid such pattern for two reasons:
1) it sounds a violation of ReST syntax to format an in
indented paragraph some non-blank lines after a non-indented
line. As such, I won't doubt that different versions of Sphinx
would handle it differently. I'm even tempted to open a BZ
to Sphinx in order for them to provide a fix for that, if the
latest version of Sphinx accepts such crazy markup.
2) It is very confusing for any human reading it.
Thanks,
Mauro
Re: [PATCH v5 20/23] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi and convert to reST
Em Thu, 25 Apr 2019 01:53:03 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> .../acpi/cppc_sysfs.rst} | 71 ++-
> Documentation/admin-guide/acpi/index.rst | 1 +
> 2 files changed, 40 insertions(+), 32 deletions(-)
> rename Documentation/{acpi/cppc_sysfs.txt =>
> admin-guide/acpi/cppc_sysfs.rst} (51%)
>
> diff --git a/Documentation/acpi/cppc_sysfs.txt
> b/Documentation/admin-guide/acpi/cppc_sysfs.rst
> similarity index 51%
> rename from Documentation/acpi/cppc_sysfs.txt
> rename to Documentation/admin-guide/acpi/cppc_sysfs.rst
> index f20fb445135d..a4b99afbe331 100644
> --- a/Documentation/acpi/cppc_sysfs.txt
> +++ b/Documentation/admin-guide/acpi/cppc_sysfs.rst
> @@ -1,5 +1,11 @@
> +.. SPDX-License-Identifier: GPL-2.0
>
> - Collaborative Processor Performance Control (CPPC)
> +==
> +Collaborative Processor Performance Control (CPPC)
> +==
> +
> +CPPC
> +
>
> CPPC defined in the ACPI spec describes a mechanism for the OS to manage the
> performance of a logical processor on a contigious and abstract performance
> @@ -10,31 +16,28 @@ For more details on CPPC please refer to the ACPI
> specification at:
>
> http://uefi.org/specifications
>
> -Some of the CPPC registers are exposed via sysfs under:
> -
> -/sys/devices/system/cpu/cpuX/acpi_cppc/
> -
> -for each cpu X
Yeah, there it is: you're removing those two lines.
> +Some of the CPPC registers are exposed via sysfs under::
>
> -
> + /sys/devices/system/cpu/cpuX/acpi_cppc/
As per my reply to v4.
Thanks,
Mauro
Re: [PATCH v5 23/23] Documentation: ACPI: move video_extension.txt to firmware-guide/acpi and convert to reST
Em Thu, 25 Apr 2019 01:53:06 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> Documentation/firmware-guide/acpi/index.rst | 1 +
> .../acpi/video_extension.rst} | 83 +++
> 2 files changed, 50 insertions(+), 34 deletions(-)
> rename Documentation/{acpi/video_extension.txt =>
> firmware-guide/acpi/video_extension.rst} (70%)
>
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 0e60f4b7129a..ae609eec4679 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -23,3 +23,4 @@ ACPI Support
> i2c-muxes
> acpi-lid
> lpit
> + video_extension
> diff --git a/Documentation/acpi/video_extension.txt
> b/Documentation/firmware-guide/acpi/video_extension.rst
> similarity index 70%
> rename from Documentation/acpi/video_extension.txt
> rename to Documentation/firmware-guide/acpi/video_extension.rst
> index 79bf6a4921be..099b8607e07b 100644
> --- a/Documentation/acpi/video_extension.txt
> +++ b/Documentation/firmware-guide/acpi/video_extension.rst
> @@ -1,5 +1,8 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=
> ACPI video extensions
> -~
> +=
>
> This driver implement the ACPI Extensions For Display Adapters for
> integrated graphics devices on motherboard, as specified in ACPI 2.0
> @@ -8,9 +11,10 @@ defining the video POST device, retrieving EDID information
> or to
> setup a video output, etc. Note that this is an ref. implementation
> only. It may or may not work for your integrated video device.
>
> -The ACPI video driver does 3 things regarding backlight control:
> +The ACPI video driver does 3 things regarding backlight control.
Hmm... didn't notice this change before... The way it is, this
sentence sounds incomplete, specially since you removed the
numbering from the paragraphs. Perhaps you could, instead, be
explicit about what the video driver does, e. g.:
The ACPI video driver exports the backlight control via a
sysfs interface, notifies userspace with events and
changes the backlight level via ACPI firmware, as detailed
at the following chapters:
@ACPI maintainers:
Please check if the above properly summarizes the activity done
with regards to backlight control.
If you agree with that, feel free to add:
Reviewed-by: Mauro Carvalho Chehab
>
> -1 Export a sysfs interface for user space to control backlight level
> +Export a sysfs interface for user space to control backlight level
> +==
>
> If the ACPI table has a video device, and acpi_backlight=vendor kernel
> command line is not present, the driver will register a backlight device
> @@ -22,36 +26,41 @@ The backlight sysfs interface has a standard definition
> here:
> Documentation/ABI/stable/sysfs-class-backlight.
>
> And what ACPI video driver does is:
> -actual_brightness: on read, control method _BQC will be evaluated to
> -get the brightness level the firmware thinks it is at;
> -bl_power: not implemented, will set the current brightness instead;
> -brightness: on write, control method _BCM will run to set the requested
> -brightness level;
> -max_brightness: Derived from the _BCL package(see below);
> -type: firmware
> +
> +actual_brightness:
> + on read, control method _BQC will be evaluated to
> + get the brightness level the firmware thinks it is at;
> +bl_power:
> + not implemented, will set the current brightness instead;
> +brightness:
> + on write, control method _BCM will run to set the requested brightness
> level;
> +max_brightness:
> + Derived from the _BCL package(see below);
> +type:
> + firmware
>
> Note that ACPI video backlight driver will always use index for
> brightness, actual_brightness and max_brightness. So if we have
> -the following _BCL package:
> +the following _BCL package::
>
> -Method (_BCL, 0, NotSerialized)
> -{
> - Return (Package (0x0C)
> + Method (_BCL, 0, NotSerialized)
> {
> - 0x64,
> - 0x32,
> - 0x0A,
> - 0x14,
> - 0x1E,
> - 0x28,
> - 0x32,
> - 0x3C,
> - 0x46,
> - 0x50,
> - 0x5A,
> - 0x64
> - })
> -}
> + Return (Package (0x0C)
> + {
> + 0x64,
> +
Re: [PATCH v5 08/23] Documentation: ACPI: move method-customizing.txt to firmware-guide/acpi and convert to reST
Em Thu, 25 Apr 2019 01:52:51 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
Reviewed-by: Mauro Carvalho Chehab
> ---
> Documentation/acpi/method-customizing.txt | 73 ---
> Documentation/firmware-guide/acpi/index.rst | 3 +-
> .../acpi/method-customizing.rst | 89 +++
> 3 files changed, 91 insertions(+), 74 deletions(-)
> delete mode 100644 Documentation/acpi/method-customizing.txt
> create mode 100644 Documentation/firmware-guide/acpi/method-customizing.rst
>
> diff --git a/Documentation/acpi/method-customizing.txt
> b/Documentation/acpi/method-customizing.txt
> deleted file mode 100644
> index 7235da975f23..
> --- a/Documentation/acpi/method-customizing.txt
> +++ /dev/null
> @@ -1,73 +0,0 @@
> -Linux ACPI Custom Control Method How To
> -===
> -
> -Written by Zhang Rui
> -
> -
> -Linux supports customizing ACPI control methods at runtime.
> -
> -Users can use this to
> -1. override an existing method which may not work correctly,
> - or just for debugging purposes.
> -2. insert a completely new method in order to create a missing
> - method such as _OFF, _ON, _STA, _INI, etc.
> -For these cases, it is far simpler to dynamically install a single
> -control method rather than override the entire DSDT, because kernel
> -rebuild/reboot is not needed and test result can be got in minutes.
> -
> -Note: Only ACPI METHOD can be overridden, any other object types like
> - "Device", "OperationRegion", are not recognized. Methods
> - declared inside scope operators are also not supported.
> -Note: The same ACPI control method can be overridden for many times,
> - and it's always the latest one that used by Linux/kernel.
> -Note: To get the ACPI debug object output (Store (, Debug)),
> - please run "echo 1 > /sys/module/acpi/parameters/aml_debug_output".
> -
> -1. override an existing method
> - a) get the ACPI table via ACPI sysfs I/F. e.g. to get the DSDT,
> - just run "cat /sys/firmware/acpi/tables/DSDT > /tmp/dsdt.dat"
> - b) disassemble the table by running "iasl -d dsdt.dat".
> - c) rewrite the ASL code of the method and save it in a new file,
> - d) package the new file (psr.asl) to an ACPI table format.
> - Here is an example of a customized \_SB._AC._PSR method,
> -
> - DefinitionBlock ("", "SSDT", 1, "", "", 0x20080715)
> - {
> - Method (\_SB_.AC._PSR, 0, NotSerialized)
> - {
> - Store ("In AC _PSR", Debug)
> - Return (ACON)
> - }
> - }
> - Note that the full pathname of the method in ACPI namespace
> - should be used.
> - e) assemble the file to generate the AML code of the method.
> - e.g. "iasl -vw 6084 psr.asl" (psr.aml is generated as a result)
> - If parameter "-vw 6084" is not supported by your iASL compiler,
> - please try a newer version.
> - f) mount debugfs by "mount -t debugfs none /sys/kernel/debug"
> - g) override the old method via the debugfs by running
> - "cat /tmp/psr.aml > /sys/kernel/debug/acpi/custom_method"
> -
> -2. insert a new method
> - This is easier than overriding an existing method.
> - We just need to create the ASL code of the method we want to
> - insert and then follow the step c) ~ g) in section 1.
> -
> -3. undo your changes
> - The "undo" operation is not supported for a new inserted method
> - right now, i.e. we can not remove a method currently.
> - For an overridden method, in order to undo your changes, please
> - save a copy of the method original ASL code in step c) section 1,
> - and redo step c) ~ g) to override the method with the original one.
> -
> -
> -Note: We can use a kernel with multiple custom ACPI method running,
> - But each individual write to debugfs can implement a SINGLE
> - method override. i.e. if we want to insert/override multiple
> - ACPI methods, we need to redo step c) ~ g) for multiple times.
> -
> -Note: Be aware that root can mis-use this driver to modify arbitrary
> - memory and gain additional rights, if root's privileges got
> - restricted (for example if root is not allowed to load additional
> - modules after boot).
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 61d67763851b..d1d069b26bbc 100644
&g
Re: [PATCH v5 14/23] Documentation: ACPI: move dsd/data-node-references.txt to firmware-guide/acpi and convert to reST
Em Thu, 25 Apr 2019 01:52:57 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
Reviewed-by: Mauro Carvalho Chehab
> ---
> .../acpi/dsd/data-node-references.rst}| 36 ++-
> Documentation/firmware-guide/acpi/index.rst | 1 +
> 2 files changed, 21 insertions(+), 16 deletions(-)
> rename Documentation/{acpi/dsd/data-node-references.txt =>
> firmware-guide/acpi/dsd/data-node-references.rst} (71%)
>
> diff --git a/Documentation/acpi/dsd/data-node-references.txt
> b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> similarity index 71%
> rename from Documentation/acpi/dsd/data-node-references.txt
> rename to Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> index c3871565c8cf..1351984e767c 100644
> --- a/Documentation/acpi/dsd/data-node-references.txt
> +++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> @@ -1,9 +1,12 @@
> -Copyright (C) 2018 Intel Corporation
> -Author: Sakari Ailus
> -
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
>
> +===
> Referencing hierarchical data nodes
>
> +===
> +
> +:Copyright: |copy| 2018 Intel Corporation
> +:Author: Sakari Ailus
>
> ACPI in general allows referring to device objects in the tree only.
> Hierarchical data extension nodes may not be referred to directly, hence this
> @@ -28,13 +31,14 @@ extension key.
>
>
> Example
>
> +===
>
> - In the ASL snippet below, the "reference" _DSD property [2] contains a
> - device object reference to DEV0 and under that device object, a
> - hierarchical data extension key "node@1" referring to the NOD1 object
> - and lastly, a hierarchical data extension key "anothernode" referring to
> - the ANOD object which is also the final target node of the reference.
> +In the ASL snippet below, the "reference" _DSD property [2] contains a
> +device object reference to DEV0 and under that device object, a
> +hierarchical data extension key "node@1" referring to the NOD1 object
> +and lastly, a hierarchical data extension key "anothernode" referring to
> +the ANOD object which is also the final target node of the reference.
> +::
>
> Device (DEV0)
> {
> @@ -75,15 +79,15 @@ Example
> })
> }
>
> -Please also see a graph example in graph.txt .
> +Please also see a graph example in :doc:`graph`.
>
> References
> ---
> +==
>
> [1] Hierarchical Data Extension UUID For _DSD.
> -
> http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>,
> -referenced 2018-07-17.
> +<http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>,
> +referenced 2018-07-17.
>
> [2] Device Properties UUID For _DSD.
> -
> http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>,
> -referenced 2016-10-04.
> +<http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>,
> +referenced 2016-10-04.
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index f81cfbcb6878..6d4e0df4f063 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -9,6 +9,7 @@ ACPI Support
>
> namespace
> dsd/graph
> + dsd/data-node-references
> enumeration
> osi
> method-customizing
Thanks,
Mauro
[PATCH v2 11/21] docs: hwmon: ibmpowernv: convert to ReST format
Convert ibmpowernv to ReST format, in order to allow it to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab --- Documentation/hwmon/ibmpowernv | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Documentation/hwmon/ibmpowernv b/Documentation/hwmon/ibmpowernv index 56468258711f..3f1feae3901c 100644 --- a/Documentation/hwmon/ibmpowernv +++ b/Documentation/hwmon/ibmpowernv @@ -2,6 +2,7 @@ Kernel Driver IBMPOWERNV Supported systems: + * Any recent IBM P servers based on POWERNV platform Author: Neelesh Gupta @@ -29,6 +30,7 @@ CONFIG_SENSORS_IBMPOWERNV. It can also be built as module 'ibmpowernv'. Sysfs attributes +=== === fanX_input Measured RPM value. fanX_min Threshold RPM for alert generation. fanX_fault 0: No fail condition @@ -78,3 +80,4 @@ currX_enable Enable/disable all current sensors belonging to the 0: Disable energyX_input Cumulative energy (microJoule) +=== === -- 2.20.1
[PATCH v2 00/21] Convert hwmon documentation to ReST
This series converts the contents of Documentation/hwmon to ReST
format.
PS.: I opted to group the conversion files per groups of maintainer
set, as, if I were to generate one patch per file, it would give around
160 patches.
I also added those patches to my development tree at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=hwmon
If you want to see the results, they're at:
https://www.infradead.org/~mchehab/hwmon/
Version 2:
- Fixed broken SOB lines;
- changed submitting-patches.rst to mention that drivers should be
documented as Documentation/hwmon/.rst,
as suggested by Jonathan Neusch�fer.
Mauro Carvalho Chehab (21):
docs: hwmon: k10temp: convert to ReST format
docs: hwmon: vexpress: convert to ReST format
docs: hwmon: menf21bmc: convert to ReST format
docs: hwmon: sch5627: convert to ReST format
docs: hwmon: emc2103: convert to ReST format
docs: hwmon: pc87360: convert to ReST format
docs: hwmon: fam15h_power: convert to ReST format
docs: hwmon: w83791d: convert to ReST format
docs: hwmon: coretemp: convert to ReST format
docs: hwmon: aspeed-pwm-tacho: convert to ReST format
docs: hwmon: ibmpowernv: convert to ReST format
docs: hwmon: asc7621: convert to ReST format
docs: hwmon: ads1015: convert to ReST format
docs: hwmon: dme1737, vt1211: convert to ReST format
docs: hwmon: wm831x, wm8350: convert to ReST format
docs: hwmon: da9052, da9055: convert to ReST format
docs: hwmon: k8temp, w83793: convert to ReST format
docs: hwmon: pmbus files: convert to ReST format
docs: hwmon: misc files: convert to ReST format
docs: hwmon: convert remaining files to ReST format
docs: hwmon: Add an index file and rename docs to *.rst
.../devicetree/bindings/hwmon/g762.txt| 2 +-
Documentation/hwmon/{ab8500 => ab8500.rst}| 10 +-
Documentation/hwmon/abituguru | 92 ---
...guru-datasheet => abituguru-datasheet.rst} | 160 ++--
Documentation/hwmon/abituguru.rst | 113 +++
.../hwmon/{abituguru3 => abituguru3.rst} | 36 +-
Documentation/hwmon/{abx500 => abx500.rst}| 8 +-
...{acpi_power_meter => acpi_power_meter.rst} | 25 +-
Documentation/hwmon/{ad7314 => ad7314.rst}| 9 +
.../hwmon/{adc128d818 => adc128d818.rst} | 7 +-
Documentation/hwmon/{adm1021 => adm1021.rst} | 44 +-
Documentation/hwmon/{adm1025 => adm1025.rst} | 13 +-
Documentation/hwmon/{adm1026 => adm1026.rst} | 24 +-
Documentation/hwmon/{adm1031 => adm1031.rst} | 16 +-
Documentation/hwmon/{adm1275 => adm1275.rst} | 30 +-
Documentation/hwmon/{adm9240 => adm9240.rst} | 50 +-
Documentation/hwmon/{ads1015 => ads1015.rst} | 72 +-
Documentation/hwmon/{ads7828 => ads7828.rst} | 29 +-
Documentation/hwmon/{adt7410 => adt7410.rst} | 49 +-
Documentation/hwmon/{adt7411 => adt7411.rst} | 20 +-
Documentation/hwmon/{adt7462 => adt7462.rst} | 10 +-
Documentation/hwmon/{adt7470 => adt7470.rst} | 8 +-
Documentation/hwmon/{adt7475 => adt7475.rst} | 38 +-
Documentation/hwmon/{amc6821 => amc6821.rst} | 19 +-
Documentation/hwmon/{asb100 => asb100.rst}| 50 +-
Documentation/hwmon/{asc7621 => asc7621.rst} | 146 ++--
...{aspeed-pwm-tacho => aspeed-pwm-tacho.rst} | 2 +
.../hwmon/{coretemp => coretemp.rst} | 46 +-
Documentation/hwmon/{da9052 => da9052.rst}| 40 +-
Documentation/hwmon/{da9055 => da9055.rst}| 20 +-
Documentation/hwmon/{dme1737 => dme1737.rst} | 88 ++-
Documentation/hwmon/{ds1621 => ds1621.rst}| 154 ++--
Documentation/hwmon/{ds620 => ds620.rst} | 12 +-
Documentation/hwmon/{emc1403 => emc1403.rst} | 33 +-
Documentation/hwmon/{emc2103 => emc2103.rst} | 6 +-
.../hwmon/{emc6w201 => emc6w201.rst} | 5 +
Documentation/hwmon/{f71805f => f71805f.rst} | 36 +-
.../hwmon/{f71882fg => f71882fg.rst} | 56 +-
.../hwmon/{fam15h_power => fam15h_power.rst} | 85 ++-
.../hwmon/{ftsteutates => ftsteutates.rst}| 14 +-
Documentation/hwmon/{g760a => g760a.rst} | 4 +
Documentation/hwmon/{g762 => g762.rst}| 67 +-
Documentation/hwmon/{gl518sm => gl518sm.rst} | 21 +-
Documentation/hwmon/{hih6130 => hih6130.rst} | 14 +-
...on-kernel-api.txt => hwmon-kernel-api.rst} | 298
.../hwmon/{ibm-cffps => ibm-cffps.rst}| 3 +
Documentation/hwmon/{ibmaem => ibmaem.rst}| 10 +-
.../hwmon/{ibmpowernv => ibmpowernv.rst} | 3 +
Documentation/hwmon/{ina209 => ina209.rst}| 18 +-
Documentation/hwmon/{ina2xx => ina2xx.rst}| 41 +-
Documentation/hwmon/{ina3221 => ina3221.rst} | 17 +-
Documentation/hwmon/index.rst | 179 +
Documentation/hwmon/{ir35221 => ir35221.rst} | 12 +-
Documentation/hwmon/{it87 => it87.rst}| 102 ++-
Documentation/hwmon/{jc42 => jc42.rst}| 55 +-
Documentat
[PATCH v2 21/21] docs: hwmon: Add an index file and rename docs to *.rst
Now that all files were converted to ReST format, rename them
and add an index.
Signed-off-by: Mauro Carvalho Chehab
---
.../devicetree/bindings/hwmon/g762.txt| 2 +-
Documentation/hwmon/{ab8500 => ab8500.rst}| 2 +-
...guru-datasheet => abituguru-datasheet.rst} | 0
.../hwmon/{abituguru => abituguru.rst}| 0
.../hwmon/{abituguru3 => abituguru3.rst} | 0
Documentation/hwmon/{abx500 => abx500.rst}| 0
...{acpi_power_meter => acpi_power_meter.rst} | 2 +-
Documentation/hwmon/{ad7314 => ad7314.rst}| 0
.../hwmon/{adc128d818 => adc128d818.rst} | 0
Documentation/hwmon/{adm1021 => adm1021.rst} | 0
Documentation/hwmon/{adm1025 => adm1025.rst} | 0
Documentation/hwmon/{adm1026 => adm1026.rst} | 0
Documentation/hwmon/{adm1031 => adm1031.rst} | 0
Documentation/hwmon/{adm1275 => adm1275.rst} | 4 +-
Documentation/hwmon/{adm9240 => adm9240.rst} | 0
Documentation/hwmon/{ads1015 => ads1015.rst} | 0
Documentation/hwmon/{ads7828 => ads7828.rst} | 0
Documentation/hwmon/{adt7410 => adt7410.rst} | 0
Documentation/hwmon/{adt7411 => adt7411.rst} | 0
Documentation/hwmon/{adt7462 => adt7462.rst} | 0
Documentation/hwmon/{adt7470 => adt7470.rst} | 0
Documentation/hwmon/{adt7475 => adt7475.rst} | 0
Documentation/hwmon/{amc6821 => amc6821.rst} | 0
Documentation/hwmon/{asb100 => asb100.rst}| 0
Documentation/hwmon/{asc7621 => asc7621.rst} | 0
...{aspeed-pwm-tacho => aspeed-pwm-tacho.rst} | 0
.../hwmon/{coretemp => coretemp.rst} | 0
Documentation/hwmon/{da9052 => da9052.rst}| 0
Documentation/hwmon/{da9055 => da9055.rst}| 0
Documentation/hwmon/{dme1737 => dme1737.rst} | 0
Documentation/hwmon/{ds1621 => ds1621.rst}| 0
Documentation/hwmon/{ds620 => ds620.rst} | 0
Documentation/hwmon/{emc1403 => emc1403.rst} | 0
Documentation/hwmon/{emc2103 => emc2103.rst} | 0
.../hwmon/{emc6w201 => emc6w201.rst} | 0
Documentation/hwmon/{f71805f => f71805f.rst} | 0
.../hwmon/{f71882fg => f71882fg.rst} | 0
.../hwmon/{fam15h_power => fam15h_power.rst} | 0
.../hwmon/{ftsteutates => ftsteutates.rst}| 0
Documentation/hwmon/{g760a => g760a.rst} | 0
Documentation/hwmon/{g762 => g762.rst}| 2 +-
Documentation/hwmon/{gl518sm => gl518sm.rst} | 0
Documentation/hwmon/{hih6130 => hih6130.rst} | 0
...on-kernel-api.txt => hwmon-kernel-api.rst} | 4 +-
.../hwmon/{ibm-cffps => ibm-cffps.rst}| 0
Documentation/hwmon/{ibmaem => ibmaem.rst}| 0
.../hwmon/{ibmpowernv => ibmpowernv.rst} | 0
Documentation/hwmon/{ina209 => ina209.rst}| 0
Documentation/hwmon/{ina2xx => ina2xx.rst}| 2 +-
Documentation/hwmon/{ina3221 => ina3221.rst} | 0
Documentation/hwmon/index.rst | 179 ++
Documentation/hwmon/{ir35221 => ir35221.rst} | 0
Documentation/hwmon/{it87 => it87.rst}| 0
Documentation/hwmon/{jc42 => jc42.rst}| 0
Documentation/hwmon/{k10temp => k10temp.rst} | 0
Documentation/hwmon/{k8temp => k8temp.rst}| 0
.../hwmon/{lineage-pem => lineage-pem.rst}| 0
Documentation/hwmon/{lm25066 => lm25066.rst} | 2 +-
Documentation/hwmon/{lm63 => lm63.rst}| 0
Documentation/hwmon/{lm70 => lm70.rst}| 0
Documentation/hwmon/{lm73 => lm73.rst}| 0
Documentation/hwmon/{lm75 => lm75.rst}| 0
Documentation/hwmon/{lm77 => lm77.rst}| 0
Documentation/hwmon/{lm78 => lm78.rst}| 0
Documentation/hwmon/{lm80 => lm80.rst}| 0
Documentation/hwmon/{lm83 => lm83.rst}| 0
Documentation/hwmon/{lm85 => lm85.rst}| 0
Documentation/hwmon/{lm87 => lm87.rst}| 0
Documentation/hwmon/{lm90 => lm90.rst}| 0
Documentation/hwmon/{lm92 => lm92.rst}| 0
Documentation/hwmon/{lm93 => lm93.rst}| 0
Documentation/hwmon/{lm95234 => lm95234.rst} | 0
Documentation/hwmon/{lm95245 => lm95245.rst} | 0
Documentation/hwmon/{ltc2945 => ltc2945.rst} | 0
Documentation/hwmon/{ltc2978 => ltc2978.rst} | 0
Documentation/hwmon/{ltc2990 => ltc2990.rst} | 0
Documentation/hwmon/{ltc3815 => ltc3815.rst} | 0
Documentation/hwmon/{ltc4151 => ltc4151.rst} | 0
Documentation/hwmon/{ltc4215 => ltc4215.rst} | 0
Documentation/hwmon/{ltc4245 => ltc4245.rst} | 0
Documentation/hwmon/{ltc4260 => ltc4260.rst} | 0
Documentation/hwmon/{ltc4261 => ltc4261.rst} | 0
.../hwmon/{max16064 => max16064.rst} | 2 +-
.../hwmon/{max16065 => max16065.rst} | 0
Documentation/hwmon/{max1619 => max1619.rst} | 0
Documentation/hwmon/{max1668 => max1668.rst} | 0
Documentation/
Re: [PATCH v3 21/21] docs: hwmon: Add an index file and rename docs to *.rst
Em Wed, 17 Apr 2019 09:47:41 -0700
Guenter Roeck escreveu:
> On Wed, Apr 17, 2019 at 06:46:29AM -0300, Mauro Carvalho Chehab wrote:
> > Now that all files were converted to ReST format, rename them
> > and add an index.
> >
> > Signed-off-by: Mauro Carvalho Chehab
> > Acked-by: Liviu Dudau
>
> I applied all patches except this one, which fails due to a conflict in
> ab8500. I also notice that this file has not been touched by your series,
> which is odd. At the same time, patch 20/21 is missing from your series,
> and has been missing all along. Does the missing patch possibly touch
> Documentation/hwmon/ab8500 ?
Patch 20/21 is the biggest one. Maybe vger rejected it either due to
its size or due to the number of c/c.
Just bounced it to you. Please let me know if you didn't receive it
yet.
Regards,
Mauro
>
> Thanks,
> Guenter
>
> > ---
> > .../devicetree/bindings/hwmon/g762.txt| 2 +-
> > Documentation/hwmon/{ab8500 => ab8500.rst}| 2 +-
> > ...guru-datasheet => abituguru-datasheet.rst} | 0
> > .../hwmon/{abituguru => abituguru.rst}| 0
> > .../hwmon/{abituguru3 => abituguru3.rst} | 0
> > Documentation/hwmon/{abx500 => abx500.rst}| 0
> > ...{acpi_power_meter => acpi_power_meter.rst} | 2 +-
> > Documentation/hwmon/{ad7314 => ad7314.rst}| 0
> > .../hwmon/{adc128d818 => adc128d818.rst} | 0
> > Documentation/hwmon/{adm1021 => adm1021.rst} | 0
> > Documentation/hwmon/{adm1025 => adm1025.rst} | 0
> > Documentation/hwmon/{adm1026 => adm1026.rst} | 0
> > Documentation/hwmon/{adm1031 => adm1031.rst} | 0
> > Documentation/hwmon/{adm1275 => adm1275.rst} | 4 +-
> > Documentation/hwmon/{adm9240 => adm9240.rst} | 0
> > Documentation/hwmon/{ads1015 => ads1015.rst} | 0
> > Documentation/hwmon/{ads7828 => ads7828.rst} | 0
> > Documentation/hwmon/{adt7410 => adt7410.rst} | 0
> > Documentation/hwmon/{adt7411 => adt7411.rst} | 0
> > Documentation/hwmon/{adt7462 => adt7462.rst} | 1 -
> > Documentation/hwmon/{adt7470 => adt7470.rst} | 0
> > Documentation/hwmon/{adt7475 => adt7475.rst} | 0
> > Documentation/hwmon/{amc6821 => amc6821.rst} | 1 -
> > Documentation/hwmon/{asb100 => asb100.rst}| 1 -
> > Documentation/hwmon/{asc7621 => asc7621.rst} | 0
> > ...{aspeed-pwm-tacho => aspeed-pwm-tacho.rst} | 0
> > .../hwmon/{coretemp => coretemp.rst} | 0
> > Documentation/hwmon/{da9052 => da9052.rst}| 0
> > Documentation/hwmon/{da9055 => da9055.rst}| 0
> > Documentation/hwmon/{dme1737 => dme1737.rst} | 0
> > Documentation/hwmon/{ds1621 => ds1621.rst}| 0
> > Documentation/hwmon/{ds620 => ds620.rst} | 0
> > Documentation/hwmon/{emc1403 => emc1403.rst} | 0
> > Documentation/hwmon/{emc2103 => emc2103.rst} | 0
> > .../hwmon/{emc6w201 => emc6w201.rst} | 0
> > Documentation/hwmon/{f71805f => f71805f.rst} | 0
> > .../hwmon/{f71882fg => f71882fg.rst} | 0
> > .../hwmon/{fam15h_power => fam15h_power.rst} | 0
> > .../hwmon/{ftsteutates => ftsteutates.rst}| 0
> > Documentation/hwmon/{g760a => g760a.rst} | 0
> > Documentation/hwmon/{g762 => g762.rst}| 2 +-
> > Documentation/hwmon/{gl518sm => gl518sm.rst} | 0
> > Documentation/hwmon/{hih6130 => hih6130.rst} | 0
> > ...on-kernel-api.txt => hwmon-kernel-api.rst} | 4 +-
> > .../hwmon/{ibm-cffps => ibm-cffps.rst}| 0
> > Documentation/hwmon/{ibmaem => ibmaem.rst}| 0
> > .../hwmon/{ibmpowernv => ibmpowernv.rst} | 0
> > Documentation/hwmon/{ina209 => ina209.rst}| 0
> > Documentation/hwmon/{ina2xx => ina2xx.rst}| 2 +-
> > Documentation/hwmon/{ina3221 => ina3221.rst} | 0
> > Documentation/hwmon/index.rst | 179 ++
> > Documentation/hwmon/{ir35221 => ir35221.rst} | 0
> > Documentation/hwmon/{it87 => it87.rst}| 0
> > Documentation/hwmon/{jc42 => jc42.rst}| 0
> > Documentation/hwmon/{k10temp => k10temp.rst} | 0
> > Documentation/hwmon/{k8temp => k8temp.rst}| 0
> > .../hwmon/{lineage-pem => lineage-pem.rst}| 0
> > Documentation/hwmon/{lm25066 => lm25066.rst} | 2 +-
> > Documentation/hwmon/{lm63 => lm63.rst}| 0
> > Documentation/hwmon/{lm70 => lm70.rst}| 0
> > Documentation/hwmon/{lm73 => lm73.rst}
Re: [PATCH v3 21/21] docs: hwmon: Add an index file and rename docs to *.rst
Em Wed, 17 Apr 2019 14:13:52 -0300
Mauro Carvalho Chehab escreveu:
> Em Wed, 17 Apr 2019 09:47:41 -0700
> Guenter Roeck escreveu:
>
> > On Wed, Apr 17, 2019 at 06:46:29AM -0300, Mauro Carvalho Chehab wrote:
> > > Now that all files were converted to ReST format, rename them
> > > and add an index.
> > >
> > > Signed-off-by: Mauro Carvalho Chehab
> > > Acked-by: Liviu Dudau
> >
> > I applied all patches except this one, which fails due to a conflict in
> > ab8500. I also notice that this file has not been touched by your series,
> > which is odd. At the same time, patch 20/21 is missing from your series,
> > and has been missing all along. Does the missing patch possibly touch
> > Documentation/hwmon/ab8500 ?
>
> Patch 20/21 is the biggest one. Maybe vger rejected it either due to
> its size or due to the number of c/c.
>
> Just bounced it to you. Please let me know if you didn't receive it
> yet.
Btw, LKML got it:
https://lore.kernel.org/lkml/2a52363a5aaeea10e186ead8570503ea648e.1555494108.git.mchehab+sams...@kernel.org/
>
> Regards,
> Mauro
>
> >
> > Thanks,
> > Guenter
> >
> > > ---
> > > .../devicetree/bindings/hwmon/g762.txt| 2 +-
> > > Documentation/hwmon/{ab8500 => ab8500.rst}| 2 +-
> > > ...guru-datasheet => abituguru-datasheet.rst} | 0
> > > .../hwmon/{abituguru => abituguru.rst}| 0
> > > .../hwmon/{abituguru3 => abituguru3.rst} | 0
> > > Documentation/hwmon/{abx500 => abx500.rst}| 0
> > > ...{acpi_power_meter => acpi_power_meter.rst} | 2 +-
> > > Documentation/hwmon/{ad7314 => ad7314.rst}| 0
> > > .../hwmon/{adc128d818 => adc128d818.rst} | 0
> > > Documentation/hwmon/{adm1021 => adm1021.rst} | 0
> > > Documentation/hwmon/{adm1025 => adm1025.rst} | 0
> > > Documentation/hwmon/{adm1026 => adm1026.rst} | 0
> > > Documentation/hwmon/{adm1031 => adm1031.rst} | 0
> > > Documentation/hwmon/{adm1275 => adm1275.rst} | 4 +-
> > > Documentation/hwmon/{adm9240 => adm9240.rst} | 0
> > > Documentation/hwmon/{ads1015 => ads1015.rst} | 0
> > > Documentation/hwmon/{ads7828 => ads7828.rst} | 0
> > > Documentation/hwmon/{adt7410 => adt7410.rst} | 0
> > > Documentation/hwmon/{adt7411 => adt7411.rst} | 0
> > > Documentation/hwmon/{adt7462 => adt7462.rst} | 1 -
> > > Documentation/hwmon/{adt7470 => adt7470.rst} | 0
> > > Documentation/hwmon/{adt7475 => adt7475.rst} | 0
> > > Documentation/hwmon/{amc6821 => amc6821.rst} | 1 -
> > > Documentation/hwmon/{asb100 => asb100.rst}| 1 -
> > > Documentation/hwmon/{asc7621 => asc7621.rst} | 0
> > > ...{aspeed-pwm-tacho => aspeed-pwm-tacho.rst} | 0
> > > .../hwmon/{coretemp => coretemp.rst} | 0
> > > Documentation/hwmon/{da9052 => da9052.rst}| 0
> > > Documentation/hwmon/{da9055 => da9055.rst}| 0
> > > Documentation/hwmon/{dme1737 => dme1737.rst} | 0
> > > Documentation/hwmon/{ds1621 => ds1621.rst}| 0
> > > Documentation/hwmon/{ds620 => ds620.rst} | 0
> > > Documentation/hwmon/{emc1403 => emc1403.rst} | 0
> > > Documentation/hwmon/{emc2103 => emc2103.rst} | 0
> > > .../hwmon/{emc6w201 => emc6w201.rst} | 0
> > > Documentation/hwmon/{f71805f => f71805f.rst} | 0
> > > .../hwmon/{f71882fg => f71882fg.rst} | 0
> > > .../hwmon/{fam15h_power => fam15h_power.rst} | 0
> > > .../hwmon/{ftsteutates => ftsteutates.rst}| 0
> > > Documentation/hwmon/{g760a => g760a.rst} | 0
> > > Documentation/hwmon/{g762 => g762.rst}| 2 +-
> > > Documentation/hwmon/{gl518sm => gl518sm.rst} | 0
> > > Documentation/hwmon/{hih6130 => hih6130.rst} | 0
> > > ...on-kernel-api.txt => hwmon-kernel-api.rst} | 4 +-
> > > .../hwmon/{ibm-cffps => ibm-cffps.rst}| 0
> > > Documentation/hwmon/{ibmaem => ibmaem.rst}| 0
> > > .../hwmon/{ibmpowernv => ibmpowernv.rst} | 0
> > > Documentation/hwmon/{ina209 => ina209.rst}| 0
> > > Documentation/hwmon/{ina2xx => ina2xx.rst}| 2 +-
> > > Documentation/hwmon/{ina3221 => ina3221.rst} | 0
> > > Documentation/hwmon/index.rst | 179 ++
> > > Documentation/hwmon/{ir35221
Re: [PATCH v4 01/63] Documentation: add Linux ACPI to Sphinx TOC tree
Em Wed, 24 Apr 2019 00:28:30 +0800 Changbin Du escreveu: > Add below index.rst files for ACPI subsystem. More docs will be added later. > o admin-guide/acpi/index.rst > o driver-api/acpi/index.rst > o firmware-guide/index.rst Nice! you split it by usage. Reviewed-by: Mauro Carvalho Chehab > > Signed-off-by: Changbin Du > --- > Documentation/admin-guide/acpi/index.rst| 10 ++ > Documentation/admin-guide/index.rst | 1 + > Documentation/driver-api/acpi/index.rst | 7 +++ > Documentation/driver-api/index.rst | 1 + > Documentation/firmware-guide/acpi/index.rst | 9 + > Documentation/firmware-guide/index.rst | 13 + > Documentation/index.rst | 10 ++ > 7 files changed, 51 insertions(+) > create mode 100644 Documentation/admin-guide/acpi/index.rst > create mode 100644 Documentation/driver-api/acpi/index.rst > create mode 100644 Documentation/firmware-guide/acpi/index.rst > create mode 100644 Documentation/firmware-guide/index.rst > > diff --git a/Documentation/admin-guide/acpi/index.rst > b/Documentation/admin-guide/acpi/index.rst > new file mode 100644 > index ..3e041206089d > --- /dev/null > +++ b/Documentation/admin-guide/acpi/index.rst > @@ -0,0 +1,10 @@ > + > +ACPI Support > + > + > +Here we document in detail how to interact with various mechanisms in > +the Linux ACPI support. > + > +.. toctree:: > + :maxdepth: 1 > + > diff --git a/Documentation/admin-guide/index.rst > b/Documentation/admin-guide/index.rst > index 0a491676685e..5b8286fdd91b 100644 > --- a/Documentation/admin-guide/index.rst > +++ b/Documentation/admin-guide/index.rst > @@ -77,6 +77,7 @@ configure specific aspects of kernel behavior to your > liking. > LSM/index > mm/index > perf-security > + acpi/index > > .. only:: subproject and html > > diff --git a/Documentation/driver-api/acpi/index.rst > b/Documentation/driver-api/acpi/index.rst > new file mode 100644 > index ..898b0c60671a > --- /dev/null > +++ b/Documentation/driver-api/acpi/index.rst > @@ -0,0 +1,7 @@ > + > +ACPI Support > + > + > +.. toctree:: > + :maxdepth: 2 > + > diff --git a/Documentation/driver-api/index.rst > b/Documentation/driver-api/index.rst > index c0b600ed9961..aa87075c7846 100644 > --- a/Documentation/driver-api/index.rst > +++ b/Documentation/driver-api/index.rst > @@ -56,6 +56,7 @@ available subsections can be seen below. > slimbus > soundwire/index > fpga/index > + acpi/index > > .. only:: subproject and html > > diff --git a/Documentation/firmware-guide/acpi/index.rst > b/Documentation/firmware-guide/acpi/index.rst > new file mode 100644 > index ..0ec7d072ba22 > --- /dev/null > +++ b/Documentation/firmware-guide/acpi/index.rst > @@ -0,0 +1,9 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > + > +ACPI Support > + > + > +.. toctree:: > + :maxdepth: 1 > + > diff --git a/Documentation/firmware-guide/index.rst > b/Documentation/firmware-guide/index.rst > new file mode 100644 > index ..5355784ca0a2 > --- /dev/null > +++ b/Documentation/firmware-guide/index.rst > @@ -0,0 +1,13 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +=== > +The Linux kernel firmware guide > +=== > + > +This section describes the ACPI subsystem in Linux from firmware perspective. > + > +.. toctree:: > + :maxdepth: 1 > + > + acpi/index > + > diff --git a/Documentation/index.rst b/Documentation/index.rst > index 80a421cb935e..fdfa85c56a50 100644 > --- a/Documentation/index.rst > +++ b/Documentation/index.rst > @@ -35,6 +35,16 @@ trying to get it to work optimally on a given system. > > admin-guide/index > > +Firmware-related documentation > +-- > +The following holds information on the kernel's expectations regarding the > +platform firmwares. > + > +.. toctree:: > + :maxdepth: 2 > + > + firmware-guide/index > + > Application-developer documentation > --- > Thanks, Mauro
Re: [PATCH v4 05/63] Documentation: ACPI: move linuxized-acpica.txt to driver-api/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:34 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> Documentation/driver-api/acpi/index.rst | 1 +
> .../acpi/linuxized-acpica.rst}| 115 ++
> 2 files changed, 66 insertions(+), 50 deletions(-)
> rename Documentation/{acpi/linuxized-acpica.txt =>
> driver-api/acpi/linuxized-acpica.rst} (78%)
>
> diff --git a/Documentation/driver-api/acpi/index.rst
> b/Documentation/driver-api/acpi/index.rst
> index 898b0c60671a..12649947b19b 100644
> --- a/Documentation/driver-api/acpi/index.rst
> +++ b/Documentation/driver-api/acpi/index.rst
> @@ -5,3 +5,4 @@ ACPI Support
> .. toctree::
> :maxdepth: 2
>
> + linuxized-acpica
> diff --git a/Documentation/acpi/linuxized-acpica.txt
> b/Documentation/driver-api/acpi/linuxized-acpica.rst
> similarity index 78%
> rename from Documentation/acpi/linuxized-acpica.txt
> rename to Documentation/driver-api/acpi/linuxized-acpica.rst
> index 3ad7b0dfb083..f8aaea668e41 100644
> --- a/Documentation/acpi/linuxized-acpica.txt
> +++ b/Documentation/driver-api/acpi/linuxized-acpica.rst
> @@ -1,31 +1,35 @@
> -Linuxized ACPICA - Introduction to ACPICA Release Automation
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
>
> -Copyright (C) 2013-2016, Intel Corporation
> -Author: Lv Zheng
> +
> +Linuxized ACPICA - Introduction to ACPICA Release Automation
> +
>
> +:Copyright: |copy| 2013-2016, Intel Corporation
>
> -Abstract:
> +:Author: Lv Zheng
>
> -This document describes the ACPICA project and the relationship between
> -ACPICA and Linux. It also describes how ACPICA code in drivers/acpi/acpica,
> -include/acpi and tools/power/acpi is automatically updated to follow the
> -upstream.
> +:Abstract: This document describes the ACPICA project and the relationship
> + between ACPICA and Linux. It also describes how ACPICA code in
> + drivers/acpi/acpica, include/acpi and tools/power/acpi is
> + automatically updated to follow the upstream.
>
Same comment as on patch 02: I would keep the abstracts as a chapter,
in order to make them visible at the index, as this may help readers
to quickly look at the document's contents.
I'm sure other APCI documents also have abstracts. So, please consider
this comment also for the other docs.
Anyway, this is just a suggestion. I'm also fine with the above.
Either way, for the conversion itself:
Reviewed-by: Mauro Carvalho Chehab
>
> -1. ACPICA Project
> +ACPICA Project
> +==
>
> - The ACPI Component Architecture (ACPICA) project provides an operating
> - system (OS)-independent reference implementation of the Advanced
> - Configuration and Power Interface Specification (ACPI). It has been
> - adapted by various host OSes. By directly integrating ACPICA, Linux can
> - also benefit from the application experiences of ACPICA from other host
> - OSes.
> +The ACPI Component Architecture (ACPICA) project provides an operating
> +system (OS)-independent reference implementation of the Advanced
> +Configuration and Power Interface Specification (ACPI). It has been
> +adapted by various host OSes. By directly integrating ACPICA, Linux can
> +also benefit from the application experiences of ACPICA from other host
> +OSes.
>
> - The homepage of ACPICA project is: www.acpica.org, it is maintained and
> - supported by Intel Corporation.
> +The homepage of ACPICA project is: www.acpica.org, it is maintained and
> +supported by Intel Corporation.
>
> - The following figure depicts the Linux ACPI subsystem where the ACPICA
> - adaptation is included:
> +The following figure depicts the Linux ACPI subsystem where the ACPICA
> +adaptation is included::
>
>+-+
>| |
> @@ -71,21 +75,27 @@ upstream.
>
> Figure 1. Linux ACPI Software Components
>
> - NOTE:
> +.. note::
> A. OS Service Layer - Provided by Linux to offer OS dependent
> implementation of the predefined ACPICA interfaces (acpi_os_*).
> + ::
> +
> include/acpi/acpiosxf.h
> drivers/acpi/osl.c
> include/acpi/platform
> include/asm/acenv.h
> B. ACPICA Functionality - Released from ACPICA code base to offer
> OS independent implementation of
Re: [PATCH v4 06/63] Documentation: ACPI: move scan_handlers.txt to driver-api/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:35 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
For the conversion itself:
Reviewed-by: Mauro Carvalho Chehab
> ---
> Documentation/driver-api/acpi/index.rst | 1 +
> .../acpi/scan_handlers.rst} | 24 ---
> 2 files changed, 16 insertions(+), 9 deletions(-)
> rename Documentation/{acpi/scan_handlers.txt =>
> driver-api/acpi/scan_handlers.rst} (90%)
>
> diff --git a/Documentation/driver-api/acpi/index.rst
> b/Documentation/driver-api/acpi/index.rst
> index 12649947b19b..ace0008e54c2 100644
> --- a/Documentation/driver-api/acpi/index.rst
> +++ b/Documentation/driver-api/acpi/index.rst
> @@ -6,3 +6,4 @@ ACPI Support
> :maxdepth: 2
>
> linuxized-acpica
> + scan_handlers
> diff --git a/Documentation/acpi/scan_handlers.txt
> b/Documentation/driver-api/acpi/scan_handlers.rst
> similarity index 90%
> rename from Documentation/acpi/scan_handlers.txt
> rename to Documentation/driver-api/acpi/scan_handlers.rst
> index 3246ccf15992..7a197b3a33fc 100644
> --- a/Documentation/acpi/scan_handlers.txt
> +++ b/Documentation/driver-api/acpi/scan_handlers.rst
> @@ -1,7 +1,13 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
> +
> +==
> ACPI Scan Handlers
> +==
> +
> +:Copyright: |copy| 2012, Intel Corporation
>
> -Copyright (C) 2012, Intel Corporation
> -Author: Rafael J. Wysocki
> +:Author: Rafael J. Wysocki
>
> During system initialization and ACPI-based device hot-add, the ACPI
> namespace
> is scanned in search of device objects that generally represent various
> pieces
> @@ -30,14 +36,14 @@ to configure that link so that the kernel can use it.
> Those additional configuration tasks usually depend on the type of the
> hardware
> component represented by the given device node which can be determined on the
> basis of the device node's hardware ID (HID). They are performed by objects
> -called ACPI scan handlers represented by the following structure:
> +called ACPI scan handlers represented by the following structure::
>
> -struct acpi_scan_handler {
> - const struct acpi_device_id *ids;
> - struct list_head list_node;
> - int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
> - void (*detach)(struct acpi_device *dev);
> -};
> + struct acpi_scan_handler {
> + const struct acpi_device_id *ids;
> + struct list_head list_node;
> + int (*attach)(struct acpi_device *dev, const struct
> acpi_device_id *id);
> + void (*detach)(struct acpi_device *dev);
> + };
>
> where ids is the list of IDs of device nodes the given handler is supposed to
> take care of, list_node is the hook to the global list of ACPI scan handlers
Thanks,
Mauro
Re: [PATCH v4 07/63] Documentation: ACPI: move DSD-properties-rules.txt to firmware-guide/acpi and covert to reST
Em Wed, 24 Apr 2019 00:28:36 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
For the conversion itself:
Reviewed-by: Mauro Carvalho Chehab
> ---
> .../acpi/DSD-properties-rules.rst}| 21 +++
> Documentation/firmware-guide/acpi/index.rst | 1 +
> 2 files changed, 13 insertions(+), 9 deletions(-)
> rename Documentation/{acpi/DSD-properties-rules.txt =>
> firmware-guide/acpi/DSD-properties-rules.rst} (88%)
>
> diff --git a/Documentation/acpi/DSD-properties-rules.txt
> b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> similarity index 88%
> rename from Documentation/acpi/DSD-properties-rules.txt
> rename to Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> index 3e4862bdad98..4306f29b6103 100644
> --- a/Documentation/acpi/DSD-properties-rules.txt
> +++ b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> @@ -1,8 +1,11 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==
> _DSD Device Properties Usage Rules
> ---
> +==
>
> Properties, Property Sets and Property Subsets
> ---
> +==
>
> The _DSD (Device Specific Data) configuration object, introduced in ACPI 5.1,
> allows any type of device configuration data to be provided via the ACPI
> @@ -18,7 +21,7 @@ specific type) associated with it.
>
> In the ACPI _DSD context it is an element of the sub-package following the
> generic Device Properties UUID in the _DSD return package as specified in the
> -Device Properties UUID definition document [1].
> +Device Properties UUID definition document [1]_.
>
> It also may be regarded as the definition of a key and the associated data
> type
> that can be returned by _DSD in the Device Properties UUID sub-package for a
> @@ -33,14 +36,14 @@ Property subsets are nested collections of properties.
> Each of them is
> associated with an additional key (name) allowing the subset to be referred
> to as a whole (and to be treated as a separate entity). The canonical
> representation of property subsets is via the mechanism specified in the
> -Hierarchical Properties Extension UUID definition document [2].
> +Hierarchical Properties Extension UUID definition document [2]_.
>
> Property sets may be hierarchical. That is, a property set may contain
> multiple property subsets that each may contain property subsets of its
> own and so on.
>
> General Validity Rule for Property Sets
>
> +===
>
> Valid property sets must follow the guidance given by the Device Properties
> UUID
> definition document [1].
> @@ -73,7 +76,7 @@ suitable for the ACPI environment and consequently they
> cannot belong to a valid
> property set.
>
> Property Sets and Device Tree Bindings
> ---
> +==
>
> It often is useful to make _DSD return property sets that follow Device Tree
> bindings.
> @@ -91,7 +94,7 @@ expected to automatically work in the ACPI environment
> regardless of their
> contents.
>
> References
> ---
> +==
>
> -[1]
> http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
> -[2]
> http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf
> +.. [1]
> http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
> +.. [2]
> http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 868bd25a3398..0e05b843521c 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -10,3 +10,4 @@ ACPI Support
> namespace
> enumeration
> osi
> + DSD-properties-rules
Thanks,
Mauro
Re: [PATCH v4 08/63] Documentation: ACPI: move gpio-properties.txt to firmware-guide/acpi and convert to reST
estion would look like this::
>
> -static const struct acpi_gpio_params reset_gpio = { 1, 1, false };
> -static const struct acpi_gpio_params shutdown_gpio = { 0, 0, false };
> + static const struct acpi_gpio_params reset_gpio = { 1, 1, false };
> + static const struct acpi_gpio_params shutdown_gpio = { 0, 0, false };
>
> -static const struct acpi_gpio_mapping bluetooth_acpi_gpios[] = {
> - { "reset-gpios", _gpio, 1 },
> - { "shutdown-gpios", _gpio, 1 },
> - { },
> -};
> + static const struct acpi_gpio_mapping bluetooth_acpi_gpios[] = {
> +{ "reset-gpios", _gpio, 1 },
> +{ "shutdown-gpios", _gpio, 1 },
> +{ },
> + };
>
> Next, the mapping table needs to be passed as the second argument to
> acpi_dev_add_driver_gpios() that will register it with the ACPI device object
> @@ -158,12 +165,12 @@ calling acpi_dev_remove_driver_gpios() on the ACPI
> device object where that
> table was previously registered.
>
> Using the _CRS fallback
>
> +===
>
> If a device does not have _DSD or the driver does not create ACPI GPIO
> mapping, the Linux GPIO framework refuses to return any GPIOs. This is
> because the driver does not know what it actually gets. For example if we
> -have a device like below:
> +have a device like below::
>
>Device (BTH)
>{
> @@ -177,7 +184,7 @@ have a device like below:
>})
>}
>
> -The driver might expect to get the right GPIO when it does:
> +The driver might expect to get the right GPIO when it does:：
Hmm... there is a small typo here:
": :" -> "::"
For the conversion itself, after correcting the above typo:
Reviewed-by: Mauro Carvalho Chehab
>
>desc = gpiod_get(dev, "reset", GPIOD_OUT_LOW);
>
> @@ -193,22 +200,25 @@ the ACPI GPIO mapping tables are hardly linked to ACPI
> ID and certain
> objects, as listed in the above chapter, of the device in question.
>
> Getting GPIO descriptor
>
> +===
> +
> +There are two main approaches to get GPIO resource from ACPI::
>
> -There are two main approaches to get GPIO resource from ACPI:
> - desc = gpiod_get(dev, connection_id, flags);
> - desc = gpiod_get_index(dev, connection_id, index, flags);
> + desc = gpiod_get(dev, connection_id, flags);
> + desc = gpiod_get_index(dev, connection_id, index, flags);
>
> We may consider two different cases here, i.e. when connection ID is
> provided and otherwise.
>
> -Case 1:
> - desc = gpiod_get(dev, "non-null-connection-id", flags);
> - desc = gpiod_get_index(dev, "non-null-connection-id", index, flags);
> +Case 1::
> +
> + desc = gpiod_get(dev, "non-null-connection-id", flags);
> + desc = gpiod_get_index(dev, "non-null-connection-id", index, flags);
> +
> +Case 2::
>
> -Case 2:
> - desc = gpiod_get(dev, NULL, flags);
> - desc = gpiod_get_index(dev, NULL, index, flags);
> + desc = gpiod_get(dev, NULL, flags);
> + desc = gpiod_get_index(dev, NULL, index, flags);
>
> Case 1 assumes that corresponding ACPI device description must have
> defined device properties and will prevent to getting any GPIO resources
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 0e05b843521c..61d67763851b 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -11,3 +11,4 @@ ACPI Support
> enumeration
> osi
> DSD-properties-rules
> + gpio-properties
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 09f43f1bdd15..87f930bf32ad 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -6593,7 +6593,7 @@ M: Andy Shevchenko
>
> L: linux-g...@vger.kernel.org
> L: linux-a...@vger.kernel.org
> S: Maintained
> -F: Documentation/acpi/gpio-properties.txt
> +F: Documentation/firmware-guide/acpi/gpio-properties.rst
> F: drivers/gpio/gpiolib-acpi.c
>
> GPIO IR Transmitter
Thanks,
Mauro
Re: [PATCH v4 09/63] Documentation: ACPI: move method-customizing.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:38 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> Documentation/acpi/method-customizing.txt | 73 -
> Documentation/firmware-guide/acpi/index.rst | 3 +-
> .../acpi/method-customizing.rst | 82 +++
> 3 files changed, 84 insertions(+), 74 deletions(-)
> delete mode 100644 Documentation/acpi/method-customizing.txt
> create mode 100644 Documentation/firmware-guide/acpi/method-customizing.rst
>
> diff --git a/Documentation/acpi/method-customizing.txt
> b/Documentation/acpi/method-customizing.txt
> deleted file mode 100644
> index 7235da975f23..
> --- a/Documentation/acpi/method-customizing.txt
> +++ /dev/null
> @@ -1,73 +0,0 @@
> -Linux ACPI Custom Control Method How To
> -===
> -
> -Written by Zhang Rui
> -
> -
> -Linux supports customizing ACPI control methods at runtime.
> -
> -Users can use this to
> -1. override an existing method which may not work correctly,
> - or just for debugging purposes.
> -2. insert a completely new method in order to create a missing
> - method such as _OFF, _ON, _STA, _INI, etc.
> -For these cases, it is far simpler to dynamically install a single
> -control method rather than override the entire DSDT, because kernel
> -rebuild/reboot is not needed and test result can be got in minutes.
> -
> -Note: Only ACPI METHOD can be overridden, any other object types like
> - "Device", "OperationRegion", are not recognized. Methods
> - declared inside scope operators are also not supported.
> -Note: The same ACPI control method can be overridden for many times,
> - and it's always the latest one that used by Linux/kernel.
> -Note: To get the ACPI debug object output (Store (, Debug)),
> - please run "echo 1 > /sys/module/acpi/parameters/aml_debug_output".
> -
> -1. override an existing method
> - a) get the ACPI table via ACPI sysfs I/F. e.g. to get the DSDT,
> - just run "cat /sys/firmware/acpi/tables/DSDT > /tmp/dsdt.dat"
> - b) disassemble the table by running "iasl -d dsdt.dat".
> - c) rewrite the ASL code of the method and save it in a new file,
> - d) package the new file (psr.asl) to an ACPI table format.
> - Here is an example of a customized \_SB._AC._PSR method,
> -
> - DefinitionBlock ("", "SSDT", 1, "", "", 0x20080715)
> - {
> - Method (\_SB_.AC._PSR, 0, NotSerialized)
> - {
> - Store ("In AC _PSR", Debug)
> - Return (ACON)
> - }
> - }
> - Note that the full pathname of the method in ACPI namespace
> - should be used.
> - e) assemble the file to generate the AML code of the method.
> - e.g. "iasl -vw 6084 psr.asl" (psr.aml is generated as a result)
> - If parameter "-vw 6084" is not supported by your iASL compiler,
> - please try a newer version.
> - f) mount debugfs by "mount -t debugfs none /sys/kernel/debug"
> - g) override the old method via the debugfs by running
> - "cat /tmp/psr.aml > /sys/kernel/debug/acpi/custom_method"
> -
> -2. insert a new method
> - This is easier than overriding an existing method.
> - We just need to create the ASL code of the method we want to
> - insert and then follow the step c) ~ g) in section 1.
> -
> -3. undo your changes
> - The "undo" operation is not supported for a new inserted method
> - right now, i.e. we can not remove a method currently.
> - For an overridden method, in order to undo your changes, please
> - save a copy of the method original ASL code in step c) section 1,
> - and redo step c) ~ g) to override the method with the original one.
> -
> -
> -Note: We can use a kernel with multiple custom ACPI method running,
> - But each individual write to debugfs can implement a SINGLE
> - method override. i.e. if we want to insert/override multiple
> - ACPI methods, we need to redo step c) ~ g) for multiple times.
> -
> -Note: Be aware that root can mis-use this driver to modify arbitrary
> - memory and gain additional rights, if root's privileges got
> - restricted (for example if root is not allowed to load additional
> - modules after boot).
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 61d67763851b..d1d069b26bbc 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -10,5 +10,6 @@ ACPI Support
> namespace
> enumeration
> osi
> + method-customizing
> DSD-properties-rules
> - gpio-properties
> + gpio-properties
> \ No newline at end of file
> diff --git a/Documentation/firmware-guide/acpi/method-customizing.rst
> b/Documentation/firmware-guide/acpi/method-customizing.rst
> new file mode 100644
> index
Re: [PATCH v4 10/63] Documentation: ACPI: move initrd_table_override.txt to admin-guide/acpi and convert to reST
rd on top: > -find kernel | cpio -H newc --create > /boot/instrumented_initrd > -cat /boot/initrd >>/boot/instrumented_initrd > -# reboot with increased acpi debug level, e.g. boot params: > -acpi.debug_level=0x2 acpi.debug_layer=0x > -# and check your syslog: > -[1.268089] ACPI: PCI Interrupt Routing Table [\_SB_.PCI0._PRT] > -[1.272091] [ACPI Debug] String [0x0B] "HELLO WORLD" > - > -iasl is able to disassemble and recompile quite a lot different, > -also static ACPI tables. > - > - > -4) Where to retrieve userspace tools > - > - > -iasl and acpixtract are part of Intel's ACPICA project: > -http://acpica.org/ > -and should be packaged by distributions (for example in the acpica package > -on SUSE). > - > -acpidump can be found in Len Browns pmtools: > -ftp://kernel.org/pub/linux/kernel/people/lenb/acpi/utils/pmtools/acpidump > -This tool is also part of the acpica package on SUSE. > -Alternatively, used ACPI tables can be retrieved via sysfs in latest kernels: > -/sys/firmware/acpi/tables > diff --git a/Documentation/admin-guide/acpi/index.rst > b/Documentation/admin-guide/acpi/index.rst > index 3e041206089d..09e4e81e4fb7 100644 > --- a/Documentation/admin-guide/acpi/index.rst > +++ b/Documentation/admin-guide/acpi/index.rst > @@ -8,3 +8,4 @@ the Linux ACPI support. > .. toctree:: > :maxdepth: 1 > > + initrd_table_override > diff --git a/Documentation/admin-guide/acpi/initrd_table_override.rst > b/Documentation/admin-guide/acpi/initrd_table_override.rst > new file mode 100644 > index ..0787b2b91ded > --- /dev/null > +++ b/Documentation/admin-guide/acpi/initrd_table_override.rst > @@ -0,0 +1,120 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > + > +Upgrading ACPI tables via initrd > + > + > +1) Introduction (What is this about) > +2) What is this for > +3) How does it work > +4) References (Where to retrieve userspace tools) Hmm... I did the same on my conversion, but IMO, the best would be to hide (or remove, if ACPI maintainers agree) the contents, as this may conflict with the body as people may add new stuff and forget to update it. So, if ACPI maintainers insist on keeping it, I would code this as: .. Contents 1) Introduction (What is this about) 2) What is this for 3) How does it work 4) References (Where to retrieve userspace tools) as this will make this invisible on html/pdf/epub output. Anyway, with or without the above change: Reviewed-by: Mauro Carvalho Chehab > + > +1) What is this about > += > + > +If the ACPI_TABLE_UPGRADE compile option is true, it is possible to > +upgrade the ACPI execution environment that is defined by the ACPI tables > +via upgrading the ACPI tables provided by the BIOS with an instrumented, > +modified, more recent version one, or installing brand new ACPI tables. > + > +When building initrd with kernel in a single image, option > +ACPI_TABLE_OVERRIDE_VIA_BUILTIN_INITRD should also be true for this > +feature to work. > + > +For a full list of ACPI tables that can be upgraded/installed, take a look > +at the char `*table_sigs[MAX_ACPI_SIGNATURE];` definition in > +drivers/acpi/tables.c. > + > +All ACPI tables iasl (Intel's ACPI compiler and disassembler) knows should > +be overridable, except: > + > + - ACPI_SIG_RSDP (has a signature of 6 bytes) > + - ACPI_SIG_FACS (does not have an ordinary ACPI table header) > + > +Both could get implemented as well. > + > + > +2) What is this for > +=== > + > +Complain to your platform/BIOS vendor if you find a bug which is so severe > +that a workaround is not accepted in the Linux kernel. And this facility > +allows you to upgrade the buggy tables before your platform/BIOS vendor > +releases an upgraded BIOS binary. > + > +This facility can be used by platform/BIOS vendors to provide a Linux > +compatible environment without modifying the underlying platform firmware. > + > +This facility also provides a powerful feature to easily debug and test > +ACPI BIOS table compatibility with the Linux kernel by modifying old > +platform provided ACPI tables or inserting new ACPI tables. > + > +It can and should be enabled in any kernel because there is no functional > +change with not instrumented initrds. > + > + > +3) How does it work > +=== > +:: > + > + # Extract the machine's ACPI tables: > + cd /tmp > + acpidump >acpidump > + acpixtract -a acpidump > + # Disassemble, modify and recompile them: > + iasl -d *.dat > + # For example add this statement into a _PRT (PCI Routing Table)
Re: [PATCH v4 11/63] Documentation: ACPI: move dsdt-override.txt to admin-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:40 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
Reviewed-by: Mauro Carvalho Chehab
> ---
> .../acpi/dsdt-override.rst} | 8 +++-
> Documentation/admin-guide/acpi/index.rst | 1 +
> 2 files changed, 8 insertions(+), 1 deletion(-)
> rename Documentation/{acpi/dsdt-override.txt =>
> admin-guide/acpi/dsdt-override.rst} (56%)
>
> diff --git a/Documentation/acpi/dsdt-override.txt
> b/Documentation/admin-guide/acpi/dsdt-override.rst
> similarity index 56%
> rename from Documentation/acpi/dsdt-override.txt
> rename to Documentation/admin-guide/acpi/dsdt-override.rst
> index 784841caa6e6..50bd7f194bf4 100644
> --- a/Documentation/acpi/dsdt-override.txt
> +++ b/Documentation/admin-guide/acpi/dsdt-override.rst
> @@ -1,6 +1,12 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===
> +Overriding DSDT
> +===
> +
> Linux supports a method of overriding the BIOS DSDT:
>
> -CONFIG_ACPI_CUSTOM_DSDT builds the image into the kernel.
> +CONFIG_ACPI_CUSTOM_DSDT - builds the image into the kernel.
>
> When to use this method is described in detail on the
> Linux/ACPI home page:
> diff --git a/Documentation/admin-guide/acpi/index.rst
> b/Documentation/admin-guide/acpi/index.rst
> index 09e4e81e4fb7..d68e9914c5ff 100644
> --- a/Documentation/admin-guide/acpi/index.rst
> +++ b/Documentation/admin-guide/acpi/index.rst
> @@ -9,3 +9,4 @@ the Linux ACPI support.
> :maxdepth: 1
>
> initrd_table_override
> + dsdt-override
Thanks,
Mauro
Re: [PATCH v4 12/63] Documentation: ACPI: move i2c-muxes.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:41 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
For the conversion itself:
Reviewed-by: Mauro Carvalho Chehab
> ---
> Documentation/acpi/i2c-muxes.txt | 58 --
> .../firmware-guide/acpi/i2c-muxes.rst | 61 +++
> Documentation/firmware-guide/acpi/index.rst | 3 +-
> 3 files changed, 63 insertions(+), 59 deletions(-)
> delete mode 100644 Documentation/acpi/i2c-muxes.txt
> create mode 100644 Documentation/firmware-guide/acpi/i2c-muxes.rst
>
> diff --git a/Documentation/acpi/i2c-muxes.txt
> b/Documentation/acpi/i2c-muxes.txt
> deleted file mode 100644
> index 9fcc4f0b885e..
> --- a/Documentation/acpi/i2c-muxes.txt
> +++ /dev/null
> @@ -1,58 +0,0 @@
> -ACPI I2C Muxes
> ---
> -
> -Describing an I2C device hierarchy that includes I2C muxes requires an ACPI
> -Device () scope per mux channel.
> -
> -Consider this topology:
> -
> -+--+ +--+
> -| SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50)
> -| | | 0x70 |--CH01--> i2c client B (0x50)
> -+--+ +--+
> -
> -which corresponds to the following ASL:
> -
> -Device (SMB1)
> -{
> -Name (_HID, ...)
> -Device (MUX0)
> -{
> -Name (_HID, ...)
> -Name (_CRS, ResourceTemplate () {
> -I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED,
> - AddressingMode7Bit, "^SMB1", 0x00,
> - ResourceConsumer,,)
> -}
> -
> -Device (CH00)
> -{
> -Name (_ADR, 0)
> -
> -Device (CLIA)
> -{
> -Name (_HID, ...)
> -Name (_CRS, ResourceTemplate () {
> -I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
> - AddressingMode7Bit, "^CH00", 0x00,
> - ResourceConsumer,,)
> -}
> -}
> -}
> -
> -Device (CH01)
> -{
> -Name (_ADR, 1)
> -
> -Device (CLIB)
> -{
> -Name (_HID, ...)
> -Name (_CRS, ResourceTemplate () {
> -I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
> - AddressingMode7Bit, "^CH01", 0x00,
> - ResourceConsumer,,)
> -}
> -}
> -}
> -}
> -}
> diff --git a/Documentation/firmware-guide/acpi/i2c-muxes.rst
> b/Documentation/firmware-guide/acpi/i2c-muxes.rst
> new file mode 100644
> index ..3a8997ccd7c4
> --- /dev/null
> +++ b/Documentation/firmware-guide/acpi/i2c-muxes.rst
> @@ -0,0 +1,61 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==
> +ACPI I2C Muxes
> +==
> +
> +Describing an I2C device hierarchy that includes I2C muxes requires an ACPI
> +Device () scope per mux channel.
> +
> +Consider this topology::
> +
> ++--+ +--+
> +| SMB1 |-->| MUX0 |--CH00--> i2c client A (0x50)
> +| | | 0x70 |--CH01--> i2c client B (0x50)
> ++--+ +--+
> +
> +which corresponds to the following ASL::
> +
> +Device (SMB1)
> +{
> +Name (_HID, ...)
> +Device (MUX0)
> +{
> +Name (_HID, ...)
> +Name (_CRS, ResourceTemplate () {
> +I2cSerialBus (0x70, ControllerInitiated, I2C_SPEED,
> +AddressingMode7Bit, "^SMB1", 0x00,
> +ResourceConsumer,,)
> +}
> +
> +Device (CH00)
> +{
> +Name (_ADR, 0)
> +
> +Device (CLIA)
> +{
> +Name (_HID, ...)
> +Name (_CRS, ResourceTemplate () {
> +I2cSerialBus (0x50, ControllerInitiated, I2C_SPEED,
> +AddressingMode7Bit, "^CH00", 0x00,
> +ResourceConsumer,,)
> +}
> +}
> +}
> +
> +Device (CH01)
> +{
> +Name (_ADR, 1)
> +
> +Device (CLIB)
> +{
> +Name (_HID, ...)
> +Name (_CRS, ResourceTemplate () {
> +I2cSerialBus (0x50, ControllerI
Re: [PATCH v4 13/63] Documentation: ACPI: move acpi-lid.txt to firmware-guide/acpi and convert to reST
t the buggy > firmware cannot make sure "opened"/"closed" events are paired, the ACPI > @@ -59,20 +68,25 @@ button driver uses the following 3 modes in order not to > trigger issues. > If the userspace hasn't been prepared to ignore the unreliable "opened" > events and the unreliable initial state notification, Linux users can use > the following kernel parameters to handle the possible issues: > + > A. button.lid_init_state=method: Just for the sake of a better visual at the html output, I would place those button.* as: A. ``button.lid_init_state=method``: Anyway, with or without such change: Reviewed-by: Mauro Carvalho Chehab > When this option is specified, the ACPI button driver reports the > initial lid state using the returning value of the _LID control method > and whether the "opened"/"closed" events are paired fully relies on the > firmware implementation. > + > This option can be used to fix some platforms where the returning value > of the _LID control method is reliable but the initial lid state > notification is missing. > + > This option is the default behavior during the period the userspace > isn't ready to handle the buggy AML tables. > + > B. button.lid_init_state=open: > When this option is specified, the ACPI button driver always reports the > initial lid state as "opened" and whether the "opened"/"closed" events > are paired fully relies on the firmware implementation. > + > This may fix some platforms where the returning value of the _LID > control method is not reliable and the initial lid state notification is > missing. > @@ -80,6 +94,7 @@ B. button.lid_init_state=open: > If the userspace has been prepared to ignore the unreliable "opened" events > and the unreliable initial state notification, Linux users should always > use the following kernel parameter: > + > C. button.lid_init_state=ignore: > When this option is specified, the ACPI button driver never reports the > initial lid state and there is a compensation mechanism implemented to > @@ -89,6 +104,7 @@ C. button.lid_init_state=ignore: > notifications can be delivered to the userspace when the lid is actually > opens given that some AML tables do not send "opened" notifications > reliably. > + > In this mode, if everything is correctly implemented by the platform > firmware, the old userspace programs should still work. Otherwise, the > new userspace programs are required to work with the ACPI button driver. > diff --git a/Documentation/firmware-guide/acpi/index.rst > b/Documentation/firmware-guide/acpi/index.rst > index 1c89888f6ee8..bedcb0b242a2 100644 > --- a/Documentation/firmware-guide/acpi/index.rst > +++ b/Documentation/firmware-guide/acpi/index.rst > @@ -14,3 +14,4 @@ ACPI Support > DSD-properties-rules > gpio-properties > i2c-muxes > + acpi-lid > \ No newline at end of file Thanks, Mauro
Re: [PATCH v4 14/63] Documentation: ACPI: move dsd/graph.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:43 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
Reviewed-by: Mauro Carvalho Chehab
> ---
> .../acpi/dsd/graph.rst} | 157 +-
> Documentation/firmware-guide/acpi/index.rst | 1 +
> 2 files changed, 81 insertions(+), 77 deletions(-)
> rename Documentation/{acpi/dsd/graph.txt =>
> firmware-guide/acpi/dsd/graph.rst} (56%)
>
> diff --git a/Documentation/acpi/dsd/graph.txt
> b/Documentation/firmware-guide/acpi/dsd/graph.rst
> similarity index 56%
> rename from Documentation/acpi/dsd/graph.txt
> rename to Documentation/firmware-guide/acpi/dsd/graph.rst
> index b9ce910781dc..e0baed35b037 100644
> --- a/Documentation/acpi/dsd/graph.txt
> +++ b/Documentation/firmware-guide/acpi/dsd/graph.rst
> @@ -1,8 +1,11 @@
> -Graphs
> +.. SPDX-License-Identifier: GPL-2.0
>
> +==
> +Graphs
> +==
>
> _DSD
> -
> +
>
> _DSD (Device Specific Data) [7] is a predefined ACPI device
> configuration object that can be used to convey information on
> @@ -30,7 +33,7 @@ hierarchical data extension array on each depth.
>
>
> Ports and endpoints
>
> +===
>
> The port and endpoint concepts are very similar to those in Devicetree
> [3]. A port represents an interface in a device, and an endpoint
> @@ -38,9 +41,9 @@ represents a connection to that interface.
>
> All port nodes are located under the device's "_DSD" node in the hierarchical
> data extension tree. The data extension related to each port node must begin
> -with "port" and must be followed by the "@" character and the number of the
> port
> -as its key. The target object it refers to should be called "PRTX", where
> "X" is
> -the number of the port. An example of such a package would be:
> +with "port" and must be followed by the "@" character and the number of the
> +port as its key. The target object it refers to should be called "PRTX",
> where
> +"X" is the number of the port. An example of such a package would be::
>
> Package() { "port@4", PRT4 }
>
> @@ -49,7 +52,7 @@ data extension key of the endpoint nodes must begin with
> "endpoint" and must be followed by the "@" character and the number of the
> endpoint. The object it refers to should be called "EPXY", where "X" is the
> number of the port and "Y" is the number of the endpoint. An example of such
> a
> -package would be:
> +package would be::
>
> Package() { "endpoint@0", EP40 }
>
> @@ -62,85 +65,85 @@ of that port shall be zero. Similarly, if a port may only
> have a single
> endpoint, the number of that endpoint shall be zero.
>
> The endpoint reference uses property extension with "remote-endpoint"
> property
> -name followed by a reference in the same package. Such references consist of
> the
> +name followed by a reference in the same package. Such references consist of
> the remote device reference, the first package entry of the port data
> extension
> reference under the device and finally the first package entry of the
> endpoint
> -data extension reference under the port. Individual references thus appear
> as:
> +data extension reference under the port. Individual references thus appear
> as::
>
> Package() { device, "port@X", "endpoint@Y" }
>
> -In the above example, "X" is the number of the port and "Y" is the number of
> the
> -endpoint.
> +In the above example, "X" is the number of the port and "Y" is the number of
> +the endpoint.
>
> The references to endpoints must be always done both ways, to the
> remote endpoint and back from the referred remote endpoint node.
>
> -A simple example of this is show below:
> +A simple example of this is show below::
>
> Scope (\_SB.PCI0.I2C2)
> {
> - Device (CAM0)
> - {
> - Name (_DSD, Package () {
> - ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
> - Package () {
> - Package () { "compatible", Package () { "nokia,smia" } },
> - },
> - ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
> - Package () {
> - Package () { "port@0", PRT0 },
> - }
> - })
> -
Re: [PATCH v4 15/63] Documentation: ACPI: move dsd/data-node-references.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:44 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> .../acpi/dsd/data-node-references.rst}| 28 +++
> Documentation/firmware-guide/acpi/index.rst | 1 +
> 2 files changed, 17 insertions(+), 12 deletions(-)
> rename Documentation/{acpi/dsd/data-node-references.txt =>
> firmware-guide/acpi/dsd/data-node-references.rst} (79%)
>
> diff --git a/Documentation/acpi/dsd/data-node-references.txt
> b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> similarity index 79%
> rename from Documentation/acpi/dsd/data-node-references.txt
> rename to Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> index c3871565c8cf..79c5368eaecf 100644
> --- a/Documentation/acpi/dsd/data-node-references.txt
> +++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> @@ -1,9 +1,12 @@
> -Copyright (C) 2018 Intel Corporation
> -Author: Sakari Ailus
> -
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
>
> +===
> Referencing hierarchical data nodes
>
> +===
> +
> +:Copyright: |copy| 2018 Intel Corporation
> +:Author: Sakari Ailus
>
> ACPI in general allows referring to device objects in the tree only.
> Hierarchical data extension nodes may not be referred to directly, hence this
> @@ -28,13 +31,14 @@ extension key.
>
>
> Example
>
> +===
>
> - In the ASL snippet below, the "reference" _DSD property [2] contains a
> - device object reference to DEV0 and under that device object, a
> - hierarchical data extension key "node@1" referring to the NOD1 object
> - and lastly, a hierarchical data extension key "anothernode" referring to
> - the ANOD object which is also the final target node of the reference.
> +In the ASL snippet below, the "reference" _DSD property [2] contains a
> +device object reference to DEV0 and under that device object, a
> +hierarchical data extension key "node@1" referring to the NOD1 object
> +and lastly, a hierarchical data extension key "anothernode" referring to
> +the ANOD object which is also the final target node of the reference.
> +::
>
> Device (DEV0)
> {
> @@ -75,10 +79,10 @@ Example
> })
> }
>
> -Please also see a graph example in graph.txt .
> +Please also see a graph example in :doc:`graph`.
>
> References
> ---
> +==
>
> [1] Hierarchical Data Extension UUID For _DSD.
>
> http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>,
Hmm... on the previous patch, you replaced by some_url,
with makes sense. Please do the same here and on other patches on
this series with a similar way to describe URLs.
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index f81cfbcb6878..6d4e0df4f063 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -9,6 +9,7 @@ ACPI Support
>
> namespace
> dsd/graph
> + dsd/data-node-references
> enumeration
> osi
> method-customizing
Thanks,
Mauro
Re: [PATCH v4 16/63] Documentation: ACPI: move debug.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:45 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> .../acpi/debug.rst} | 31 ++-
> Documentation/firmware-guide/acpi/index.rst | 3 +-
> 2 files changed, 19 insertions(+), 15 deletions(-)
> rename Documentation/{acpi/debug.txt => firmware-guide/acpi/debug.rst} (91%)
>
> diff --git a/Documentation/acpi/debug.txt
> b/Documentation/firmware-guide/acpi/debug.rst
> similarity index 91%
> rename from Documentation/acpi/debug.txt
> rename to Documentation/firmware-guide/acpi/debug.rst
> index 65bf47c46b6d..1a152dd1d765 100644
> --- a/Documentation/acpi/debug.txt
> +++ b/Documentation/firmware-guide/acpi/debug.rst
> @@ -1,18 +1,21 @@
> - ACPI Debug Output
> +.. SPDX-License-Identifier: GPL-2.0
>
> +=
> +ACPI Debug Output
> +=
>
> The ACPI CA, the Linux ACPI core, and some ACPI drivers can generate debug
> output. This document describes how to use this facility.
>
> Compile-time configuration
> ---
> +==
>
> ACPI debug output is globally enabled by CONFIG_ACPI_DEBUG. If this config
> option is turned off, the debug messages are not even built into the
> kernel.
>
> Boot- and run-time configuration
> -
> +
>
> When CONFIG_ACPI_DEBUG=y, you can select the component and level of messages
> you're interested in. At boot-time, use the acpi.debug_layer and
> @@ -21,7 +24,7 @@ debug_layer and debug_level files in
> /sys/module/acpi/parameters/ to control
> the debug messages.
>
> debug_layer (component)
>
> +===
>
> The "debug_layer" is a mask that selects components of interest, e.g., a
> specific driver or part of the ACPI interpreter. To build the debug_layer
> @@ -33,7 +36,7 @@ to /sys/module/acpi/parameters/debug_layer.
>
> The possible components are defined in include/acpi/acoutput.h and
> include/acpi/acpi_drivers.h. Reading /sys/module/acpi/parameters/debug_layer
> -shows the supported mask values, currently these:
> +shows the supported mask values, currently these::
>
> ACPI_UTILITIES 0x0001
> ACPI_HARDWARE 0x0002
> @@ -65,7 +68,7 @@ shows the supported mask values, currently these:
> ACPI_PROCESSOR_COMPONENT0x2000
This is one way of doing. The other one, with would likely produce a
better visual, would be to use tables, e. g.:
== ==
ACPI_UTILITIES 0x0001
ACPI_HARDWARE 0x0002
== ======
Of course, if you use tables here, you need to be consistent along
similar cases inside the document.
while both works, I prefer using tables on such cases.
Either way:
Reviewed-by: Mauro Carvalho Chehab
>
> debug_level
>
> +===
>
> The "debug_level" is a mask that selects different types of messages, e.g.,
> those related to initialization, method execution, informational messages,
> etc.
> @@ -81,7 +84,7 @@ to /sys/module/acpi/parameters/debug_level.
>
> The possible levels are defined in include/acpi/acoutput.h. Reading
> /sys/module/acpi/parameters/debug_level shows the supported mask values,
> -currently these:
> +currently these::
>
> ACPI_LV_INIT0x0001
> ACPI_LV_DEBUG_OBJECT0x0002
> @@ -113,9 +116,9 @@ currently these:
> ACPI_LV_EVENTS 0x8000
>
> Examples
> -
> +
>
> -For example, drivers/acpi/bus.c contains this:
> +For example, drivers/acpi/bus.c contains this::
>
> #define _COMPONENT ACPI_BUS_COMPONENT
> ...
> @@ -127,22 +130,22 @@ statement uses ACPI_DB_INFO, which is macro based on
> the ACPI_LV_INFO
> definition.)
>
> Enable all AML "Debug" output (stores to the Debug object while interpreting
> -AML) during boot:
> +AML) during boot::
>
> acpi.debug_layer=0x acpi.debug_level=0x2
>
> -Enable PCI and PCI interrupt routing debug messages:
> +Enable PCI and PCI interrupt routing debug messages::
>
> acpi.debug_layer=0x40 acpi.debug_level=0x4
>
> -Enable all ACPI hardware-related messages:
> +Enable all ACPI hardware-related messages::
>
> acpi.debug_layer=0x2 acpi.debug_level=
Re: [PATCH v4 03/63] Documentation: ACPI: move enumeration.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:32 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
Just looking at the conversion itself, it looks good to me.
Reviewed-by: Mauro Carvalho Chehab
>
> Signed-off-by: Changbin Du
> ---
> .../acpi/enumeration.rst} | 135 ++
> Documentation/firmware-guide/acpi/index.rst | 1 +
> 2 files changed, 74 insertions(+), 62 deletions(-)
> rename Documentation/{acpi/enumeration.txt =>
> firmware-guide/acpi/enumeration.rst} (87%)
>
> diff --git a/Documentation/acpi/enumeration.txt
> b/Documentation/firmware-guide/acpi/enumeration.rst
> similarity index 87%
> rename from Documentation/acpi/enumeration.txt
> rename to Documentation/firmware-guide/acpi/enumeration.rst
> index 7bcf9c3d9fbe..ce755e963714 100644
> --- a/Documentation/acpi/enumeration.txt
> +++ b/Documentation/firmware-guide/acpi/enumeration.rst
> @@ -1,5 +1,9 @@
> -ACPI based device enumeration
> -~
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=
> +ACPI Based Device Enumeration
> +=
> +
> ACPI 5 introduced a set of new resources (UartTSerialBus, I2cSerialBus,
> SpiSerialBus, GpioIo and GpioInt) which can be used in enumerating slave
> devices behind serial bus controllers.
> @@ -11,12 +15,12 @@ that are accessed through memory-mapped registers.
> In order to support this and re-use the existing drivers as much as
> possible we decided to do following:
>
> - o Devices that have no bus connector resource are represented as
> - platform devices.
> + - Devices that have no bus connector resource are represented as
> +platform devices.
>
> - o Devices behind real busses where there is a connector resource
> - are represented as struct spi_device or struct i2c_device
> - (standard UARTs are not busses so there is no struct uart_device).
> + - Devices behind real busses where there is a connector resource
> +are represented as struct spi_device or struct i2c_device
> +(standard UARTs are not busses so there is no struct uart_device).
>
> As both ACPI and Device Tree represent a tree of devices (and their
> resources) this implementation follows the Device Tree way as much as
> @@ -31,7 +35,8 @@ enumerated from ACPI namespace. This handle can be used to
> extract other
> device-specific configuration. There is an example of this below.
>
> Platform bus support
> -
> +
> +
> Since we are using platform devices to represent devices that are not
> connected to any physical bus we only need to implement a platform driver
> for the device and add supported ACPI IDs. If this same IP-block is used on
> @@ -39,7 +44,7 @@ some other non-ACPI platform, the driver might work out of
> the box or needs
> some minor changes.
>
> Adding ACPI support for an existing driver should be pretty
> -straightforward. Here is the simplest example:
> +straightforward. Here is the simplest example::
>
> #ifdef CONFIG_ACPI
> static const struct acpi_device_id mydrv_acpi_match[] = {
> @@ -61,12 +66,13 @@ configuring GPIOs it can get its ACPI handle and extract
> this information
> from ACPI tables.
>
> DMA support
> -~~~
> +===
> +
> DMA controllers enumerated via ACPI should be registered in the system to
> provide generic access to their resources. For example, a driver that would
> like to be accessible to slave devices via generic API call
> dma_request_slave_channel() must register itself at the end of the probe
> -function like this:
> +function like this::
>
> err = devm_acpi_dma_controller_register(dev, xlate_func, dw);
> /* Handle the error if it's not a case of !CONFIG_ACPI */
> @@ -74,7 +80,7 @@ function like this:
> and implement custom xlate function if needed (usually
> acpi_dma_simple_xlate()
> is enough) which converts the FixedDMA resource provided by struct
> acpi_dma_spec into the corresponding DMA channel. A piece of code for that
> case
> -could look like:
> +could look like::
>
> #ifdef CONFIG_ACPI
> struct filter_args {
> @@ -114,7 +120,7 @@ provided by struct acpi_dma.
> Clients must call dma_request_slave_channel() with the string parameter that
> corresponds to a specific FixedDMA resource. By default "tx" means the first
> entry of the FixedDMA resource array, "rx" means the second entry. The table
> -below shows a layout:
> +below shows a layout::
>
> Device (I2
Re: [PATCH v4 02/63] Documentation: ACPI: move namespace.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:31 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> Documentation/firmware-guide/acpi/index.rst | 1 +
> .../acpi/namespace.rst} | 310 +-
> 2 files changed, 161 insertions(+), 150 deletions(-)
> rename Documentation/{acpi/namespace.txt =>
> firmware-guide/acpi/namespace.rst} (54%)
>
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 0ec7d072ba22..210ad8acd6df 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -7,3 +7,4 @@ ACPI Support
> .. toctree::
> :maxdepth: 1
>
> + namespace
> diff --git a/Documentation/acpi/namespace.txt
> b/Documentation/firmware-guide/acpi/namespace.rst
> similarity index 54%
> rename from Documentation/acpi/namespace.txt
> rename to Documentation/firmware-guide/acpi/namespace.rst
> index 1860cb3865c6..443f0e5d0617 100644
> --- a/Documentation/acpi/namespace.txt
> +++ b/Documentation/firmware-guide/acpi/namespace.rst
> @@ -1,85 +1,88 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include::
> +
> +===
> ACPI Device Tree - Representation of ACPI Namespace
> +===
> +
> +:Copyright: |copy| 2013, Intel Corporation
> +
> +:Author: Lv Zheng
> +
> +:Abstract: The Linux ACPI subsystem converts ACPI namespace objects into a
> Linux
> + device tree under the /sys/devices/LNXSYSTEM:00 and updates it
> upon
> + receiving ACPI hotplug notification events. For each device
> object
> + in this hierarchy there is a corresponding symbolic link in the
> + /sys/bus/acpi/devices.
> + This document illustrates the structure of the ACPI device tree.
Well, this is a matter of preference. I would add Abstract as a chapter,
as this would make it part of the top index, with can be useful.
In any case:
Reviewed-by: Mauro Carvalho Chehab
> +
> +:Credit: Thanks for the help from Zhang Rui and
> + Rafael J.Wysocki .
> +
> +
> +ACPI Definition Blocks
> +==
> +
> +The ACPI firmware sets up RSDP (Root System Description Pointer) in the
> +system memory address space pointing to the XSDT (Extended System
> +Description Table). The XSDT always points to the FADT (Fixed ACPI
> +Description Table) using its first entry, the data within the FADT
> +includes various fixed-length entries that describe fixed ACPI features
> +of the hardware. The FADT contains a pointer to the DSDT
> +(Differentiated System Descripition Table). The XSDT also contains
> +entries pointing to possibly multiple SSDTs (Secondary System
> +Description Table).
> +
> +The DSDT and SSDT data is organized in data structures called definition
> +blocks that contain definitions of various objects, including ACPI
> +control methods, encoded in AML (ACPI Machine Language). The data block
> +of the DSDT along with the contents of SSDTs represents a hierarchical
> +data structure called the ACPI namespace whose topology reflects the
> +structure of the underlying hardware platform.
> +
> +The relationships between ACPI System Definition Tables described above
> +are illustrated in the following diagram::
> +
> + +-++---+++++
> + | RSDP | +->| XSDT | +->| FADT || +---+ |
> + +-+ | +---+ | ++ +-|->| DSDT| |
> + | Pointer | | | Entry |-+ | .. | | | +---+ |
> + +-+ | +---+| X_DSDT |--+ | | Definition Blocks | |
> + | Pointer |-+ | . || .. || +---+ |
> + +-++---+++| +---+ |
> + | Entry |--|->| SSDT| |
> + +- - - -+ | +---| |
> + | Entry | - - - - - - - -+ | | Definition Blocks | |
> + +- - - -+| | +---+ |
> + | | +- - - - - - - - - -+ |
> + +-|->| SSDT| |
> + | +---+ |
> + |
Re: [PATCH v4 04/63] Documentation: ACPI: move osi.txt to firmware-guide/acpi and convert to reST
Em Wed, 24 Apr 2019 00:28:33 +0800
Changbin Du escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du
> ---
> Documentation/firmware-guide/acpi/index.rst | 1 +
> .../{acpi/osi.txt => firmware-guide/acpi/osi.rst} | 15 +--
> 2 files changed, 10 insertions(+), 6 deletions(-)
> rename Documentation/{acpi/osi.txt => firmware-guide/acpi/osi.rst} (97%)
>
> diff --git a/Documentation/firmware-guide/acpi/index.rst
> b/Documentation/firmware-guide/acpi/index.rst
> index 99677c73f1fb..868bd25a3398 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -9,3 +9,4 @@ ACPI Support
>
> namespace
> enumeration
> + osi
> diff --git a/Documentation/acpi/osi.txt
> b/Documentation/firmware-guide/acpi/osi.rst
> similarity index 97%
> rename from Documentation/acpi/osi.txt
> rename to Documentation/firmware-guide/acpi/osi.rst
> index 50cde0ceb9b0..29e9ef79ebc0 100644
> --- a/Documentation/acpi/osi.txt
> +++ b/Documentation/firmware-guide/acpi/osi.rst
> @@ -1,5 +1,8 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==
> ACPI _OSI and _REV methods
> ---
> +==
You could probably do just the above, but changing the title
markups on the other files has the advantage of using the
same standard on all acpi files.
Either way, just looking at the conversion itself:
Reviewed-by: Mauro Carvalho Chehab
>
> An ACPI BIOS can use the "Operating System Interfaces" method (_OSI)
> to find out what the operating system supports. Eg. If BIOS
> @@ -14,7 +17,7 @@ This document explains how and why the BIOS and Linux
> should use these methods.
> It also explains how and why they are widely misused.
>
> How to use _OSI
>
> +===
>
> Linux runs on two groups of machines -- those that are tested by the OEM
> to be compatible with Linux, and those that were never tested with Linux,
> @@ -62,7 +65,7 @@ the string when that support is added to the kernel.
> That was easy. Read on, to find out how to do it wrong.
>
> Before _OSI, there was _OS
> ---
> +==
>
> ACPI 1.0 specified "_OS" as an
> "object that evaluates to a string that identifies the operating system."
> @@ -96,7 +99,7 @@ That is the *only* viable strategy, as that is what modern
> Windows does,
> and so doing otherwise could steer the BIOS down an untested path.
>
> _OSI is born, and immediately misused
> ---
> +=
>
> With _OSI, the *BIOS* provides the string describing an interface,
> and asks the OS: "YES/NO, are you compatible with this interface?"
> @@ -144,7 +147,7 @@ catastrophic failure resulting from the BIOS taking paths
> that
> were never validated under *any* OS.
>
> Do not use _REV
>
> +===
>
> Since _OSI("Linux") went away, some BIOS writers used _REV
> to support Linux and Windows differences in the same BIOS.
> @@ -164,7 +167,7 @@ from mid-2015 onward. The ACPI specification will also
> be updated
> to reflect that _REV is deprecated, and always returns 2.
>
> Apple Mac and _OSI("Darwin")
> -
> +
>
> On Apple's Mac platforms, the ACPI BIOS invokes _OSI("Darwin")
> to determine if the machine is running Apple OSX.
Thanks,
Mauro
[PATCH v2 33/79] docs: serial: convert docs to ReST and rename to *.rst
The converted files are focused at the Kernel internal API,
so, this is a good candidate for the kernel API set of books.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab
---
.../{README.cycladesZ => cyclades_z.rst} | 5 +-
Documentation/serial/{driver => driver.rst} | 115 +++-
Documentation/serial/index.rst| 32 +
Documentation/serial/moxa-smartio | 523 ---
Documentation/serial/moxa-smartio.rst | 615 ++
Documentation/serial/n_gsm.rst| 103 +++
Documentation/serial/n_gsm.txt| 96 ---
.../serial/{rocket.txt => rocket.rst} | 144 ++--
...{serial-iso7816.txt => serial-iso7816.rst} | 21 +-
.../{serial-rs485.txt => serial-rs485.rst}| 22 +-
Documentation/serial/{tty.txt => tty.rst} | 111 ++--
MAINTAINERS | 4 +-
drivers/tty/Kconfig | 4 +-
drivers/tty/serial/ucc_uart.c | 2 +-
include/linux/serial_core.h | 2 +-
15 files changed, 1011 insertions(+), 788 deletions(-)
rename Documentation/serial/{README.cycladesZ => cyclades_z.rst} (85%)
rename Documentation/serial/{driver => driver.rst} (92%)
create mode 100644 Documentation/serial/index.rst
delete mode 100644 Documentation/serial/moxa-smartio
create mode 100644 Documentation/serial/moxa-smartio.rst
create mode 100644 Documentation/serial/n_gsm.rst
delete mode 100644 Documentation/serial/n_gsm.txt
rename Documentation/serial/{rocket.txt => rocket.rst} (68%)
rename Documentation/serial/{serial-iso7816.txt => serial-iso7816.rst} (85%)
rename Documentation/serial/{serial-rs485.txt => serial-rs485.rst} (89%)
rename Documentation/serial/{tty.txt => tty.rst} (74%)
diff --git a/Documentation/serial/README.cycladesZ
b/Documentation/serial/cyclades_z.rst
similarity index 85%
rename from Documentation/serial/README.cycladesZ
rename to Documentation/serial/cyclades_z.rst
index 024a69443cc2..532ff67e2f1c 100644
--- a/Documentation/serial/README.cycladesZ
+++ b/Documentation/serial/cyclades_z.rst
@@ -1,8 +1,11 @@
+
+Cyclades-Z notes
+
The Cyclades-Z must have firmware loaded onto the card before it will
operate. This operation should be performed during system startup,
The firmware, loader program and the latest device driver code are
available from Cyclades at
+
ftp://ftp.cyclades.com/pub/cyclades/cyclades-z/linux/
-
diff --git a/Documentation/serial/driver b/Documentation/serial/driver.rst
similarity index 92%
rename from Documentation/serial/driver
rename to Documentation/serial/driver.rst
index 86e47c19a924..4537119bf624 100644
--- a/Documentation/serial/driver
+++ b/Documentation/serial/driver.rst
@@ -1,6 +1,6 @@
-
- Low Level Serial API
-
+
+Low Level Serial API
+
This document is meant as a brief overview of some aspects of the new serial
@@ -44,7 +44,7 @@ are described in the uart_ops listing below.)
There are two locks. A per-port spinlock, and an overall semaphore.
From the core driver perspective, the port->lock locks the following
-data:
+data::
port->mctrl
port->icount
@@ -75,41 +75,51 @@ hardware.
return TIOCSER_TEMT.
Locking: none.
+
Interrupts: caller dependent.
+
This call must not sleep
set_mctrl(port, mctrl)
This function sets the modem control lines for port described
by 'port' to the state described by mctrl. The relevant bits
of mctrl are:
+
- TIOCM_RTS RTS signal.
- TIOCM_DTR DTR signal.
- TIOCM_OUT1OUT1 signal.
- TIOCM_OUT2OUT2 signal.
- TIOCM_LOOPSet the port into loopback mode.
+
If the appropriate bit is set, the signal should be driven
active. If the bit is clear, the signal should be driven
inactive.
Locking: port->lock taken.
+
Interrupts: locally disabled.
+
This call must not sleep
get_mctrl(port)
Returns the current state of modem control inputs. The state
of the outputs should not be returned, since the core keeps
track of their state. The state information should include:
+
- TIOCM_CAR state of DCD signal
- TIOCM_CTS state of CTS signal
- TIOCM_DSR state of DSR signal
- TIOCM_RI state of RI signal
+
The bit is set if the signal
[PATCH v2 19/79] docs: kdump: convert docs to ReST and rename to *.rst
Convert kdump documentation to ReST and add it to the
user faced manual, as the documents are mainly focused on
sysadmins that would be enabling kdump.
Note: the vmcoreinfo.rst has one very long title on one of its
sub-sections:
PG_lru|PG_private|PG_swapcache|PG_swapbacked|PG_slab|PG_hwpoision|PG_head_mask|PAGE_BUDDY_MAPCOUNT_VALUE(~PG_buddy)|PAGE_OFFLINE_MAPCOUNT_VALUE(~PG_offline)
I opted to break this one, into two entries with the same content,
in order to make it easier to display after being parsed in html and PDF.
The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- adjust title markups.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/admin-guide/bug-hunting.rst | 2 +-
.../admin-guide/kernel-parameters.txt | 6 +-
Documentation/kdump/index.rst | 21 +++
Documentation/kdump/{kdump.txt => kdump.rst} | 131 +++---
.../kdump/{vmcoreinfo.txt => vmcoreinfo.rst} | 59
.../powerpc/firmware-assisted-dump.txt| 2 +-
.../translations/zh_CN/oops-tracing.txt | 2 +-
Documentation/watchdog/hpwdt.txt | 2 +-
arch/arm/Kconfig | 2 +-
arch/arm64/Kconfig| 2 +-
arch/sh/Kconfig | 2 +-
arch/x86/Kconfig | 4 +-
12 files changed, 137 insertions(+), 98 deletions(-)
create mode 100644 Documentation/kdump/index.rst
rename Documentation/kdump/{kdump.txt => kdump.rst} (91%)
rename Documentation/kdump/{vmcoreinfo.txt => vmcoreinfo.rst} (95%)
diff --git a/Documentation/admin-guide/bug-hunting.rst
b/Documentation/admin-guide/bug-hunting.rst
index f278b289e260..b761aa2a51d2 100644
--- a/Documentation/admin-guide/bug-hunting.rst
+++ b/Documentation/admin-guide/bug-hunting.rst
@@ -90,7 +90,7 @@ the disk is not available then you have three options:
run a null modem to a second machine and capture the output there
using your favourite communication program. Minicom works well.
-(3) Use Kdump (see Documentation/kdump/kdump.txt),
+(3) Use Kdump (see Documentation/kdump/kdump.rst),
extract the kernel ring buffer from old memory with using dmesg
gdbmacro in Documentation/kdump/gdbmacros.txt.
diff --git a/Documentation/admin-guide/kernel-parameters.txt
b/Documentation/admin-guide/kernel-parameters.txt
index bfe926a7b15f..a4e8e6435fff 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -705,14 +705,14 @@
memory region [offset, offset + size] for that kernel
image. If '@offset' is omitted, then a suitable offset
is selected automatically. Check
- Documentation/kdump/kdump.txt for further details.
+ Documentation/kdump/kdump.rst for further details.
crashkernel=range1:size1[,range2:size2,...][@offset]
[KNL] Same as above, but depends on the memory
in the running system. The syntax of range is
start-[end] where start and end are both
a memory unit (amount[KMG]). See also
- Documentation/kdump/kdump.txt for an example.
+ Documentation/kdump/kdump.rst for an example.
crashkernel=size[KMG],high
[KNL, x86_64] range could be above 4G. Allow kernel
@@ -1206,7 +1206,7 @@
Specifies physical address of start of kernel core
image elf header and optionally the size. Generally
kexec loader will pass this option to capture kernel.
- See Documentation/kdump/kdump.txt for details.
+ See Documentation/kdump/kdump.rst for details.
enable_mtrr_cleanup [X86]
The kernel tries to adjust MTRR layout from continuous
diff --git a/Documentation/kdump/index.rst b/Documentation/kdump/index.rst
new file mode 100644
index ..2b17fcf6867a
--- /dev/null
+++ b/Documentation/kdump/index.rst
@@ -0,0 +1,21 @@
+:orphan:
+
+
+Documentation for Kdump - The kexec-based Crash Dumping Solution
+
+
+This document includes overview, setup and installation, and analysis
+information.
+
+.. toctree::
+:maxdepth: 1
+
+kdump
+vmcoreinfo
+
+.. only:: subproject and html
+
+ Indices
+ ===
+
+ * :ref:`genindex`
diff --git a/Documentation/kdump/kdump.txt b/Documentation/kdump/kdump.rst
similar
[PATCH v2 26/79] docs: powerpc: convert docs to ReST and rename to *.rst
Convert docs to ReST and add them to the arch-specific
book.
The conversion here was trivial, as almost every file there
was already using an elegant format close to ReST standard.
The changes were mostly to mark literal blocks and add a few
missing section title identifiers.
One note with regards to "--": on Sphinx, this can't be used
to identify a list, as it will format it badly. This can be
used, however, to identify a long hyphen - and "---" is an
even longer one.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/PCI/pci-error-recovery.txt | 2 +-
.../{bootwrapper.txt => bootwrapper.rst} | 28 +++-
.../{cpu_families.txt => cpu_families.rst}| 23 +--
.../{cpu_features.txt => cpu_features.rst}| 6 +-
Documentation/powerpc/{cxl.txt => cxl.rst}| 46 --
.../powerpc/{cxlflash.txt => cxlflash.rst}| 10 +-
.../{DAWR-POWER9.txt => dawr-power9.rst} | 10 +-
Documentation/powerpc/{dscr.txt => dscr.rst} | 18 +-
...ecovery.txt => eeh-pci-error-recovery.rst} | 108 ++--
...ed-dump.txt => firmware-assisted-dump.rst} | 117 +++--
Documentation/powerpc/{hvcs.txt => hvcs.rst} | 108 ++--
Documentation/powerpc/index.rst | 34
Documentation/powerpc/isa-versions.rst| 13 +-
.../powerpc/{mpc52xx.txt => mpc52xx.rst} | 12 +-
...nv.txt => pci_iov_resource_on_powernv.rst} | 15 +-
.../powerpc/{pmu-ebb.txt => pmu-ebb.rst} | 1 +
Documentation/powerpc/ptrace.rst | 156 ++
Documentation/powerpc/ptrace.txt | 151 -
.../{qe_firmware.txt => qe_firmware.rst} | 37 +++--
.../{syscall64-abi.txt => syscall64-abi.rst} | 29 ++--
...al_memory.txt => transactional_memory.rst} | 45 ++---
MAINTAINERS | 6 +-
arch/powerpc/kernel/exceptions-64s.S | 2 +-
drivers/soc/fsl/qe/qe.c | 2 +-
drivers/tty/hvc/hvcs.c| 2 +-
include/soc/fsl/qe/qe.h | 2 +-
26 files changed, 559 insertions(+), 424 deletions(-)
rename Documentation/powerpc/{bootwrapper.txt => bootwrapper.rst} (93%)
rename Documentation/powerpc/{cpu_families.txt => cpu_families.rst} (95%)
rename Documentation/powerpc/{cpu_features.txt => cpu_features.rst} (97%)
rename Documentation/powerpc/{cxl.txt => cxl.rst} (95%)
rename Documentation/powerpc/{cxlflash.txt => cxlflash.rst} (98%)
rename Documentation/powerpc/{DAWR-POWER9.txt => dawr-power9.rst} (95%)
rename Documentation/powerpc/{dscr.txt => dscr.rst} (91%)
rename Documentation/powerpc/{eeh-pci-error-recovery.txt =>
eeh-pci-error-recovery.rst} (82%)
rename Documentation/powerpc/{firmware-assisted-dump.txt =>
firmware-assisted-dump.rst} (80%)
rename Documentation/powerpc/{hvcs.txt => hvcs.rst} (91%)
create mode 100644 Documentation/powerpc/index.rst
rename Documentation/powerpc/{mpc52xx.txt => mpc52xx.rst} (91%)
rename Documentation/powerpc/{pci_iov_resource_on_powernv.txt =>
pci_iov_resource_on_powernv.rst} (97%)
rename Documentation/powerpc/{pmu-ebb.txt => pmu-ebb.rst} (99%)
create mode 100644 Documentation/powerpc/ptrace.rst
delete mode 100644 Documentation/powerpc/ptrace.txt
rename Documentation/powerpc/{qe_firmware.txt => qe_firmware.rst} (95%)
rename Documentation/powerpc/{syscall64-abi.txt => syscall64-abi.rst} (82%)
rename Documentation/powerpc/{transactional_memory.txt =>
transactional_memory.rst} (93%)
diff --git a/Documentation/PCI/pci-error-recovery.txt
b/Documentation/PCI/pci-error-recovery.txt
index 0b6bb3ef449e..1ba6a89cf92f 100644
--- a/Documentation/PCI/pci-error-recovery.txt
+++ b/Documentation/PCI/pci-error-recovery.txt
@@ -389,7 +389,7 @@ platforms aren't supposed to share interrupts between many
devices
anyway :)
>>> Implementation details for the powerpc platform are discussed in
->>> the file Documentation/powerpc/eeh-pci-error-recovery.txt
+>>> the file Documentation/powerpc/eeh-pci-error-recovery.rst
>>> As of this writing, there is a growing list of device drivers with
>>> patches implementing error recovery. Not all of these patches are in
diff --git a/Documentation/powerpc/bootwrapper.txt
b/Documentation/powerpc/bootwrapper.rst
similarity index 93%
rename from Documentation/powerpc/bootwrapper.txt
rename to Documentation/powerpc/bootwrapper.rst
index d60fced5e1cc..a6292afba573 100644
--- a/Documentation/powerpc/bootwrapper.txt
+++ b/Documentation/powerpc/bootwrapper.rst
@@ -1,5 +1,7 @@
+
The PowerPC boot wrapper
-
+
+
Copyright (C) Secret Lab Technologies Ltd.
PowerPC image targets compresses and wra
[PATCH 01/14] docs: powerpc: convert docs to ReST and rename to *.rst
Convert docs to ReST and add them to the arch-specific
book.
The conversion here was trivial, as almost every file there
was already using an elegant format close to ReST standard.
The changes were mostly to mark literal blocks and add a few
missing section title identifiers.
One note with regards to "--": on Sphinx, this can't be used
to identify a list, as it will format it badly. This can be
used, however, to identify a long hyphen - and "---" is an
even longer one.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab
Acked-by: Andrew Donnellan # cxl
---
Documentation/PCI/pci-error-recovery.rst | 5 +-
Documentation/index.rst | 1 +
.../{bootwrapper.txt => bootwrapper.rst} | 28 +++-
.../{cpu_families.txt => cpu_families.rst}| 23 +--
.../{cpu_features.txt => cpu_features.rst}| 6 +-
Documentation/powerpc/{cxl.txt => cxl.rst}| 46 --
.../powerpc/{cxlflash.txt => cxlflash.rst}| 10 +-
.../{DAWR-POWER9.txt => dawr-power9.rst} | 15 +-
Documentation/powerpc/{dscr.txt => dscr.rst} | 18 +-
...ecovery.txt => eeh-pci-error-recovery.rst} | 108 ++--
...ed-dump.txt => firmware-assisted-dump.rst} | 117 +++--
Documentation/powerpc/{hvcs.txt => hvcs.rst} | 108 ++--
Documentation/powerpc/index.rst | 34
Documentation/powerpc/isa-versions.rst| 15 +-
.../powerpc/{mpc52xx.txt => mpc52xx.rst} | 12 +-
...nv.txt => pci_iov_resource_on_powernv.rst} | 15 +-
.../powerpc/{pmu-ebb.txt => pmu-ebb.rst} | 1 +
Documentation/powerpc/ptrace.rst | 156 ++
Documentation/powerpc/ptrace.txt | 151 -
.../{qe_firmware.txt => qe_firmware.rst} | 37 +++--
.../{syscall64-abi.txt => syscall64-abi.rst} | 29 ++--
...al_memory.txt => transactional_memory.rst} | 45 ++---
MAINTAINERS | 6 +-
arch/powerpc/kernel/exceptions-64s.S | 2 +-
drivers/soc/fsl/qe/qe.c | 2 +-
drivers/tty/hvc/hvcs.c| 2 +-
include/soc/fsl/qe/qe.h | 2 +-
27 files changed, 567 insertions(+), 427 deletions(-)
rename Documentation/powerpc/{bootwrapper.txt => bootwrapper.rst} (93%)
rename Documentation/powerpc/{cpu_families.txt => cpu_families.rst} (95%)
rename Documentation/powerpc/{cpu_features.txt => cpu_features.rst} (97%)
rename Documentation/powerpc/{cxl.txt => cxl.rst} (95%)
rename Documentation/powerpc/{cxlflash.txt => cxlflash.rst} (98%)
rename Documentation/powerpc/{DAWR-POWER9.txt => dawr-power9.rst} (95%)
rename Documentation/powerpc/{dscr.txt => dscr.rst} (91%)
rename Documentation/powerpc/{eeh-pci-error-recovery.txt =>
eeh-pci-error-recovery.rst} (82%)
rename Documentation/powerpc/{firmware-assisted-dump.txt =>
firmware-assisted-dump.rst} (80%)
rename Documentation/powerpc/{hvcs.txt => hvcs.rst} (91%)
create mode 100644 Documentation/powerpc/index.rst
rename Documentation/powerpc/{mpc52xx.txt => mpc52xx.rst} (91%)
rename Documentation/powerpc/{pci_iov_resource_on_powernv.txt =>
pci_iov_resource_on_powernv.rst} (97%)
rename Documentation/powerpc/{pmu-ebb.txt => pmu-ebb.rst} (99%)
create mode 100644 Documentation/powerpc/ptrace.rst
delete mode 100644 Documentation/powerpc/ptrace.txt
rename Documentation/powerpc/{qe_firmware.txt => qe_firmware.rst} (95%)
rename Documentation/powerpc/{syscall64-abi.txt => syscall64-abi.rst} (82%)
rename Documentation/powerpc/{transactional_memory.txt =>
transactional_memory.rst} (93%)
diff --git a/Documentation/PCI/pci-error-recovery.rst
b/Documentation/PCI/pci-error-recovery.rst
index 83db42092935..e5d450df06b4 100644
--- a/Documentation/PCI/pci-error-recovery.rst
+++ b/Documentation/PCI/pci-error-recovery.rst
@@ -403,7 +403,7 @@ That is, the recovery API only requires that:
.. note::
Implementation details for the powerpc platform are discussed in
- the file Documentation/powerpc/eeh-pci-error-recovery.txt
+ the file Documentation/powerpc/eeh-pci-error-recovery.rst
As of this writing, there is a growing list of device drivers with
patches implementing error recovery. Not all of these patches are in
@@ -422,3 +422,6 @@ That is, the recovery API only requires that:
- drivers/net/cxgb3
- drivers/net/s2io.c
- drivers/net/qlge
+
+The End
+---
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 70ae148ec980..3fe6170aa41d 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -143,6 +143,7 @@ implementation.
arm64/index
ia64/index
m68k/index
+ powerpc/index
riscv/index
s390/index
sh/index
diff --git a/Documentation/powerpc/bootwrapper.txt
b/Documentation/po
[PATCH 00/14] pending doc patches for 5.3-rc
Those are the pending documentation patches after my pull request
for this branch:
git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media.git
tags/docs/v5.3-1
Patches 1 to 13 were already submitted, but got rebased. Patch 14
is a new fixup one.
Patches 1 and 2 weren't submitted before due to merge conflicts
that are now solved upstream;
Patch 3 fixes a series of random Documentation/* references that
are pointing to the wrong places.
Patch 4 fix a longstanding issue: every time a new book is added,
conf.py need changes, in order to allow generating a PDF file.
After the patch, conf.py will automatically recognize new books,
saving the trouble of keeping adding documents to it.
Patches 5 to 11 are due to fonts support when building translations.pdf.
The main focus is to add xeCJK support. While doing it, I discovered
some bugs at sphinx-pre-install script after running it with 7 different
distributions.
Patch 12 improves support for partial doc building. Currently, each
subdir needs to have its own conf.py, in order to support partial
doc build. After it, any Documentation subdir can be used to
roduce html/pdf docs with:
make SPHINXDIRS="foo bar" htmldocs
(or pdfdocs, latexdocs, epubdocs, ...)
Patch 13 is a cleanup patch: it simply get rid of all those extra
conf.py files that aren't needed anymore. The only extra config
file after it is this one:
Documentation/media/conf_nitpick.py
With enables some extra optional Sphinx features.
Patch 14 adds Documentation/virtual to the main index.rst file
and add a new *.rst file that was orphaned there.
-
After this series, there's just one more patch meant to be applied
for 5.3, with is still waiting for some patches to be merged from
linux-next:
https://git.linuxtv.org/mchehab/experimental.git/commit/?id=b1b5dc7d7bbfbbfdace2a248c6458301c6e34100
Mauro Carvalho Chehab (14):
docs: powerpc: convert docs to ReST and rename to *.rst
docs: power: add it to to the main documentation index
docs: fix broken doc references due to renames
docs: pdf: add all Documentation/*/index.rst to PDF output
docs: conf.py: add CJK package needed by translations
docs: conf.py: only use CJK if the font is available
scripts/sphinx-pre-install: fix script for RHEL/CentOS
scripts/sphinx-pre-install: don't use LaTeX with CentOS 7
scripts/sphinx-pre-install: fix latexmk dependencies
scripts/sphinx-pre-install: cleanup Gentoo checks
scripts/sphinx-pre-install: seek for Noto CJK fonts for pdf output
docs: load_config.py: avoid needing a conf.py just due to LaTeX docs
docs: remove extra conf.py files
docs: virtual: add it to the documentation body
Documentation/PCI/pci-error-recovery.rst | 5 +-
Documentation/RCU/rculist_nulls.txt | 2 +-
Documentation/admin-guide/conf.py | 10 --
Documentation/conf.py | 30 +++-
Documentation/core-api/conf.py| 10 --
Documentation/crypto/conf.py | 10 --
Documentation/dev-tools/conf.py | 10 --
.../devicetree/bindings/arm/idle-states.txt | 2 +-
Documentation/doc-guide/conf.py | 10 --
Documentation/driver-api/80211/conf.py| 10 --
Documentation/driver-api/conf.py | 10 --
Documentation/driver-api/pm/conf.py | 10 --
Documentation/filesystems/conf.py | 10 --
Documentation/gpu/conf.py | 10 --
Documentation/index.rst | 3 +
Documentation/input/conf.py | 10 --
Documentation/kernel-hacking/conf.py | 10 --
Documentation/locking/spinlocks.rst | 4 +-
Documentation/maintainer/conf.py | 10 --
Documentation/media/conf.py | 12 --
Documentation/memory-barriers.txt | 2 +-
Documentation/networking/conf.py | 10 --
Documentation/power/index.rst | 2 +-
.../{bootwrapper.txt => bootwrapper.rst} | 28 +++-
.../{cpu_families.txt => cpu_families.rst}| 23 +--
.../{cpu_features.txt => cpu_features.rst}| 6 +-
Documentation/powerpc/{cxl.txt => cxl.rst}| 46 --
.../powerpc/{cxlflash.txt => cxlflash.rst}| 10 +-
.../{DAWR-POWER9.txt => dawr-power9.rst} | 15 +-
Documentation/powerpc/{dscr.txt => dscr.rst} | 18 +-
...ecovery.txt => eeh-pci-error-recovery.rst} | 108 ++--
...ed-dump.txt => firmware-assisted-dump.rst} | 117 +++--
Documentation/powerpc/{hvcs.txt => hvcs.rst} | 108 ++--
Documentation/powerpc/index.rst | 34
Documentation/powerpc/isa-versions.rst| 15 +-
.../powerpc/{mpc52xx.txt => mpc52xx.rst} | 12 +-
...nv.txt => pci_iov_resource_on_powernv.rst} | 15 +-
.../powerpc/{pmu-ebb.txt => pmu-ebb.rst} | 1 +
Documentation/powerpc/ptrace.rst | 156 ++
Do
[PATCH v4 12/15] docs: ABI: stable: make files ReST compatible
Several entries at the stable ABI files won't parse if we pass them directly to the ReST output. Adjust them, in order to allow adding their contents as-is at the stable ABI book. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/firewire-cdev| 4 + Documentation/ABI/stable/sysfs-acpi-pmprofile | 22 +++-- Documentation/ABI/stable/sysfs-bus-firewire | 3 + Documentation/ABI/stable/sysfs-bus-nvmem | 19 ++-- Documentation/ABI/stable/sysfs-bus-usb| 6 +- .../ABI/stable/sysfs-class-backlight | 1 + .../ABI/stable/sysfs-class-infiniband | 95 +-- Documentation/ABI/stable/sysfs-class-rfkill | 13 ++- Documentation/ABI/stable/sysfs-class-tpm | 90 +- Documentation/ABI/stable/sysfs-devices| 5 +- Documentation/ABI/stable/sysfs-driver-ib_srp | 1 + .../ABI/stable/sysfs-firmware-efi-vars| 4 + .../ABI/stable/sysfs-firmware-opal-dump | 5 + .../ABI/stable/sysfs-firmware-opal-elog | 2 + Documentation/ABI/stable/sysfs-hypervisor-xen | 3 + Documentation/ABI/stable/vdso | 5 +- Documentation/admin-guide/abi-stable.rst | 1 + 17 files changed, 179 insertions(+), 100 deletions(-) diff --git a/Documentation/ABI/stable/firewire-cdev b/Documentation/ABI/stable/firewire-cdev index f72ed653878a..c9e8ff026154 100644 --- a/Documentation/ABI/stable/firewire-cdev +++ b/Documentation/ABI/stable/firewire-cdev @@ -14,12 +14,14 @@ Description: Each /dev/fw* is associated with one IEEE 1394 node, which can be remote or local nodes. Operations on a /dev/fw* file have different scope: + - The 1394 node which is associated with the file: - Asynchronous request transmission - Get the Configuration ROM - Query node ID - Query maximum speed of the path between this node and local node + - The 1394 bus (i.e. "card") to which the node is attached to: - Isochronous stream transmission and reception - Asynchronous stream transmission and reception @@ -31,6 +33,7 @@ Description: manager - Query cycle time - Bus reset initiation, bus reset event reception + - All 1394 buses: - Allocation of IEEE 1212 address ranges on the local link layers, reception of inbound requests to such @@ -43,6 +46,7 @@ Description: userland implement different access permission models, some operations are restricted to /dev/fw* files that are associated with a local node: + - Addition of descriptors or directories to the local nodes' Configuration ROM - PHY packet transmission and reception diff --git a/Documentation/ABI/stable/sysfs-acpi-pmprofile b/Documentation/ABI/stable/sysfs-acpi-pmprofile index 964c7a8afb26..fd97d22b677f 100644 --- a/Documentation/ABI/stable/sysfs-acpi-pmprofile +++ b/Documentation/ABI/stable/sysfs-acpi-pmprofile @@ -6,17 +6,21 @@ Description: The ACPI pm_profile sysfs interface exports the platform power management (and performance) requirement expectations as provided by BIOS. The integer value is directly passed as retrieved from the FADT ACPI table. -Values: For possible values see ACPI specification: + +Values:For possible values see ACPI specification: 5.2.9 Fixed ACPI Description Table (FADT) Field: Preferred_PM_Profile Currently these values are defined by spec: - 0 Unspecified - 1 Desktop - 2 Mobile - 3 Workstation - 4 Enterprise Server - 5 SOHO Server - 6 Appliance PC - 7 Performance Server + + == = + 0 Unspecified + 1 Desktop + 2 Mobile + 3 Workstation + 4 Enterprise Server + 5 SOHO Server + 6 Appliance PC + 7 Performance Server >7 Reserved + == = diff --git a/Documentation/ABI/stable/sysfs-bus-firewire b/Documentation/ABI/stable/sysfs-bus-firewire index 41e5a0cd1e3e..9ac9eddb82ef 100644 --- a/Documentation/ABI/stable/sysfs-bus-firewire +++ b/Documentation/ABI/stable/sysfs-bus-firewire @@ -47,6 +47,7 @@ Description: IEEE 1394 node device attribute. Read-only and immutable. Values:1: The sysfs entry represents a local node (a co
[PATCH v3 14/20] docs: ABI: stable: make files ReST compatible
Several entries at the stable ABI files won't parse if we pass them directly to the ReST output. Adjust them, in order to allow adding their contents as-is at the stable ABI book. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/firewire-cdev| 4 + Documentation/ABI/stable/sysfs-acpi-pmprofile | 22 +++-- Documentation/ABI/stable/sysfs-bus-firewire | 3 + Documentation/ABI/stable/sysfs-bus-nvmem | 19 ++-- Documentation/ABI/stable/sysfs-bus-usb| 6 +- .../ABI/stable/sysfs-class-backlight | 1 + .../ABI/stable/sysfs-class-infiniband | 95 +-- Documentation/ABI/stable/sysfs-class-rfkill | 13 ++- Documentation/ABI/stable/sysfs-class-tpm | 90 +- Documentation/ABI/stable/sysfs-devices| 5 +- Documentation/ABI/stable/sysfs-driver-ib_srp | 1 + .../ABI/stable/sysfs-firmware-efi-vars| 4 + .../ABI/stable/sysfs-firmware-opal-dump | 5 + .../ABI/stable/sysfs-firmware-opal-elog | 2 + Documentation/ABI/stable/sysfs-hypervisor-xen | 3 + Documentation/ABI/stable/vdso | 5 +- 16 files changed, 178 insertions(+), 100 deletions(-) diff --git a/Documentation/ABI/stable/firewire-cdev b/Documentation/ABI/stable/firewire-cdev index f72ed653878a..c9e8ff026154 100644 --- a/Documentation/ABI/stable/firewire-cdev +++ b/Documentation/ABI/stable/firewire-cdev @@ -14,12 +14,14 @@ Description: Each /dev/fw* is associated with one IEEE 1394 node, which can be remote or local nodes. Operations on a /dev/fw* file have different scope: + - The 1394 node which is associated with the file: - Asynchronous request transmission - Get the Configuration ROM - Query node ID - Query maximum speed of the path between this node and local node + - The 1394 bus (i.e. "card") to which the node is attached to: - Isochronous stream transmission and reception - Asynchronous stream transmission and reception @@ -31,6 +33,7 @@ Description: manager - Query cycle time - Bus reset initiation, bus reset event reception + - All 1394 buses: - Allocation of IEEE 1212 address ranges on the local link layers, reception of inbound requests to such @@ -43,6 +46,7 @@ Description: userland implement different access permission models, some operations are restricted to /dev/fw* files that are associated with a local node: + - Addition of descriptors or directories to the local nodes' Configuration ROM - PHY packet transmission and reception diff --git a/Documentation/ABI/stable/sysfs-acpi-pmprofile b/Documentation/ABI/stable/sysfs-acpi-pmprofile index 964c7a8afb26..fd97d22b677f 100644 --- a/Documentation/ABI/stable/sysfs-acpi-pmprofile +++ b/Documentation/ABI/stable/sysfs-acpi-pmprofile @@ -6,17 +6,21 @@ Description: The ACPI pm_profile sysfs interface exports the platform power management (and performance) requirement expectations as provided by BIOS. The integer value is directly passed as retrieved from the FADT ACPI table. -Values: For possible values see ACPI specification: + +Values:For possible values see ACPI specification: 5.2.9 Fixed ACPI Description Table (FADT) Field: Preferred_PM_Profile Currently these values are defined by spec: - 0 Unspecified - 1 Desktop - 2 Mobile - 3 Workstation - 4 Enterprise Server - 5 SOHO Server - 6 Appliance PC - 7 Performance Server + + == = + 0 Unspecified + 1 Desktop + 2 Mobile + 3 Workstation + 4 Enterprise Server + 5 SOHO Server + 6 Appliance PC + 7 Performance Server >7 Reserved + == = diff --git a/Documentation/ABI/stable/sysfs-bus-firewire b/Documentation/ABI/stable/sysfs-bus-firewire index 41e5a0cd1e3e..9ac9eddb82ef 100644 --- a/Documentation/ABI/stable/sysfs-bus-firewire +++ b/Documentation/ABI/stable/sysfs-bus-firewire @@ -47,6 +47,7 @@ Description: IEEE 1394 node device attribute. Read-only and immutable. Values:1: The sysfs entry represents a local node (a controller card). + 0: The sysfs entry represents
[PATCH v2 00/26] ReST conversion of text files without .txt extension
This series converts the text files under Documentation with doesn't end
neither .txt or .rst and are not part of ABI or features.
This series is at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=rst_for_5_4_v3
And it is based on yesterday's upstream tree.
After this series, we have ~320 files left to be converted to ReST.
v2:
- Added 3 files submitted for v5.3 that weren't merged yet;
- markdown patch broken into two, per Rob's request;
- rebased on the top of upstream master branch
Mauro Carvalho Chehab (26):
docs: power: add it to to the main documentation index
docs: thermal: add it to the driver API
docs: powerpc: convert docs to ReST and rename to *.rst
docs: ubifs-authentication.md: convert to ReST
docs: writing-schema.md: convert from markdown to ReST
docs: i2c: convert to ReST and add to driver-api bookset
docs: w1: convert to ReST and add to the kAPI group of docs
spi: docs: convert to ReST and add it to the kABI bookset
docs: ipmb: place it at driver-api and convert to ReST
docs: packing: move it to core-api book and adjust markups
docs: admin-guide: add auxdisplay files to it after conversion to ReST
docs: README.buddha: convert to ReST and add to m68k book
docs: parisc: convert to ReST and add to documentation body
docs: openrisc: convert to ReST and add to documentation body
docs: isdn: convert to ReST and add to kAPI bookset
docs: fs: cifs: convert to ReST and add to admin-guide book
docs: fs: convert docs without extension to ReST
docs: fs: convert porting to ReST
docs: index.rst: don't use genindex for pdf output
docs: wimax: convert to ReST and add to admin-guide
docs: mips: add to the documentation body as ReST
docs: hwmon: pxe1610: convert to ReST format and add to the index
docs: nios2: add it to the main Documentation body
docs: net: convert two README files to ReST format
docs: rcu: convert some articles from html to ReST
docs: ABI: remove extension from sysfs-class-mic.txt
Documentation/ABI/stable/sysfs-bus-w1 |2 +-
.../ABI/stable/sysfs-driver-w1_ds28e04|4 +-
.../ABI/stable/sysfs-driver-w1_ds28ea00 |2 +-
.../{sysfs-class-mic.txt => sysfs-class-mic} |0
Documentation/PCI/pci-error-recovery.rst |2 +-
.../Data-Structures/Data-Structures.html | 1391 ---
.../Data-Structures/Data-Structures.rst | 1163 ++
...riods.html => Expedited-Grace-Periods.rst} | 949 ++---
.../Memory-Ordering/Tree-RCU-Diagram.html |9 -
...ring.html => Tree-RCU-Memory-Ordering.rst} | 1181 +++---
.../RCU/Design/Requirements/Requirements.html | 3330 -
.../RCU/Design/Requirements/Requirements.rst | 2662 +
Documentation/RCU/index.rst |5 +
Documentation/RCU/whatisRCU.txt |4 +-
.../auxdisplay/cfag12864b.rst}| 115 +-
.../admin-guide/auxdisplay/index.rst | 16 +
.../auxdisplay/ks0108.rst}| 53 +-
.../AUTHORS => admin-guide/cifs/authors.rst} | 64 +-
.../CHANGES => admin-guide/cifs/changes.rst} |4 +
Documentation/admin-guide/cifs/index.rst | 21 +
.../cifs/introduction.rst}|8 +
.../cifs/TODO => admin-guide/cifs/todo.rst} | 87 +-
.../README => admin-guide/cifs/usage.rst} | 560 +--
.../cifs/winucase_convert.pl |0
Documentation/admin-guide/index.rst |3 +
.../wimax/i2400m.rst} | 145 +-
Documentation/admin-guide/wimax/index.rst | 19 +
.../wimax/wimax.rst} | 36 +-
Documentation/core-api/index.rst |3 +-
.../{packing.txt => core-api/packing.rst} | 81 +-
.../devicetree/bindings/i2c/i2c-mux-gpmux.txt |2 +-
.../{writing-schema.md => writing-schema.rst} | 137 +-
Documentation/driver-api/dmaengine/index.rst |2 +-
Documentation/driver-api/index.rst|2 +
Documentation/driver-api/ipmb.rst |2 +-
Documentation/driver-api/soundwire/index.rst |2 +-
.../thermal/cpu-cooling-api.rst |0
.../thermal/exynos_thermal.rst|0
.../thermal/exynos_thermal_emulation.rst |0
.../{ => driver-api}/thermal/index.rst|2 +-
.../thermal/intel_powerclamp.rst |0
.../thermal/nouveau_thermal.rst |0
.../thermal/power_allocator.rst |0
.../{ => driver-api}/thermal/sysfs-api.rst| 12 +-
.../thermal/x86_pkg_temperature_thermal.rst |2 +-
...irectory-locking => directory-locking.rst} | 40 +-
Documentation/filesystems/index.rst |4 +
.../filesystems/{Locking => locking.rst} | 257 +-
.../nfs/{Exporting => exporting.rst} | 31 +-
.../filesystems/{porting => porting.rst} | 824 ++--
...entication.md => ubifs-authentication.rst} | 70 +-
Docu
[PATCH v2 03/26] docs: powerpc: convert docs to ReST and rename to *.rst
Convert docs to ReST and add them to the arch-specific
book.
The conversion here was trivial, as almost every file there
was already using an elegant format close to ReST standard.
The changes were mostly to mark literal blocks and add a few
missing section title identifiers.
One note with regards to "--": on Sphinx, this can't be used
to identify a list, as it will format it badly. This can be
used, however, to identify a long hyphen - and "---" is an
even longer one.
At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: Mauro Carvalho Chehab
Acked-by: Andrew Donnellan # cxl
---
Documentation/PCI/pci-error-recovery.rst | 2 +-
Documentation/index.rst | 1 +
.../{bootwrapper.txt => bootwrapper.rst} | 28 ++-
.../{cpu_families.txt => cpu_families.rst}| 23 +--
.../{cpu_features.txt => cpu_features.rst}| 6 +-
Documentation/powerpc/{cxl.txt => cxl.rst}| 46 +++--
.../powerpc/{cxlflash.txt => cxlflash.rst}| 10 +-
.../{DAWR-POWER9.txt => dawr-power9.rst} | 15 +-
Documentation/powerpc/{dscr.txt => dscr.rst} | 18 +-
...ecovery.txt => eeh-pci-error-recovery.rst} | 108 +--
...ed-dump.txt => firmware-assisted-dump.rst} | 117 ++--
Documentation/powerpc/{hvcs.txt => hvcs.rst} | 108 ++-
Documentation/powerpc/index.rst | 34
Documentation/powerpc/isa-versions.rst| 15 +-
.../powerpc/{mpc52xx.txt => mpc52xx.rst} | 12 +-
...nv.txt => pci_iov_resource_on_powernv.rst} | 15 +-
.../powerpc/{pmu-ebb.txt => pmu-ebb.rst} | 1 +
.../powerpc/{ptrace.txt => ptrace.rst}| 169 +-
.../{qe_firmware.txt => qe_firmware.rst} | 37 ++--
.../{syscall64-abi.txt => syscall64-abi.rst} | 29 +--
...al_memory.txt => transactional_memory.rst} | 45 ++---
MAINTAINERS | 6 +-
arch/powerpc/kernel/exceptions-64s.S | 2 +-
drivers/soc/fsl/qe/qe.c | 2 +-
drivers/tty/hvc/hvcs.c| 2 +-
include/soc/fsl/qe/qe.h | 2 +-
26 files changed, 495 insertions(+), 358 deletions(-)
rename Documentation/powerpc/{bootwrapper.txt => bootwrapper.rst} (93%)
rename Documentation/powerpc/{cpu_families.txt => cpu_families.rst} (95%)
rename Documentation/powerpc/{cpu_features.txt => cpu_features.rst} (97%)
rename Documentation/powerpc/{cxl.txt => cxl.rst} (95%)
rename Documentation/powerpc/{cxlflash.txt => cxlflash.rst} (98%)
rename Documentation/powerpc/{DAWR-POWER9.txt => dawr-power9.rst} (95%)
rename Documentation/powerpc/{dscr.txt => dscr.rst} (91%)
rename Documentation/powerpc/{eeh-pci-error-recovery.txt =>
eeh-pci-error-recovery.rst} (82%)
rename Documentation/powerpc/{firmware-assisted-dump.txt =>
firmware-assisted-dump.rst} (80%)
rename Documentation/powerpc/{hvcs.txt => hvcs.rst} (91%)
create mode 100644 Documentation/powerpc/index.rst
rename Documentation/powerpc/{mpc52xx.txt => mpc52xx.rst} (91%)
rename Documentation/powerpc/{pci_iov_resource_on_powernv.txt =>
pci_iov_resource_on_powernv.rst} (97%)
rename Documentation/powerpc/{pmu-ebb.txt => pmu-ebb.rst} (99%)
rename Documentation/powerpc/{ptrace.txt => ptrace.rst} (48%)
rename Documentation/powerpc/{qe_firmware.txt => qe_firmware.rst} (95%)
rename Documentation/powerpc/{syscall64-abi.txt => syscall64-abi.rst} (82%)
rename Documentation/powerpc/{transactional_memory.txt =>
transactional_memory.rst} (93%)
diff --git a/Documentation/PCI/pci-error-recovery.rst
b/Documentation/PCI/pci-error-recovery.rst
index 83db42092935..69800a9d1b0d 100644
--- a/Documentation/PCI/pci-error-recovery.rst
+++ b/Documentation/PCI/pci-error-recovery.rst
@@ -403,7 +403,7 @@ That is, the recovery API only requires that:
.. note::
Implementation details for the powerpc platform are discussed in
- the file Documentation/powerpc/eeh-pci-error-recovery.txt
+ the file Documentation/powerpc/eeh-pci-error-recovery.rst
As of this writing, there is a growing list of device drivers with
patches implementing error recovery. Not all of these patches are in
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 230e550e9741..68ae2a4d689d 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -144,6 +144,7 @@ implementation.
arm64/index
ia64/index
m68k/index
+ powerpc/index
riscv/index
s390/index
sh/index
diff --git a/Documentation/powerpc/bootwrapper.txt
b/Documentation/powerpc/bootwrapper.rst
similarity index 93%
rename from Documentation/powerpc/bootwrapper.txt
rename to Documentation/powerpc/bootwrapper.rst
index d60fced5e1cc..a6292afba573 100644
--- a/Documentation/powerpc/bootw
Re: [PATCH v2 00/26] ReST conversion of text files without .txt extension
Em Fri, 26 Jul 2019 09:51:10 -0300 Mauro Carvalho Chehab escreveu: > This series converts the text files under Documentation with doesn't end > neither .txt or .rst and are not part of ABI or features. > > This series is at: > https://git.linuxtv.org/mchehab/experimental.git/log/?h=rst_for_5_4_v3 > > And it is based on yesterday's upstream tree. > > After this series, we have ~320 files left to be converted to ReST. > > v2: > - Added 3 files submitted for v5.3 that weren't merged yet; > - markdown patch broken into two, per Rob's request; > - rebased on the top of upstream master branch > > Mauro Carvalho Chehab (26): > docs: ABI: remove extension from sysfs-class-mic.txt ^ In time: this one was already merged. Thanks, Mauro
Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it
Em Fri, 5 Jul 2019 13:59:04 +0800
Dave Young escreveu:
> On 07/05/19 at 11:43am, Alex Shi wrote:
> >
> >
> > 在 2019/6/28 下午8:30, Mauro Carvalho Chehab 写道:
> > > The Kdump documentation describes procedures with admins use
> > > in order to solve issues on their systems.
> > >
> > > Signed-off-by: Mauro Carvalho Chehab
> > > ---
> > > Documentation/admin-guide/bug-hunting.rst| 4 ++--
> > > Documentation/admin-guide/index.rst | 1 +
> > > Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0
> > > Documentation/{ => admin-guide}/kdump/index.rst | 1 -
> > > Documentation/{ => admin-guide}/kdump/kdump.rst | 0
> > > Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0
> >
> > I am not sure if it's convenience for people to have more levels in docs.
> >
> > But I guess, move archs into a Documentation/arch/ dir should be fine. like
> > Documentation/arch/{x86,arm,arm64,ia64,m68k,s390,powerpc,...}
>
> Alex, moving kdump to admin-guide sounds reasonable to me. I also agree
> with you for those arch dependent files can be moved to
> Documentation/arch/, maybe you are talking about some other patches in
> the series for the arch/?
Alex,
It makes sense for me to have a Documentation/arch directory, and place
the arch-specific docs over there.
There's actually a technical advantage on doing that: Sphinx is dumb
with regards to PDF/LaTeX output: it requires all top documents to be
listed at Documentation/conf.py, under this var:
latex_documents = [
...
]
As it creates one runtime Makefile at Documentation/output per listed
document there. So, the more we group such documents, the less merge
conflicts we'll have at Documentation/conf.py.
Btw, there's a [TECH TOPIC] proposal for KS/2019 meant to discuss
Documentation.
I suspect we could discuss the pros/cons of doing such change there.
My personal view is that we should keep the Documentation/ root dir as
clean as possible as a long term goal.
On the other hand, it makes the path bigger and harder to rename.
On a side note, last time we discussed documentation at KS I remember
I proposed to shortcut "Documentation/" to just "docs/". The consensus
on that time were to keep the big name. I still think that a shorter
one could help people to remind where documentation will be located.
Thanks,
Mauro
[PATCH v3 14/18] docs: powerpc: convert vcpudispatch_stats.txt to ReST
- Add a SPDX header;
- Use standard markup for document title;
- Adjust identation on lists and add blank lines where
needed;
- Add it to the powerpc index.rst file.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/powerpc/index.rst | 1 +
...ispatch_stats.txt => vcpudispatch_stats.rst} | 17 -
2 files changed, 13 insertions(+), 5 deletions(-)
rename Documentation/powerpc/{vcpudispatch_stats.txt =>
vcpudispatch_stats.rst} (94%)
diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst
index 0d45f0fc8e57..29b90b1b6f20 100644
--- a/Documentation/powerpc/index.rst
+++ b/Documentation/powerpc/index.rst
@@ -30,6 +30,7 @@ powerpc
syscall64-abi
transactional_memory
ultravisor
+vcpudispatch_stats
.. only:: subproject and html
diff --git a/Documentation/powerpc/vcpudispatch_stats.txt
b/Documentation/powerpc/vcpudispatch_stats.rst
similarity index 94%
rename from Documentation/powerpc/vcpudispatch_stats.txt
rename to Documentation/powerpc/vcpudispatch_stats.rst
index e21476bfd78c..5704657a5987 100644
--- a/Documentation/powerpc/vcpudispatch_stats.txt
+++ b/Documentation/powerpc/vcpudispatch_stats.rst
@@ -1,5 +1,8 @@
-VCPU Dispatch Statistics:
-=
+.. SPDX-License-Identifier: GPL-2.0
+
+
+VCPU Dispatch Statistics
+
For Shared Processor LPARs, the POWER Hypervisor maintains a relatively
static mapping of the LPAR processors (vcpus) to physical processor
@@ -20,25 +23,29 @@ The statistics themselves are available by reading the
procfs file
a vcpu as represented by the first field, followed by 8 numbers.
The first number corresponds to:
+
1. total vcpu dispatches since the beginning of statistics collection
The next 4 numbers represent vcpu dispatch dispersions:
+
2. number of times this vcpu was dispatched on the same processor as last
time
3. number of times this vcpu was dispatched on a different processor core
as last time, but within the same chip
4. number of times this vcpu was dispatched on a different chip
5. number of times this vcpu was dispatches on a different socket/drawer
-(next numa boundary)
+ (next numa boundary)
The final 3 numbers represent statistics in relation to the home node of
the vcpu:
+
6. number of times this vcpu was dispatched in its home node (chip)
7. number of times this vcpu was dispatched in a different node
8. number of times this vcpu was dispatched in a node further away (numa
-distance)
+ distance)
+
+An example output::
-An example output:
$ sudo cat /proc/powerpc/vcpudispatch_stats
cpu0 6839 4126 2683 30 0 6821 18 0
cpu1 2515 1274 1229 12 0 2509 6 0
--
2.24.1
[PATCH v2 21/24] docs: powerpc: convert vcpudispatch_stats.txt to ReST
- Add a SPDX header;
- Use standard markup for document title;
- Adjust identation on lists and add blank lines where
needed;
- Add it to the powerpc index.rst file.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/powerpc/index.rst | 1 +
...ispatch_stats.txt => vcpudispatch_stats.rst} | 17 -
2 files changed, 13 insertions(+), 5 deletions(-)
rename Documentation/powerpc/{vcpudispatch_stats.txt =>
vcpudispatch_stats.rst} (94%)
diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst
index 0d45f0fc8e57..29b90b1b6f20 100644
--- a/Documentation/powerpc/index.rst
+++ b/Documentation/powerpc/index.rst
@@ -30,6 +30,7 @@ powerpc
syscall64-abi
transactional_memory
ultravisor
+vcpudispatch_stats
.. only:: subproject and html
diff --git a/Documentation/powerpc/vcpudispatch_stats.txt
b/Documentation/powerpc/vcpudispatch_stats.rst
similarity index 94%
rename from Documentation/powerpc/vcpudispatch_stats.txt
rename to Documentation/powerpc/vcpudispatch_stats.rst
index e21476bfd78c..5704657a5987 100644
--- a/Documentation/powerpc/vcpudispatch_stats.txt
+++ b/Documentation/powerpc/vcpudispatch_stats.rst
@@ -1,5 +1,8 @@
-VCPU Dispatch Statistics:
-=
+.. SPDX-License-Identifier: GPL-2.0
+
+
+VCPU Dispatch Statistics
+
For Shared Processor LPARs, the POWER Hypervisor maintains a relatively
static mapping of the LPAR processors (vcpus) to physical processor
@@ -20,25 +23,29 @@ The statistics themselves are available by reading the
procfs file
a vcpu as represented by the first field, followed by 8 numbers.
The first number corresponds to:
+
1. total vcpu dispatches since the beginning of statistics collection
The next 4 numbers represent vcpu dispatch dispersions:
+
2. number of times this vcpu was dispatched on the same processor as last
time
3. number of times this vcpu was dispatched on a different processor core
as last time, but within the same chip
4. number of times this vcpu was dispatched on a different chip
5. number of times this vcpu was dispatches on a different socket/drawer
-(next numa boundary)
+ (next numa boundary)
The final 3 numbers represent statistics in relation to the home node of
the vcpu:
+
6. number of times this vcpu was dispatched in its home node (chip)
7. number of times this vcpu was dispatched in a different node
8. number of times this vcpu was dispatched in a node further away (numa
-distance)
+ distance)
+
+An example output::
-An example output:
$ sudo cat /proc/powerpc/vcpudispatch_stats
cpu0 6839 4126 2683 30 0 6821 18 0
cpu1 2515 1274 1229 12 0 2509 6 0
--
2.24.1
[PATCH v2 00/24] Manually convert thermal, crypto and misc devices to ReST
Manually convert some files from thermal, crypto and misc-devices
to ReST format.
This patch is against linux-next 20200217 tag.
v2:
- a small change at patch 2 to avoid uneeded whitespace changes;
- added 13 new patches at the end
Mauro Carvalho Chehab (24):
docs: thermal: convert cpu-idle-cooling.rst to ReST
docs: crypto: convert asymmetric-keys.txt to ReST
docs: crypto: convert api-intro.txt to ReST format
docs: crypto: convert async-tx-api.txt to ReST format
docs: crypto: descore-readme.txt: convert to ReST format
docs: misc-devices/spear-pcie-gadget.txt: convert to ReST
docs: misc-devices/pci-endpoint-test.txt: convert to ReST
docs: misc-devices/pci-endpoint-test.txt: convert to ReST
docs: misc-devices/c2port.txt: convert to ReST format
docs: misc-devices/bh1770glc.txt: convert to ReST
docs: misc-devices/apds990x.txt: convert to ReST format
docs: pci: endpoint/function/binding/pci-test.txt convert to ReST
docs: arm64: convert perf.txt to ReST format
docs: cpu-freq: convert index.txt to ReST
docs: cpu-freq: convert amd-powernow.txt to ReST
docs: cpu-freq: convert core.txt to ReST
docs: cpu-freq: convert cpu-drivers.txt to ReST
docs: cpu-freq: convert cpufreq-nforce2.txt to ReST
docs: cpu-freq: convert cpufreq-stats.txt to ReST
docs: cpu-freq: convert pcc-cpufreq.txt to ReST
docs: powerpc: convert vcpudispatch_stats.txt to ReST
docs: sh: convert new-machine.txt to ReST
docs: sh: convert register-banks.txt to ReST
docs: trace: ring-buffer-design.txt: convert to ReST format
.../endpoint/function/binding/pci-test.rst| 26 +
.../endpoint/function/binding/pci-test.txt| 19 -
Documentation/PCI/endpoint/index.rst | 2 +
Documentation/arm64/index.rst | 1 +
Documentation/arm64/{perf.txt => perf.rst}| 7 +-
.../{amd-powernow.txt => amd-powernow.rst}| 12 +-
Documentation/cpu-freq/{core.txt => core.rst} | 65 +-
.../{cpu-drivers.txt => cpu-drivers.rst} | 129 ++-
...pufreq-nforce2.txt => cpufreq-nforce2.rst} | 18 +-
.../{cpufreq-stats.txt => cpufreq-stats.rst} | 121 +--
Documentation/cpu-freq/index.rst | 42 +
Documentation/cpu-freq/index.txt | 56 --
.../{pcc-cpufreq.txt => pcc-cpufreq.rst} | 86 +-
.../crypto/{api-intro.txt => api-intro.rst} | 186 ++--
...symmetric-keys.txt => asymmetric-keys.rst} | 91 +-
.../{async-tx-api.txt => async-tx-api.rst}| 253 +++---
...{descore-readme.txt => descore-readme.rst} | 152 +++-
Documentation/crypto/index.rst| 5 +
.../driver-api/thermal/cpu-idle-cooling.rst | 18 +-
Documentation/driver-api/thermal/index.rst| 1 +
Documentation/index.rst | 1 +
.../{ad525x_dpot.txt => ad525x_dpot.rst} | 24 +-
.../{apds990x.txt => apds990x.rst}| 31 +-
.../{bh1770glc.txt => bh1770glc.rst} | 45 +-
.../misc-devices/{c2port.txt => c2port.rst} | 58 +-
Documentation/misc-devices/index.rst | 6 +
.../misc-devices/pci-endpoint-test.rst| 56 ++
.../misc-devices/pci-endpoint-test.txt| 41 -
.../misc-devices/spear-pcie-gadget.rst| 170
.../misc-devices/spear-pcie-gadget.txt| 130 ---
Documentation/powerpc/index.rst | 1 +
...patch_stats.txt => vcpudispatch_stats.rst} | 17 +-
Documentation/sh/index.rst| 6 +
.../sh/{new-machine.txt => new-machine.rst} | 193 +++--
...{register-banks.txt => register-banks.rst} | 12 +-
Documentation/trace/index.rst | 1 +
...ffer-design.txt => ring-buffer-design.rst} | 802 ++
37 files changed, 1603 insertions(+), 1281 deletions(-)
create mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.rst
delete mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.txt
rename Documentation/arm64/{perf.txt => perf.rst} (95%)
rename Documentation/cpu-freq/{amd-powernow.txt => amd-powernow.rst} (89%)
rename Documentation/cpu-freq/{core.txt => core.rst} (69%)
rename Documentation/cpu-freq/{cpu-drivers.txt => cpu-drivers.rst} (72%)
rename Documentation/cpu-freq/{cpufreq-nforce2.txt => cpufreq-nforce2.rst}
(55%)
rename Documentation/cpu-freq/{cpufreq-stats.txt => cpufreq-stats.rst} (53%)
create mode 100644 Documentation/cpu-freq/index.rst
delete mode 100644 Documentation/cpu-freq/index.txt
rename Documentation/cpu-freq/{pcc-cpufreq.txt => pcc-cpufreq.rst} (80%)
rename Documentation/crypto/{api-intro.txt => api-intro.rst} (70%)
rename Documentation/crypto/{asymmetric-keys.txt => asymmetric-keys.rst} (91%)
rename Documentation/crypto/{async-tx-api.txt => async-tx-api.rst} (55%)
rename Documentation/crypto/{descore-readme.txt => descore-readme.rst} (81%)
rename Documentation/misc-devices/{ad525x_dpot.txt => ad525x_dpot.rst} (85%)
rename Documentation/misc-devices/{apds990x.txt => apds9
[PATCH 3/7] docs: fix broken references to text files
Several references got broken due to txt to ReST conversion. Several of them can be automatically fixed with: scripts/documentation-file-ref-check --fix Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/kernel-parameters.txt | 10 +- Documentation/filesystems/cifs/cifsroot.txt | 2 +- Documentation/memory-barriers.txt| 2 +- Documentation/process/submit-checklist.rst | 2 +- .../translations/it_IT/process/submit-checklist.rst | 2 +- Documentation/translations/ko_KR/memory-barriers.txt | 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/process/submit-checklist.rst | 2 +- Documentation/virt/kvm/arm/pvtime.rst| 2 +- Documentation/virt/kvm/devices/vcpu.rst | 2 +- Documentation/virt/kvm/hypercalls.rst| 4 ++-- arch/powerpc/include/uapi/asm/kvm_para.h | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/gpu/drm/drm_ioctl.c | 2 +- drivers/hwtracing/coresight/Kconfig | 2 +- fs/fat/Kconfig | 8 fs/fuse/Kconfig | 2 +- fs/fuse/dev.c| 2 +- fs/nfs/Kconfig | 2 +- fs/overlayfs/Kconfig | 6 +++--- include/linux/mm.h | 4 ++-- include/uapi/linux/ethtool_netlink.h | 2 +- include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +- mm/gup.c | 12 ++-- net/ipv4/Kconfig | 6 +++--- net/ipv4/ipconfig.c | 2 +- virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +- virt/kvm/arm/vgic/vgic.h | 4 ++-- 28 files changed, 47 insertions(+), 47 deletions(-) diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index 8be1d0bbfd16..e0fe9f70d22b 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -957,7 +957,7 @@ edid/1680x1050.bin, or edid/1920x1080.bin is given and no file with the same name exists. Details and instructions how to build your own EDID data are - available in Documentation/driver-api/edid.rst. An EDID + available in Documentation/admin-guide/edid.rst. An EDID data set will only be used for a particular connector, if its name and a colon are prepended to the EDID name. Each connector may use a unique EDID data @@ -1884,7 +1884,7 @@ No delay ip= [IP_PNP] - See Documentation/filesystems/nfs/nfsroot.txt. + See Documentation/admin-guide/nfs/nfsroot.rst. ipcmni_extend [KNL] Extend the maximum number of unique System V IPC identifiers from 32,768 to 16,777,216. @@ -2863,13 +2863,13 @@ Default value is 0. nfsaddrs= [NFS] Deprecated. Use ip= instead. - See Documentation/filesystems/nfs/nfsroot.txt. + See Documentation/admin-guide/nfs/nfsroot.rst. nfsroot=[NFS] nfs root filesystem for disk-less boxes. - See Documentation/filesystems/nfs/nfsroot.txt. + See Documentation/admin-guide/nfs/nfsroot.rst. nfsrootdebug[NFS] enable nfsroot debugging messages. - See Documentation/filesystems/nfs/nfsroot.txt. + See Documentation/admin-guide/nfs/nfsroot.rst. nfs.callback_nr_threads= [NFSv4] set the total number of threads that the diff --git a/Documentation/filesystems/cifs/cifsroot.txt b/Documentation/filesystems/cifs/cifsroot.txt index 0fa1a2c36a40..947b7ec6ce9e 100644 --- a/Documentation/filesystems/cifs/cifsroot.txt +++ b/Documentation/filesystems/cifs/cifsroot.txt @@ -13,7 +13,7 @@ network by utilizing SMB or CIFS protocol. In order to mount, the network stack will also need to be set up by using 'ip=' config option. For more details, see -Documentation/filesystems/nfs/nfsroot.txt. +Documentation/admin-guide/nfs/nfsroot.rst. A CIFS root mount currently requires the use of SMB1+UNIX Extensions which is only supported by the Samba server. SMB1 is the older diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt index e1c355e84edd..eaabc3134294 100644 --- a/Documentation/memory-barriers.txt +++ b/Documentation/memory-barriers.txt @@ -620,7 +620,7 @@ because the CPUs
[PATCH 03/35] docs: fix broken references to text files
Several references got broken due to txt to ReST conversion. Several of them can be automatically fixed with: scripts/documentation-file-ref-check --fix Reviewed-by: Mathieu Poirier # hwtracing/coresight/Kconfig Signed-off-by: Mauro Carvalho Chehab --- Documentation/memory-barriers.txt| 2 +- Documentation/process/submit-checklist.rst | 2 +- .../translations/it_IT/process/submit-checklist.rst | 2 +- Documentation/translations/ko_KR/memory-barriers.txt | 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/process/submit-checklist.rst | 2 +- Documentation/virt/kvm/arm/pvtime.rst| 2 +- Documentation/virt/kvm/devices/vcpu.rst | 2 +- Documentation/virt/kvm/hypercalls.rst| 4 ++-- arch/powerpc/include/uapi/asm/kvm_para.h | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/gpu/drm/drm_ioctl.c | 2 +- drivers/hwtracing/coresight/Kconfig | 2 +- fs/fat/Kconfig | 8 fs/fuse/Kconfig | 2 +- fs/fuse/dev.c| 2 +- fs/overlayfs/Kconfig | 6 +++--- include/linux/mm.h | 4 ++-- include/uapi/linux/ethtool_netlink.h | 2 +- include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +- mm/gup.c | 12 ++-- virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +- virt/kvm/arm/vgic/vgic.h | 4 ++-- 23 files changed, 36 insertions(+), 36 deletions(-) diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt index e1c355e84edd..eaabc3134294 100644 --- a/Documentation/memory-barriers.txt +++ b/Documentation/memory-barriers.txt @@ -620,7 +620,7 @@ because the CPUs that the Linux kernel supports don't do writes until they are certain (1) that the write will actually happen, (2) of the location of the write, and (3) of the value to be written. But please carefully read the "CONTROL DEPENDENCIES" section and the -Documentation/RCU/rcu_dereference.txt file: The compiler can and does +Documentation/RCU/rcu_dereference.rst file: The compiler can and does break dependencies in a great many highly creative ways. CPU 1 CPU 2 diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst index 8e56337d422d..3f8e9d5d95c2 100644 --- a/Documentation/process/submit-checklist.rst +++ b/Documentation/process/submit-checklist.rst @@ -107,7 +107,7 @@ and elsewhere regarding submitting Linux kernel patches. and why. 26) If any ioctl's are added by the patch, then also update -``Documentation/ioctl/ioctl-number.rst``. +``Documentation/userspace-api/ioctl/ioctl-number.rst``. 27) If your modified source code depends on or uses any of the kernel APIs or features that are related to the following ``Kconfig`` symbols, diff --git a/Documentation/translations/it_IT/process/submit-checklist.rst b/Documentation/translations/it_IT/process/submit-checklist.rst index 995ee69fab11..3e575502690f 100644 --- a/Documentation/translations/it_IT/process/submit-checklist.rst +++ b/Documentation/translations/it_IT/process/submit-checklist.rst @@ -117,7 +117,7 @@ sottomissione delle patch, in particolare sorgenti che ne spieghi la logica: cosa fanno e perché. 25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate -``Documentation/ioctl/ioctl-number.rst``. +``Documentation/userspace-api/ioctl/ioctl-number.rst``. 26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o funzionalità del kernel che è associata a uno dei seguenti simboli diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt index 2e831ece6e26..e50fe6541335 100644 --- a/Documentation/translations/ko_KR/memory-barriers.txt +++ b/Documentation/translations/ko_KR/memory-barriers.txt @@ -641,7 +641,7 @@ P 는 짝수 번호 캐시 라인에 저장되어 있고, 변수 B 는 홀수 리눅스 커널이 지원하는 CPU 들은 (1) 쓰기가 정말로 일어날지, (2) 쓰기가 어디에 이루어질지, 그리고 (3) 쓰여질 값을 확실히 알기 전까지는 쓰기를 수행하지 않기 때문입니다. 하지만 "컨트롤 의존성" 섹션과 -Documentation/RCU/rcu_dereference.txt 파일을 주의 깊게 읽어 주시기 바랍니다: +Documentation/RCU/rcu_dereference.rst 파일을 주의 깊게 읽어 주시기 바랍니다: 컴파일러는 매우 창의적인 많은 방법으로 종속성을 깰 수 있습니다. CPU 1 CPU 2 diff --git a/Documentation/translations/zh_CN/filesystems/sysfs.txt b/Documentation/translations/zh_CN/filesystems/sysfs.txt index ee1f37da5b23..a15c3ebdfa82 100644 --- a/Documentation/translations/zh_CN/filesystems/sysfs.txt +++ b/Documentation/translations/zh_CN/filesystems/sysfs.txt @@ -281,7 +281,7 @@ drivers/ 包含了每个已为特定总线上的设备而挂载的驱动程序 假定驱动没有跨越多个总线类型)。 fs/ 包含了一个为文件系统设立的目录。现在每
[PATCH 00/35] Documentation fixes for Kernel 5.8
Hi Jon, I have a large list of patches this time for the Documentation/. So, I'm starting sending them a little earier. Yet, those are meant to be applied after the end of the merge window. They're based on today's linux-next, with has only 49 patches pending to be applied upstream touching Documentation/, so I don't expect much conflicts if applied early at -rc cycle. Most of the patches here were already submitted, but weren't merged yet at next. So, it seems that nobody picked them yet. In any case, most of those patches here are independent from the others. The number of doc build warnings have been rising with time. The main goal with this series is to get rid of most Sphinx warnings and other errors. Patches 1 to 5: fix broken references detected by this tool: ./scripts/documentation-file-ref-check The other patches fix other random errors due to tags being mis-interpreted or mis-used. You should notice that several patches touch kernel-doc scripts. IMHO, some of the warnings are actually due to kernel-doc being too pedantic. So, I ended by improving some things at the toolset, in order to make it smarter. That's the case of those patches: docs: scripts/kernel-doc: accept blank lines on parameter description scripts: kernel-doc: accept negation like !@var scripts: kernel-doc: proper handle @foo->bar() The last 4 patches address problems with PDF building. The first one address a conflict that will rise during the merge window: Documentation/media will be removed. Instead of just drop it from the list of PDF documents, I opted to drop the entire list, as conf.py will auto-generate from the sources: docs: LaTeX/PDF: drop list of documents Also, right now, PDF output is broken due to a namespace conflict at I2c (two pdf outputs there will have the same name). docs: i2c: rename i2c.svg to i2c_bus.svg The third PDF patch is not really a fix, but it helps a lot to identify if the build succeeded or not, by placing the final PDF output on a separate dir: docs: Makefile: place final pdf docs on a separate dir Finally, the last one solves a bug since the first supported Sphinx version, with also impacts PDF output: basically while nested tables are valid with ReST notation, the toolset only started supporting it on PDF output since version 2.4: docs: update recommended Sphinx version to 2.4.4 PS.: Due to the large number of C/C, I opted to keep a smaller set of C/C at this first e-mail (only e-mails with "L:" tag from MAINTAINERS file). Mauro Carvalho Chehab (35): MAINTAINERS: dt: update display/allwinner file entry docs: dt: fix broken reference to phy-cadence-torrent.yaml docs: fix broken references to text files docs: fix broken references for ReST files that moved around docs: filesystems: fix renamed references docs: amu: supress some Sphinx warnings docs: arm64: booting.rst: get rid of some warnings docs: pci: boot-interrupts.rst: improve html output futex: get rid of a kernel-docs build warning firewire: firewire-cdev.hL get rid of a docs warning scripts: kernel-doc: proper handle @foo->bar() lib: bitmap.c: get rid of some doc warnings ata: libata-core: fix a doc warning fs: inode.c: get rid of docs warnings docs: ras: get rid of some warnings docs: ras: don't need to repeat twice the same thing docs: watch_queue.rst: supress some Sphinx warnings scripts: kernel-doc: accept negation like !@var docs: infiniband: verbs.c: fix some documentation warnings docs: scripts/kernel-doc: accept blank lines on parameter description docs: spi: spi.h: fix a doc building warning docs: drivers: fix some warnings at base/platform.c when building docs docs: fusion: mptbase.c: get rid of a doc build warning docs: mm: slab.h: fix a broken cross-reference docs mm: userfaultfd.rst: use ``foo`` for literals docs: mm: userfaultfd.rst: use a cross-reference for a section docs: vm: index.rst: add an orphan doc to the building system docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealView docs: dt: fix a broken reference for a file converted to json powerpc: docs: cxl.rst: mark two section titles as such docs: LaTeX/PDF: drop list of documents docs: i2c: rename i2c.svg to i2c_bus.svg docs: Makefile: place final pdf docs on a separate dir docs: update recommended Sphinx version to 2.4.4 Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-smaps_rollup | 2 +- Documentation/Makefile| 6 +- Documentation/PCI/boot-interrupts.rst | 34 +-- Documentation/admin-guide/cpu-load.rst| 2 +- Documentation/admin-guide/mm/userfaultfd.rst | 209 +- Documentation/admin-guide/nfs/nfsroot.rst | 2 +- Documentation/admin-guide/ras.rst | 18 +- Documentati
[PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such
The User API chapter contains two sub-chapters. Mark them as such. Signed-off-by: Mauro Carvalho Chehab --- Documentation/powerpc/cxl.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst index 920546d81326..d2d77057610e 100644 --- a/Documentation/powerpc/cxl.rst +++ b/Documentation/powerpc/cxl.rst @@ -133,6 +133,7 @@ User API 1. AFU character devices + For AFUs operating in AFU directed mode, two character device files will be created. /dev/cxl/afu0.0m will correspond to a @@ -395,6 +396,7 @@ read 2. Card character device (powerVM guest only) +^ In a powerVM guest, an extra character device is created for the card. The device is only used to write (flash) a new image on the -- 2.25.2
[PATCH 05/35] docs: filesystems: fix renamed references
Some filesystem references got broken by a previous patch series I submitted. Address those. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-smaps_rollup | 2 +- Documentation/admin-guide/cpu-load.rst | 2 +- Documentation/admin-guide/nfs/nfsroot.rst | 2 +- Documentation/driver-api/driver-model/device.rst| 4 ++-- Documentation/driver-api/driver-model/overview.rst | 2 +- Documentation/filesystems/dax.txt | 2 +- Documentation/filesystems/dnotify.txt | 2 +- Documentation/filesystems/ramfs-rootfs-initramfs.rst| 2 +- Documentation/filesystems/sysfs.rst | 2 +- Documentation/powerpc/firmware-assisted-dump.rst| 2 +- Documentation/process/adding-syscalls.rst | 2 +- .../translations/it_IT/process/adding-syscalls.rst | 2 +- Documentation/translations/zh_CN/filesystems/sysfs.txt | 6 +++--- drivers/base/core.c | 2 +- drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h | 2 +- fs/Kconfig | 2 +- fs/Kconfig.binfmt | 2 +- fs/adfs/Kconfig | 2 +- fs/affs/Kconfig | 2 +- fs/afs/Kconfig | 6 +++--- fs/bfs/Kconfig | 2 +- fs/cramfs/Kconfig | 2 +- fs/ecryptfs/Kconfig | 2 +- fs/hfs/Kconfig | 2 +- fs/hpfs/Kconfig | 2 +- fs/isofs/Kconfig| 2 +- fs/namespace.c | 2 +- fs/notify/inotify/Kconfig | 2 +- fs/ntfs/Kconfig | 2 +- fs/ocfs2/Kconfig| 2 +- fs/proc/Kconfig | 4 ++-- fs/romfs/Kconfig| 2 +- fs/sysfs/dir.c | 2 +- fs/sysfs/file.c | 2 +- fs/sysfs/mount.c| 2 +- fs/sysfs/symlink.c | 2 +- fs/sysv/Kconfig | 2 +- fs/udf/Kconfig | 2 +- include/linux/kobject.h | 2 +- include/linux/kobject_ns.h | 2 +- include/linux/relay.h | 2 +- include/linux/sysfs.h | 2 +- kernel/relay.c | 2 +- lib/kobject.c | 4 ++-- 45 files changed, 52 insertions(+), 52 deletions(-) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index df8413cf1468..484fc04bcc25 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -54,7 +54,7 @@ Date: October 2002 Contact: Linux Memory Management list Description: Provides information about the node's distribution and memory - utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.txt + utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.rst What: /sys/devices/system/node/nodeX/numastat Date: October 2002 diff --git a/Documentation/ABI/testing/procfs-smaps_rollup b/Documentation/ABI/testing/procfs-smaps_rollup index 274df44d8b1b..046978193368 100644 --- a/Documentation/ABI/testing/procfs-smaps_rollup +++ b/Documentation/ABI/testing/procfs-smaps_rollup @@ -11,7 +11,7 @@ Description: Additionally, the fields Pss_Anon, Pss_File and Pss_Shmem are not present in /proc/pid/smaps. These fields represent the sum of the Pss field of each type (anon, file, shmem). - For more details, see Documentation/filesystems/proc.txt + For more details, see Documentation/filesystems/proc.rst and the procfs man page. Typical output looks like this: diff --git a/Documentation/admin-guide/cpu-load.rst b/Documentation/admin-guide/cpu-load.rst index 2d01ce43d2a2..ebdecf864080 100644 --- a/Documentation/admin-guide/cpu-load.rst +++ b/Documentation/admin-guide/cpu-load.rst @@ -105,7 +105,7 @@ References -- - http
Re: [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such
Em Thu, 9 Apr 2020 10:37:52 +1000 Andrew Donnellan escreveu: > On 9/4/20 1:46 am, Mauro Carvalho Chehab wrote: > > The User API chapter contains two sub-chapters. Mark them as > > such. > > > > Signed-off-by: Mauro Carvalho Chehab > > Thanks. > > Though the other subsections in this file use - rather than ^, > what's the difference? ReST syntax allows the usage of several different markup symbols for titles. It dynamically attributes the first one it finds as level 1, the second one as level 2 and so on. As we added the "" markup before "-", after this patch, it now has: === level 1 === level 2 === level 3 ^^^ level 4 --- > > Acked-by: Andrew Donnellan > > > --- > > Documentation/powerpc/cxl.rst | 2 ++ > > 1 file changed, 2 insertions(+) > > > > diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst > > index 920546d81326..d2d77057610e 100644 > > --- a/Documentation/powerpc/cxl.rst > > +++ b/Documentation/powerpc/cxl.rst > > @@ -133,6 +133,7 @@ User API > > > > > > 1. AFU character devices > > + > > > > For AFUs operating in AFU directed mode, two character device > > files will be created. /dev/cxl/afu0.0m will correspond to a > > @@ -395,6 +396,7 @@ read > > > > > > 2. Card character device (powerVM guest only) > > +^ > > > > In a powerVM guest, an extra character device is created for the > > card. The device is only used to write (flash) a new image on the > > > Thanks, Mauro
[PATCH v2 24/29] docs: filesystems: convert spufs/spufs.txt to ReST
This file is at groff output format. Manually convert it to
ReST format, trying to preserve a similar output after parsed.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/filesystems/spufs/index.rst | 1 +
.../spufs/{spufs.txt => spufs.rst}| 59 +--
MAINTAINERS | 2 +-
3 files changed, 30 insertions(+), 32 deletions(-)
rename Documentation/filesystems/spufs/{spufs.txt => spufs.rst} (95%)
diff --git a/Documentation/filesystems/spufs/index.rst
b/Documentation/filesystems/spufs/index.rst
index 39553c6ebefd..939cf59a7d9e 100644
--- a/Documentation/filesystems/spufs/index.rst
+++ b/Documentation/filesystems/spufs/index.rst
@@ -8,4 +8,5 @@ SPU Filesystem
.. toctree::
:maxdepth: 1
+ spufs
spu_create
diff --git a/Documentation/filesystems/spufs/spufs.txt
b/Documentation/filesystems/spufs/spufs.rst
similarity index 95%
rename from Documentation/filesystems/spufs/spufs.txt
rename to Documentation/filesystems/spufs/spufs.rst
index caf36aaae804..8a42859bb100 100644
--- a/Documentation/filesystems/spufs/spufs.txt
+++ b/Documentation/filesystems/spufs/spufs.rst
@@ -1,12 +1,18 @@
-SPUFS(2) Linux Programmer's Manual SPUFS(2)
+.. SPDX-License-Identifier: GPL-2.0
+=
+spufs
+=
+Name
+
-NAME
spufs - the SPU file system
-DESCRIPTION
+Description
+===
+
The SPU file system is used on PowerPC machines that implement the Cell
Broadband Engine Architecture in order to access Synergistic Processor
Units (SPUs).
@@ -21,7 +27,9 @@ DESCRIPTION
ally add or remove files.
-MOUNT OPTIONS
+Mount Options
+=
+
uid=
set the user owning the mount point, the default is 0 (root).
@@ -29,7 +37,9 @@ MOUNT OPTIONS
set the group owning the mount point, the default is 0 (root).
-FILES
+Files
+=
+
The files in spufs mostly follow the standard behavior for regular sys-
tem calls like read(2) or write(2), but often support only a subset of
the operations supported on regular file systems. This list details the
@@ -125,14 +135,12 @@ FILES
space is available for writing.
- /mbox_stat
- /ibox_stat
- /wbox_stat
+ /mbox_stat, /ibox_stat, /wbox_stat
Read-only files that contain the length of the current queue, i.e. how
many words can be read from mbox or ibox or how many words can be
written to wbox without blocking. The files can be read only in 4-byte
units and return a big-endian binary integer number. The possible
- operations on an open *box_stat file are:
+ operations on an open ``*box_stat`` file are:
read(2)
If a count smaller than four is requested, read returns -1 and
@@ -143,12 +151,7 @@ FILES
in EAGAIN.
- /npc
- /decr
- /decr_status
- /spu_tag_mask
- /event_mask
- /srr0
+ /npc, /decr, /decr_status, /spu_tag_mask, /event_mask, /srr0
Internal registers of the SPU. The representation is an ASCII string
with the numeric value of the next instruction to be executed. These
can be used in read/write mode for debugging, but normal operation of
@@ -157,17 +160,14 @@ FILES
The contents of these files are:
+ === ===
npc Next Program Counter
-
decrSPU Decrementer
-
decr_status Decrementer Status
-
spu_tag_maskMFC tag mask for SPU DMA
-
event_mask Event mask for SPU interrupts
-
srr0Interrupt Return address register
+ === ===
The possible operations on an open npc, decr, decr_status,
@@ -206,8 +206,7 @@ FILES
from the data buffer, updating the value of the fpcr register.
- /signal1
- /signal2
+ /signal1, /signal2
The two signal notification channels of an SPU. These are read-write
files that operate on a 32 bit word. Writing to one of these files
triggers an interrupt on the SPU. The value written to the signal
@@ -233,8 +232,7 @@ FILES
file.
- /signal1_type
- /signal2_type
+ /signal1_type, /signal2_type
These two files change the behavior of the signal1 and signal2 notifi-
cation files. The contain a numerical ASCII string which is read as
either "1" or "0". In mode 0 (overwrite), the hardware replaces the
@@ -259,18 +257,17 @@ FILES
the previous setting.
-EXAMPLES
+Examples
+
/etc/fstab entry
none /spu spufs gid=spu 00
-AUTHORS
+Authors
+===
Arnd Bergmann , Mark Nutter ,
Ulrich Weig
[PATCH v2 00/29] fs: convert remaining docs to ReST file format
This patch series convert the remaining files under Documentation/filesystems
to the ReST file format (except for dax.txt and patch-lookup.txt).
It is based on linux-next (next-2020021).
PS.: I opted to add mainly ML from the output of get_maintainers.pl to the c/c
list of patch 00/34, because otherwise the number of c/c would be too many,
with would very likely cause ML servers to reject it.
The results of those changes (together with other changes from my pending
doc patches) are available at:
https://www.infradead.org/~mchehab/kernel_docs/filesystems/index.html
And the series is also on my git tree:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=fs_docs
If you prefer, feel free to merge the patches via the filesystems git tree(s).
-
v2:
- Removed dax.txt, in order to prevent a merge conflict with a dax patchset;
- Removed patch-lookup.txt conversion, due to patch-lookup.rst.
(I'll revisit this on some future)
- Removed a patch that was already merged;
- Added some Acked-by.
Mauro Carvalho Chehab (29):
docs: filesystems: convert caching/object.txt to ReST
docs: filesystems: convert caching/fscache.txt to ReST format
docs: filesystems: caching/netfs-api.txt: convert it to ReST
docs: filesystems: caching/operations.txt: convert it to ReST
docs: filesystems: caching/cachefiles.txt: convert to ReST
docs: filesystems: caching/backend-api.txt: convert it to ReST
docs: filesystems: convert cifs/cifsroot.txt to ReST
docs: filesystems: convert configfs.txt to ReST
docs: filesystems: convert automount-support.txt to ReST
docs: filesystems: convert coda.txt to ReST
docs: filesystems: convert devpts.txt to ReST
docs: filesystems: convert dnotify.txt to ReST
docs: filesystems: convert fiemap.txt to ReST
docs: filesystems: convert files.txt to ReST
docs: filesystems: convert fuse-io.txt to ReST
docs: filesystems: convert locks.txt to ReST
docs: filesystems: convert mandatory-locking.txt to ReST
docs: filesystems: convert mount_api.txt to ReST
docs: filesystems: convert quota.txt to ReST
docs: filesystems: convert seq_file.txt to ReST
docs: filesystems: convert sharedsubtree.txt to ReST
docs: filesystems: split spufs.txt into 3 separate files
docs: filesystems: convert spufs/spu_create.txt to ReST
docs: filesystems: convert spufs/spufs.txt to ReST
docs: filesystems: convert spufs/spu_run.txt to ReST
docs: filesystems: convert sysfs-pci.txt to ReST
docs: filesystems: convert sysfs-tagging.txt to ReST
docs: filesystems: convert xfs-delayed-logging-design.txt to ReST
docs: filesystems: convert xfs-self-describing-metadata.txt to ReST
Documentation/admin-guide/sysctl/kernel.rst |2 +-
...ount-support.txt => automount-support.rst} | 23 +-
.../{backend-api.txt => backend-api.rst} | 165 +-
.../{cachefiles.txt => cachefiles.rst}| 139 +-
Documentation/filesystems/caching/fscache.rst | 565 ++
Documentation/filesystems/caching/fscache.txt | 448 -
Documentation/filesystems/caching/index.rst | 14 +
.../caching/{netfs-api.txt => netfs-api.rst} | 172 +-
.../caching/{object.txt => object.rst}| 43 +-
.../{operations.txt => operations.rst}| 45 +-
.../cifs/{cifsroot.txt => cifsroot.rst} | 56 +-
Documentation/filesystems/coda.rst| 1670
Documentation/filesystems/coda.txt| 1676 -
.../{configfs/configfs.txt => configfs.rst} | 129 +-
Documentation/filesystems/devpts.rst | 36 +
Documentation/filesystems/devpts.txt | 26 -
.../filesystems/{dnotify.txt => dnotify.rst} | 11 +-
.../filesystems/{fiemap.txt => fiemap.rst}| 133 +-
.../filesystems/{files.txt => files.rst} | 15 +-
.../filesystems/{fuse-io.txt => fuse-io.rst} |6 +
Documentation/filesystems/index.rst | 23 +
.../filesystems/{locks.txt => locks.rst} | 14 +-
...tory-locking.txt => mandatory-locking.rst} | 25 +-
.../{mount_api.txt => mount_api.rst} | 329 ++--
Documentation/filesystems/proc.rst|2 +-
.../filesystems/{quota.txt => quota.rst} | 41 +-
.../{seq_file.txt => seq_file.rst}| 61 +-
.../{sharedsubtree.txt => sharedsubtree.rst} | 394 ++--
Documentation/filesystems/spufs/index.rst | 13 +
.../filesystems/spufs/spu_create.rst | 131 ++
Documentation/filesystems/spufs/spu_run.rst | 138 ++
.../{spufs.txt => spufs/spufs.rst}| 304 +--
.../{sysfs-pci.txt => sysfs-pci.rst} | 23 +-
.../{sysfs-tagging.txt => sysfs-tagging.rst} | 22 +-
...ign.txt => xfs-delayed-logging-design.rst} | 65 +-
...a.txt => xfs-self-describing-metadata.rst} | 182 +-
Documentation/iio/iio_configfs.rst|2 +-
Documentation/usb/gadget_configfs.rst |4 +-
MAINTAINERS | 14
[PATCH 00/34] fs: convert remaining docs to ReST file format
This patch series convert the remaining files under Documentation/filesystems
to the ReST file format. It is based on linux-next (next-20200414).
PS.: I opted to add mainly ML from the output of get_maintainers.pl to the c/c
list of patch 00/34, because otherwise the number of c/c would be too many,
with would very likely cause ML servers to reject it.
The results of those changes (together with other changes from my pending
doc patches) are available at:
https://www.infradead.org/~mchehab/kernel_docs/filesystems/index.html
Mauro Carvalho Chehab (34):
docs: filesystems: fix references for doc files there
docs: filesystems: convert caching/object.txt to ReST
docs: filesystems: convert caching/fscache.txt to ReST format
docs: filesystems: caching/netfs-api.txt: convert it to ReST
docs: filesystems: caching/operations.txt: convert it to ReST
docs: filesystems: caching/cachefiles.txt: convert to ReST
docs: filesystems: caching/backend-api.txt: convert it to ReST
docs: filesystems: convert cifs/cifsroot.rst to ReST
docs: filesystems: convert configfs.txt to ReST
docs: filesystems: convert automount-support.txt to ReST
docs: filesystems: convert coda.txt to ReST
docs: filesystems: convert dax.txt to ReST
docs: filesystems: convert devpts.txt to ReST
docs: filesystems: convert dnotify.txt to ReST
docs: filesystems: convert fiemap.txt to ReST
docs: filesystems: convert files.txt to ReST
docs: filesystems: convert fuse-io.txt to ReST
docs: filesystems: convert gfs2-glocks.txt to ReST
docs: filesystems: convert locks.txt to ReST
docs: filesystems: convert mandatory-locking.txt to ReST
docs: filesystems: convert mount_api.txt to ReST
docs: filesystems: rename path-lookup.txt file
docs: filesystems: convert path-walking.txt to ReST
docs: filesystems: convert quota.txt to ReST
docs: filesystems: convert seq_file.txt to ReST
docs: filesystems: convert sharedsubtree.txt to ReST
docs: filesystems: split spufs.txt into 3 separate files
docs: filesystems: convert spufs/spu_create.txt to ReST
docs: filesystems: convert spufs/spufs.txt to ReST
docs: filesystems: convert spufs/spu_run.txt to ReST
docs: filesystems: convert sysfs-pci.txt to ReST
docs: filesystems: convert sysfs-tagging.txt to ReST
docs: filesystems: convert xfs-delayed-logging-design.txt to ReST
docs: filesystems: convert xfs-self-describing-metadata.txt to ReST
Documentation/ABI/stable/sysfs-devices-node |2 +-
Documentation/ABI/testing/procfs-smaps_rollup |2 +-
Documentation/admin-guide/cpu-load.rst|2 +-
Documentation/admin-guide/ext4.rst|2 +-
Documentation/admin-guide/nfs/nfsroot.rst |2 +-
Documentation/admin-guide/sysctl/kernel.rst |2 +-
.../driver-api/driver-model/device.rst|2 +-
.../driver-api/driver-model/overview.rst |2 +-
...ount-support.txt => automount-support.rst} | 23 +-
.../{backend-api.txt => backend-api.rst} | 165 +-
.../{cachefiles.txt => cachefiles.rst}| 139 +-
Documentation/filesystems/caching/fscache.rst | 565 ++
Documentation/filesystems/caching/fscache.txt | 448 -
Documentation/filesystems/caching/index.rst | 14 +
.../caching/{netfs-api.txt => netfs-api.rst} | 172 +-
.../caching/{object.txt => object.rst}| 43 +-
.../{operations.txt => operations.rst}| 45 +-
.../cifs/{cifsroot.txt => cifsroot.rst} | 56 +-
Documentation/filesystems/coda.rst| 1670
Documentation/filesystems/coda.txt| 1676 -
.../{configfs/configfs.txt => configfs.rst} | 129 +-
.../filesystems/{dax.txt => dax.rst} | 11 +-
Documentation/filesystems/devpts.rst | 36 +
Documentation/filesystems/devpts.txt | 26 -
.../filesystems/{dnotify.txt => dnotify.rst} | 13 +-
Documentation/filesystems/ext2.rst|2 +-
.../filesystems/{fiemap.txt => fiemap.rst}| 133 +-
.../filesystems/{files.txt => files.rst} | 15 +-
.../filesystems/{fuse-io.txt => fuse-io.rst} |6 +
.../{gfs2-glocks.txt => gfs2-glocks.rst} | 147 +-
Documentation/filesystems/index.rst | 26 +
.../filesystems/{locks.txt => locks.rst} | 14 +-
...tory-locking.txt => mandatory-locking.rst} | 25 +-
.../{mount_api.txt => mount_api.rst} | 329 ++--
.../{path-lookup.txt => path-walking.rst} | 88 +-
Documentation/filesystems/porting.rst |2 +-
Documentation/filesystems/proc.rst|2 +-
.../filesystems/{quota.txt => quota.rst} | 41 +-
.../filesystems/ramfs-rootfs-initramfs.rst|2 +-
.../{seq_file.txt => seq_file.rst}| 61 +-
.../{sharedsubtree.txt => sharedsubtree.rst} | 394 ++--
Documentation/filesystems/spufs/index.rst | 13 +
.../filesystems/spufs/spu_create.rst | 131 ++
Documentation/fil
[PATCH 29/34] docs: filesystems: convert spufs/spufs.txt to ReST
This file is at groff output format. Manually convert it to
ReST format, trying to preserve a similar output after parsed.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/filesystems/spufs/index.rst | 1 +
.../spufs/{spufs.txt => spufs.rst}| 59 +--
MAINTAINERS | 2 +-
3 files changed, 30 insertions(+), 32 deletions(-)
rename Documentation/filesystems/spufs/{spufs.txt => spufs.rst} (95%)
diff --git a/Documentation/filesystems/spufs/index.rst
b/Documentation/filesystems/spufs/index.rst
index 39553c6ebefd..939cf59a7d9e 100644
--- a/Documentation/filesystems/spufs/index.rst
+++ b/Documentation/filesystems/spufs/index.rst
@@ -8,4 +8,5 @@ SPU Filesystem
.. toctree::
:maxdepth: 1
+ spufs
spu_create
diff --git a/Documentation/filesystems/spufs/spufs.txt
b/Documentation/filesystems/spufs/spufs.rst
similarity index 95%
rename from Documentation/filesystems/spufs/spufs.txt
rename to Documentation/filesystems/spufs/spufs.rst
index caf36aaae804..8a42859bb100 100644
--- a/Documentation/filesystems/spufs/spufs.txt
+++ b/Documentation/filesystems/spufs/spufs.rst
@@ -1,12 +1,18 @@
-SPUFS(2) Linux Programmer's Manual SPUFS(2)
+.. SPDX-License-Identifier: GPL-2.0
+=
+spufs
+=
+Name
+
-NAME
spufs - the SPU file system
-DESCRIPTION
+Description
+===
+
The SPU file system is used on PowerPC machines that implement the Cell
Broadband Engine Architecture in order to access Synergistic Processor
Units (SPUs).
@@ -21,7 +27,9 @@ DESCRIPTION
ally add or remove files.
-MOUNT OPTIONS
+Mount Options
+=
+
uid=
set the user owning the mount point, the default is 0 (root).
@@ -29,7 +37,9 @@ MOUNT OPTIONS
set the group owning the mount point, the default is 0 (root).
-FILES
+Files
+=
+
The files in spufs mostly follow the standard behavior for regular sys-
tem calls like read(2) or write(2), but often support only a subset of
the operations supported on regular file systems. This list details the
@@ -125,14 +135,12 @@ FILES
space is available for writing.
- /mbox_stat
- /ibox_stat
- /wbox_stat
+ /mbox_stat, /ibox_stat, /wbox_stat
Read-only files that contain the length of the current queue, i.e. how
many words can be read from mbox or ibox or how many words can be
written to wbox without blocking. The files can be read only in 4-byte
units and return a big-endian binary integer number. The possible
- operations on an open *box_stat file are:
+ operations on an open ``*box_stat`` file are:
read(2)
If a count smaller than four is requested, read returns -1 and
@@ -143,12 +151,7 @@ FILES
in EAGAIN.
- /npc
- /decr
- /decr_status
- /spu_tag_mask
- /event_mask
- /srr0
+ /npc, /decr, /decr_status, /spu_tag_mask, /event_mask, /srr0
Internal registers of the SPU. The representation is an ASCII string
with the numeric value of the next instruction to be executed. These
can be used in read/write mode for debugging, but normal operation of
@@ -157,17 +160,14 @@ FILES
The contents of these files are:
+ === ===
npc Next Program Counter
-
decrSPU Decrementer
-
decr_status Decrementer Status
-
spu_tag_maskMFC tag mask for SPU DMA
-
event_mask Event mask for SPU interrupts
-
srr0Interrupt Return address register
+ === ===
The possible operations on an open npc, decr, decr_status,
@@ -206,8 +206,7 @@ FILES
from the data buffer, updating the value of the fpcr register.
- /signal1
- /signal2
+ /signal1, /signal2
The two signal notification channels of an SPU. These are read-write
files that operate on a 32 bit word. Writing to one of these files
triggers an interrupt on the SPU. The value written to the signal
@@ -233,8 +232,7 @@ FILES
file.
- /signal1_type
- /signal2_type
+ /signal1_type, /signal2_type
These two files change the behavior of the signal1 and signal2 notifi-
cation files. The contain a numerical ASCII string which is read as
either "1" or "0". In mode 0 (overwrite), the hardware replaces the
@@ -259,18 +257,17 @@ FILES
the previous setting.
-EXAMPLES
+Examples
+
/etc/fstab entry
none /spu spufs gid=spu 00
-AUTHORS
+Authors
+===
Arnd Bergmann , Mark Nutter ,
Ulrich Weig
Re: [PATCH v2 0/2] Don't generate thousands of new warnings when building docs
Em Tue, 07 Apr 2020 13:46:23 +1000 Michael Ellerman escreveu: > Mauro Carvalho Chehab writes: > > This small series address a regression caused by a new patch at > > docs-next (and at linux-next). > > ... > > This solves almost all problems we have. Still, there are a few places > > where we have two chapters at the same document with the > > same name. The first patch addresses this problem. > > I'm still seeing a lot of warnings. Am I doing something wrong? > > cheers > > /linux/Documentation/powerpc/cxl.rst:406: WARNING: duplicate label > powerpc/cxl:open, other instance in /linux/Documentation/powerpc/cxl.rst ... > /linux/Documentation/powerpc/syscall64-abi.rst:86: WARNING: duplicate label > powerpc/syscall64-abi:parameters and return value, other instance in > /linux/Documentation/powerpc/syscall64-abi.rst ... > /linux/Documentation/powerpc/ultravisor.rst:339: WARNING: duplicate label > powerpc/ultravisor:syntax, other instance in > /linux/Documentation/powerpc/ultravisor.rst ... I can't reproduce your issue here at linux-next (+ my pending doc patches). So, I can only provide you some hints. If you see the logs you posted, all of them are related to duplicated labels inside the same file. - The new Sphinx module we're using (sphinx.ext.autosectionlabel) generates references for two levels, within the same document file (after this patch). Looking at the first document (at linux-next version), it has: 1) A first level document title: Coherent Accelerator Interface (CXL) 2) Several second level titles: Introduction Hardware overview AFU Modes MMIO space Interrupts Work Element Descriptor (WED) User API Sysfs Class Udev rules Right now, there's no duplication, but if someone adds, for example, another first-level or second-level title called "Interrupts", then the file will produce a duplicated label and Sphinx will warn. The same would happen if someone adds another title (either first level or second level) called "Coherent Accelerator Interface (CXL)", as this will conflict with the document title. - Now, if the title "Coherent Accelerator Interface (CXL)" got removed, then "Introduction".."Udev rules" will become first level titles. Then, the sections at the "User API": "open", "ioctl"... will become second level titles and it will produce lots of warnings. - That's said, IMHO, this document needs section titles for the two sections under "User API". Adding it would allow removing the document title. See enclosed. Thanks, Mauro powerpc: docs: cxl.rst: mark two section titles as such The User API chapter contains two sub-chapters. Mark them as such. Signed-off-by: Mauro Carvalho Chehab diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst index 920546d81326..d2d77057610e 100644 --- a/Documentation/powerpc/cxl.rst +++ b/Documentation/powerpc/cxl.rst @@ -133,6 +133,7 @@ User API 1. AFU character devices + For AFUs operating in AFU directed mode, two character device files will be created. /dev/cxl/afu0.0m will correspond to a @@ -395,6 +396,7 @@ read 2. Card character device (powerVM guest only) +^ In a powerVM guest, an extra character device is created for the card. The device is only used to write (flash) a new image on the
[PATCH v3 23/29] docs: filesystems: convert spufs/spufs.txt to ReST
This file is at groff output format. Manually convert it to
ReST format, trying to preserve a similar output after parsed.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/filesystems/spufs/index.rst | 1 +
.../spufs/{spufs.txt => spufs.rst}| 59 +--
MAINTAINERS | 2 +-
3 files changed, 30 insertions(+), 32 deletions(-)
rename Documentation/filesystems/spufs/{spufs.txt => spufs.rst} (95%)
diff --git a/Documentation/filesystems/spufs/index.rst
b/Documentation/filesystems/spufs/index.rst
index 39553c6ebefd..939cf59a7d9e 100644
--- a/Documentation/filesystems/spufs/index.rst
+++ b/Documentation/filesystems/spufs/index.rst
@@ -8,4 +8,5 @@ SPU Filesystem
.. toctree::
:maxdepth: 1
+ spufs
spu_create
diff --git a/Documentation/filesystems/spufs/spufs.txt
b/Documentation/filesystems/spufs/spufs.rst
similarity index 95%
rename from Documentation/filesystems/spufs/spufs.txt
rename to Documentation/filesystems/spufs/spufs.rst
index caf36aaae804..8a42859bb100 100644
--- a/Documentation/filesystems/spufs/spufs.txt
+++ b/Documentation/filesystems/spufs/spufs.rst
@@ -1,12 +1,18 @@
-SPUFS(2) Linux Programmer's Manual SPUFS(2)
+.. SPDX-License-Identifier: GPL-2.0
+=
+spufs
+=
+Name
+
-NAME
spufs - the SPU file system
-DESCRIPTION
+Description
+===
+
The SPU file system is used on PowerPC machines that implement the Cell
Broadband Engine Architecture in order to access Synergistic Processor
Units (SPUs).
@@ -21,7 +27,9 @@ DESCRIPTION
ally add or remove files.
-MOUNT OPTIONS
+Mount Options
+=
+
uid=
set the user owning the mount point, the default is 0 (root).
@@ -29,7 +37,9 @@ MOUNT OPTIONS
set the group owning the mount point, the default is 0 (root).
-FILES
+Files
+=
+
The files in spufs mostly follow the standard behavior for regular sys-
tem calls like read(2) or write(2), but often support only a subset of
the operations supported on regular file systems. This list details the
@@ -125,14 +135,12 @@ FILES
space is available for writing.
- /mbox_stat
- /ibox_stat
- /wbox_stat
+ /mbox_stat, /ibox_stat, /wbox_stat
Read-only files that contain the length of the current queue, i.e. how
many words can be read from mbox or ibox or how many words can be
written to wbox without blocking. The files can be read only in 4-byte
units and return a big-endian binary integer number. The possible
- operations on an open *box_stat file are:
+ operations on an open ``*box_stat`` file are:
read(2)
If a count smaller than four is requested, read returns -1 and
@@ -143,12 +151,7 @@ FILES
in EAGAIN.
- /npc
- /decr
- /decr_status
- /spu_tag_mask
- /event_mask
- /srr0
+ /npc, /decr, /decr_status, /spu_tag_mask, /event_mask, /srr0
Internal registers of the SPU. The representation is an ASCII string
with the numeric value of the next instruction to be executed. These
can be used in read/write mode for debugging, but normal operation of
@@ -157,17 +160,14 @@ FILES
The contents of these files are:
+ === ===
npc Next Program Counter
-
decrSPU Decrementer
-
decr_status Decrementer Status
-
spu_tag_maskMFC tag mask for SPU DMA
-
event_mask Event mask for SPU interrupts
-
srr0Interrupt Return address register
+ === ===
The possible operations on an open npc, decr, decr_status,
@@ -206,8 +206,7 @@ FILES
from the data buffer, updating the value of the fpcr register.
- /signal1
- /signal2
+ /signal1, /signal2
The two signal notification channels of an SPU. These are read-write
files that operate on a 32 bit word. Writing to one of these files
triggers an interrupt on the SPU. The value written to the signal
@@ -233,8 +232,7 @@ FILES
file.
- /signal1_type
- /signal2_type
+ /signal1_type, /signal2_type
These two files change the behavior of the signal1 and signal2 notifi-
cation files. The contain a numerical ASCII string which is read as
either "1" or "0". In mode 0 (overwrite), the hardware replaces the
@@ -259,18 +257,17 @@ FILES
the previous setting.
-EXAMPLES
+Examples
+
/etc/fstab entry
none /spu spufs gid=spu 00
-AUTHORS
+Authors
+===
Arnd Bergmann , Mark Nutter ,
Ulrich Weig
[PATCH v3 00/29] Convert files to ReST - part 2
This is the second part of a series I wrote sometime ago where I manually
convert lots of files to be properly parsed by Sphinx as ReST files.
As it touches on lot of stuff, this series is based on today's linux-next,
at tag next-20190617.
The first version of this series had 57 patches. The first part with 28 patches
were already merged. Right now, there are still ~76 patches pending applying
(including this series), and that's because I opted to do ~1 patch per converted
directory.
That sounds too much to be send on a single round. So, I'm opting to split
it on 3 parts for the conversion, plus a final patch adding orphaned books
to existing ones.
Those patches should probably be good to be merged either by subsystem
maintainers or via the docs tree.
I opted to mark new files not included yet to the main index.rst (directly or
indirectly) with the :orphan: tag, in order to avoid adding warnings to the
build system. This should be removed after we find a "home" for all
the converted files within the new document tree arrangement, after I
submit the third part.
Both this series and the other parts of this work are on my devel git tree,
at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=convert_rst_renames_v5.1
The final output in html (after all patches I currently have, including
the upcoming series) can be seen at:
https://www.infradead.org/~mchehab/rst_conversion/
It contains all pending work from my side related to the conversion, plus
the patches I finished a first version today with contains the renaming
patches and de-orphan changes.
---
Version 3:
- Rebased on the top of next-20200424
- configfs.rst conversion moved to the end of the series;
- avoided almost all markups at configfs.rst while still preserving
a reasonable output and not generating build warnings.
Version 2:
- Removed patches merged via other trees;
- rebased on the top of today's linux-next (next-20190617);
- Fix a typo on one patch's description;
- Added received acks.
Mauro Carvalho Chehab (29):
docs: filesystems: convert caching/object.txt to ReST
docs: filesystems: convert caching/fscache.txt to ReST format
docs: filesystems: caching/netfs-api.txt: convert it to ReST
docs: filesystems: caching/operations.txt: convert it to ReST
docs: filesystems: caching/cachefiles.txt: convert to ReST
docs: filesystems: caching/backend-api.txt: convert it to ReST
docs: filesystems: convert cifs/cifsroot.txt to ReST
docs: filesystems: convert automount-support.txt to ReST
docs: filesystems: convert coda.txt to ReST
docs: filesystems: convert devpts.txt to ReST
docs: filesystems: convert dnotify.txt to ReST
docs: filesystems: convert fiemap.txt to ReST
docs: filesystems: convert files.txt to ReST
docs: filesystems: convert fuse-io.txt to ReST
docs: filesystems: convert locks.txt to ReST
docs: filesystems: convert mandatory-locking.txt to ReST
docs: filesystems: convert mount_api.txt to ReST
docs: filesystems: convert quota.txt to ReST
docs: filesystems: convert seq_file.txt to ReST
docs: filesystems: convert sharedsubtree.txt to ReST
docs: filesystems: split spufs.txt into 3 separate files
docs: filesystems: convert spufs/spu_create.txt to ReST
docs: filesystems: convert spufs/spufs.txt to ReST
docs: filesystems: convert spufs/spu_run.txt to ReST
docs: filesystems: convert sysfs-pci.txt to ReST
docs: filesystems: convert sysfs-tagging.txt to ReST
docs: filesystems: convert xfs-delayed-logging-design.txt to ReST
docs: filesystems: convert xfs-self-describing-metadata.txt to ReST
docs: filesystems: convert configfs.txt to ReST
Documentation/admin-guide/sysctl/kernel.rst |2 +-
...ount-support.txt => automount-support.rst} | 23 +-
.../{backend-api.txt => backend-api.rst} | 165 +-
.../{cachefiles.txt => cachefiles.rst}| 139 +-
Documentation/filesystems/caching/fscache.rst | 565 ++
Documentation/filesystems/caching/fscache.txt | 448 -
Documentation/filesystems/caching/index.rst | 14 +
.../caching/{netfs-api.txt => netfs-api.rst} | 172 +-
.../caching/{object.txt => object.rst}| 43 +-
.../{operations.txt => operations.rst}| 45 +-
.../cifs/{cifsroot.txt => cifsroot.rst} | 56 +-
Documentation/filesystems/coda.rst| 1670
Documentation/filesystems/coda.txt| 1676 -
.../{configfs/configfs.txt => configfs.rst} | 131 +-
Documentation/filesystems/devpts.rst | 36 +
Documentation/filesystems/devpts.txt | 26 -
.../filesystems/{dnotify.txt => dnotify.rst} | 11 +-
.../filesystems/{fiemap.txt => fiemap.rst}| 133 +-
.../filesystems/{files.txt => files.rst} | 15 +-
.../filesystems/{fuse-io.txt => fuse-io.rst} |6 +
Documentation/filesystems/index.rst | 23 +
.../filesystems/{locks.txt => locks.rst} | 14 +-
...
[PATCH v4 14/19] docs: powerpc: convert vcpudispatch_stats.txt to ReST
- Add a SPDX header;
- Use standard markup for document title;
- Adjust identation on lists and add blank lines where
needed;
- Add it to the powerpc index.rst file.
Acked-by: Michael Ellerman # powerpc
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/powerpc/index.rst | 1 +
...ispatch_stats.txt => vcpudispatch_stats.rst} | 17 -
2 files changed, 13 insertions(+), 5 deletions(-)
rename Documentation/powerpc/{vcpudispatch_stats.txt =>
vcpudispatch_stats.rst} (94%)
diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst
index afe2d5e54db6..748bf483b1c2 100644
--- a/Documentation/powerpc/index.rst
+++ b/Documentation/powerpc/index.rst
@@ -31,6 +31,7 @@ powerpc
transactional_memory
ultravisor
vas-api
+vcpudispatch_stats
.. only:: subproject and html
diff --git a/Documentation/powerpc/vcpudispatch_stats.txt
b/Documentation/powerpc/vcpudispatch_stats.rst
similarity index 94%
rename from Documentation/powerpc/vcpudispatch_stats.txt
rename to Documentation/powerpc/vcpudispatch_stats.rst
index e21476bfd78c..5704657a5987 100644
--- a/Documentation/powerpc/vcpudispatch_stats.txt
+++ b/Documentation/powerpc/vcpudispatch_stats.rst
@@ -1,5 +1,8 @@
-VCPU Dispatch Statistics:
-=
+.. SPDX-License-Identifier: GPL-2.0
+
+
+VCPU Dispatch Statistics
+
For Shared Processor LPARs, the POWER Hypervisor maintains a relatively
static mapping of the LPAR processors (vcpus) to physical processor
@@ -20,25 +23,29 @@ The statistics themselves are available by reading the
procfs file
a vcpu as represented by the first field, followed by 8 numbers.
The first number corresponds to:
+
1. total vcpu dispatches since the beginning of statistics collection
The next 4 numbers represent vcpu dispatch dispersions:
+
2. number of times this vcpu was dispatched on the same processor as last
time
3. number of times this vcpu was dispatched on a different processor core
as last time, but within the same chip
4. number of times this vcpu was dispatched on a different chip
5. number of times this vcpu was dispatches on a different socket/drawer
-(next numa boundary)
+ (next numa boundary)
The final 3 numbers represent statistics in relation to the home node of
the vcpu:
+
6. number of times this vcpu was dispatched in its home node (chip)
7. number of times this vcpu was dispatched in a different node
8. number of times this vcpu was dispatched in a node further away (numa
-distance)
+ distance)
+
+An example output::
-An example output:
$ sudo cat /proc/powerpc/vcpudispatch_stats
cpu0 6839 4126 2683 30 0 6821 18 0
cpu1 2515 1274 1229 12 0 2509 6 0
--
2.25.4
[PATCH v4 00/19] Manually convert thermal, crypto and misc devices to ReST
Manually convert some files from thermal, crypto and misc-devices
to ReST format.
This series is against linux-next 20200430 tag (as I rebased it, in order
to check if some patch were already merged via some other tree),
but it should very likely merge fine against docs-next.
The full series (including those ones) are at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=misc-docs
The documents touched on this patch, converted to HTML via the
building system are at (together with patches from other series):
https://www.infradead.org/~mchehab/kernel_docs/
v4:
- added some acks.
v3:
- removed the cpu-freq patches from this series, as Rafael should
be applying it on his tree.
v2:
- a small change at patch 2 to avoid uneeded whitespace changes;
- added 13 new patches at the end
Mauro Carvalho Chehab (19):
docs: thermal: convert cpu-idle-cooling.rst to ReST
docs: crypto: convert asymmetric-keys.txt to ReST
docs: crypto: convert api-intro.txt to ReST format
docs: crypto: convert async-tx-api.txt to ReST format
docs: crypto: descore-readme.txt: convert to ReST format
docs: misc-devices/spear-pcie-gadget.txt: convert to ReST
docs: misc-devices/pci-endpoint-test.txt: convert to ReST
docs: misc-devices/pci-endpoint-test.txt: convert to ReST
docs: misc-devices/c2port.txt: convert to ReST format
docs: misc-devices/bh1770glc.txt: convert to ReST
docs: misc-devices/apds990x.txt: convert to ReST format
docs: pci: endpoint/function/binding/pci-test.txt convert to ReST
docs: arm64: convert perf.txt to ReST format
docs: powerpc: convert vcpudispatch_stats.txt to ReST
docs: sh: convert new-machine.txt to ReST
docs: sh: convert register-banks.txt to ReST
docs: trace: ring-buffer-design.txt: convert to ReST format
docs: kvm: get read of devices/README
docs: misc-devices: add uacce to the index.rst
.../endpoint/function/binding/pci-test.rst| 26 +
.../endpoint/function/binding/pci-test.txt| 19 -
Documentation/PCI/endpoint/index.rst | 2 +
Documentation/arm64/index.rst | 1 +
Documentation/arm64/{perf.txt => perf.rst}| 7 +-
.../crypto/{api-intro.txt => api-intro.rst} | 186 ++--
...symmetric-keys.txt => asymmetric-keys.rst} | 91 +-
.../{async-tx-api.txt => async-tx-api.rst}| 253 +++---
...{descore-readme.txt => descore-readme.rst} | 152 +++-
Documentation/crypto/index.rst| 5 +
Documentation/driver-api/dmaengine/client.rst | 2 +-
.../driver-api/dmaengine/provider.rst | 2 +-
.../driver-api/thermal/cpu-idle-cooling.rst | 18 +-
Documentation/driver-api/thermal/index.rst| 1 +
.../{ad525x_dpot.txt => ad525x_dpot.rst} | 24 +-
.../{apds990x.txt => apds990x.rst}| 31 +-
.../{bh1770glc.txt => bh1770glc.rst} | 45 +-
.../misc-devices/{c2port.txt => c2port.rst} | 58 +-
Documentation/misc-devices/index.rst | 7 +
.../misc-devices/pci-endpoint-test.rst| 56 ++
.../misc-devices/pci-endpoint-test.txt| 41 -
.../misc-devices/spear-pcie-gadget.rst| 170
.../misc-devices/spear-pcie-gadget.txt| 130 ---
Documentation/powerpc/index.rst | 1 +
...patch_stats.txt => vcpudispatch_stats.rst} | 17 +-
Documentation/security/keys/core.rst | 2 +-
Documentation/sh/index.rst| 6 +
.../sh/{new-machine.txt => new-machine.rst} | 195 +++--
...{register-banks.txt => register-banks.rst} | 13 +-
Documentation/trace/index.rst | 1 +
...ffer-design.txt => ring-buffer-design.rst} | 802 ++
Documentation/virt/kvm/devices/README | 1 -
Documentation/virt/kvm/devices/index.rst | 3 +
MAINTAINERS | 4 +-
arch/sh/Kconfig.cpu | 2 +-
crypto/asymmetric_keys/asymmetric_type.c | 2 +-
crypto/asymmetric_keys/public_key.c | 2 +-
crypto/asymmetric_keys/signature.c| 2 +-
drivers/misc/Kconfig | 2 +-
drivers/misc/ad525x_dpot.c| 2 +-
include/crypto/public_key.h | 2 +-
include/keys/asymmetric-parser.h | 2 +-
include/keys/asymmetric-subtype.h | 2 +-
include/keys/asymmetric-type.h| 2 +-
44 files changed, 1358 insertions(+), 1034 deletions(-)
create mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.rst
delete mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.txt
rename Documentation/arm64/{perf.txt => perf.rst} (95%)
rename Documentation/crypto/{api-intro.txt => api-intro.rst} (70%)
rename Documentation/crypto/{asymmetric-keys.txt => asymmetric-keys.rst} (91%)
rename Documentation/crypto/{async-tx-api.txt => async-tx-api.rst} (55%)
rename Documentation/crypto/{descore-readme.txt => descore-readme.rst} (81
[PATCH 00/37] net: manually convert files to ReST format - part 2
That's the second part of my work to convert the networking
text files into ReST. it is based on today's linux-next (next-20200430).
The full series (including those ones) are at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
I should be sending the remaining patches (another /38 series)
after getting those merged at -next.
The documents, converted to HTML via the building system are at:
https://www.infradead.org/~mchehab/kernel_docs/networking/
Mauro Carvalho Chehab (37):
docs: networking: convert l2tp.txt to ReST
docs: networking: convert lapb-module.txt to ReST
docs: networking: convert ltpc.txt to ReST
docs: networking: convert mac80211-injection.txt to ReST
docs: networking: convert mpls-sysctl.txt to ReST
docs: networking: convert multiqueue.txt to ReST
docs: networking: convert netconsole.txt to ReST
docs: networking: convert netdev-features.txt to ReST
docs: networking: convert netdevices.txt to ReST
docs: networking: convert netfilter-sysctl.txt to ReST
docs: networking: convert netif-msg.txt to ReST
docs: networking: convert nf_conntrack-sysctl.txt to ReST
docs: networking: convert nf_flowtable.txt to ReST
docs: networking: convert openvswitch.txt to ReST
docs: networking: convert operstates.txt to ReST
docs: networking: convert packet_mmap.txt to ReST
docs: networking: convert phonet.txt to ReST
docs: networking: convert pktgen.txt to ReST
docs: networking: convert PLIP.txt to ReST
docs: networking: convert ppp_generic.txt to ReST
docs: networking: convert proc_net_tcp.txt to ReST
docs: networking: convert radiotap-headers.txt to ReST
docs: networking: convert ray_cs.txt to ReST
docs: networking: convert rds.txt to ReST
docs: networking: convert regulatory.txt to ReST
docs: networking: convert rxrpc.txt to ReST
docs: networking: convert sctp.txt to ReST
docs: networking: convert secid.txt to ReST
docs: networking: convert seg6-sysctl.txt to ReST
docs: networking: convert skfp.txt to ReST
docs: networking: convert strparser.txt to ReST
docs: networking: convert switchdev.txt to ReST
docs: networking: convert tc-actions-env-rules.txt to ReST
docs: networking: convert tcp-thin.txt to ReST
docs: networking: convert team.txt to ReST
docs: networking: convert timestamping.txt to ReST
docs: networking: convert tproxy.txt to ReST
.../admin-guide/kernel-parameters.txt |2 +-
Documentation/admin-guide/serial-console.rst |2 +-
Documentation/filesystems/afs.rst |2 +-
Documentation/networking/bonding.rst |2 +-
Documentation/networking/can.rst |2 +-
.../networking/checksum-offloads.rst |2 +-
Documentation/networking/index.rst| 37 +
Documentation/networking/ip-sysctl.rst|2 +-
.../networking/{l2tp.txt => l2tp.rst} | 145 ++-
.../{lapb-module.txt => lapb-module.rst} | 120 +-
.../networking/{ltpc.txt => ltpc.rst} | 45 +-
...1-injection.txt => mac80211-injection.rst} | 41 +-
.../{mpls-sysctl.txt => mpls-sysctl.rst} | 17 +-
.../{multiqueue.txt => multiqueue.rst}| 41 +-
.../{netconsole.txt => netconsole.rst}| 125 +-
...etdev-features.txt => netdev-features.rst} | 19 +-
.../{netdevices.txt => netdevices.rst}| 21 +-
...filter-sysctl.txt => netfilter-sysctl.rst} | 11 +-
Documentation/networking/netif-msg.rst| 95 ++
Documentation/networking/netif-msg.txt| 79 --
...ack-sysctl.txt => nf_conntrack-sysctl.rst} | 51 +-
.../{nf_flowtable.txt => nf_flowtable.rst}| 55 +-
.../{openvswitch.txt => openvswitch.rst} | 23 +-
.../{operstates.txt => operstates.rst}| 45 +-
Documentation/networking/packet_mmap.rst | 1084 +
Documentation/networking/packet_mmap.txt | 1061
.../networking/{phonet.txt => phonet.rst} | 56 +-
.../networking/{pktgen.txt => pktgen.rst} | 316 ++---
.../networking/{PLIP.txt => plip.rst} | 43 +-
.../{ppp_generic.txt => ppp_generic.rst} | 52 +-
.../{proc_net_tcp.txt => proc_net_tcp.rst}| 23 +-
...iotap-headers.txt => radiotap-headers.rst} | 99 +-
.../networking/{ray_cs.txt => ray_cs.rst} | 101 +-
Documentation/networking/{rds.txt => rds.rst} | 295 +++--
.../{regulatory.txt => regulatory.rst}| 29 +-
.../networking/{rxrpc.txt => rxrpc.rst} | 306 ++---
.../networking/{sctp.txt => sctp.rst} | 37 +-
.../networking/{secid.txt => secid.rst} |6 +
Documentation/networking/seg6-sysctl.rst | 26 +
Documentation/networking/seg6-sysctl.txt | 18 -
.../networking/{skfp.txt => skfp.rst} | 153 ++-
.../{strparser.txt => strparser.rst} | 85 +-
.../{switchdev.txt => switchdev.rst} | 114 +-
.../networking/tc-act
[PATCH 07/37] docs: networking: convert netconsole.txt to ReST
- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- mark tables as such;
- add notes markups;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.
Signed-off-by: Mauro Carvalho Chehab
---
.../admin-guide/kernel-parameters.txt | 2 +-
Documentation/admin-guide/serial-console.rst | 2 +-
Documentation/networking/index.rst| 1 +
.../{netconsole.txt => netconsole.rst}| 125 +++---
drivers/net/Kconfig | 4 +-
drivers/net/ethernet/toshiba/ps3_gelic_net.c | 2 +-
drivers/net/ethernet/toshiba/spider_net.c | 2 +-
7 files changed, 84 insertions(+), 54 deletions(-)
rename Documentation/networking/{netconsole.txt => netconsole.rst} (66%)
diff --git a/Documentation/admin-guide/kernel-parameters.txt
b/Documentation/admin-guide/kernel-parameters.txt
index 25644daa36ea..5a44c1bf85e7 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -638,7 +638,7 @@
See Documentation/admin-guide/serial-console.rst for
more
information. See
- Documentation/networking/netconsole.txt for an
+ Documentation/networking/netconsole.rst for an
alternative.
uart[8250],io,[,options]
diff --git a/Documentation/admin-guide/serial-console.rst
b/Documentation/admin-guide/serial-console.rst
index a8d1e36b627a..58b32832e50a 100644
--- a/Documentation/admin-guide/serial-console.rst
+++ b/Documentation/admin-guide/serial-console.rst
@@ -54,7 +54,7 @@ You will need to create a new device to use ``/dev/console``.
The official
``/dev/console`` is now character device 5,1.
(You can also use a network device as a console. See
-``Documentation/networking/netconsole.txt`` for information on that.)
+``Documentation/networking/netconsole.rst`` for information on that.)
Here's an example that will use ``/dev/ttyS1`` (COM2) as the console.
Replace the sample values as needed.
diff --git a/Documentation/networking/index.rst
b/Documentation/networking/index.rst
index 492658bf7c0d..e58f872d401d 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -80,6 +80,7 @@ Contents:
mac80211-injection
mpls-sysctl
multiqueue
+ netconsole
.. only:: subproject and html
diff --git a/Documentation/networking/netconsole.txt
b/Documentation/networking/netconsole.rst
similarity index 66%
rename from Documentation/networking/netconsole.txt
rename to Documentation/networking/netconsole.rst
index 296ea00fd3eb..1f5c4a04027c 100644
--- a/Documentation/networking/netconsole.txt
+++ b/Documentation/networking/netconsole.rst
@@ -1,7 +1,16 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==
+Netconsole
+==
+
started by Ingo Molnar , 2001.09.17
+
2.6 port and netpoll api by Matt Mackall , Sep 9 2003
+
IPv6 support by Cong Wang , Jan 1 2013
+
Extended console support by Tejun Heo , May 1 2015
Please send bug reports to Matt Mackall
@@ -23,34 +32,34 @@ Sender and receiver configuration:
==
It takes a string configuration parameter "netconsole" in the
-following format:
+following format::
netconsole=[+][src-port]@[src-ip]/[],[tgt-port]@/[tgt-macaddr]
where
-+ if present, enable extended console support
-src-port source for UDP packets (defaults to 6665)
-src-ipsource IP to use (interface address)
-dev network interface (eth0)
-tgt-port port for logging agent ()
-tgt-ipIP address for logging agent
-tgt-macaddr ethernet MAC address for logging agent (broadcast)
+ + if present, enable extended console support
+ src-port source for UDP packets (defaults to 6665)
+ src-ipsource IP to use (interface address)
+ dev network interface (eth0)
+ tgt-port port for logging agent ()
+ tgt-ipIP address for logging agent
+ tgt-macaddr ethernet MAC address for logging agent (broadcast)
-Examples:
+Examples::
linux netconsole=@10.0.0.1/eth1,9353@10.0.0.2/12:34:56:78:9a:bc
- or
+or::
insmod netconsole netconsole=@/,@10.0.0.2/
- or using IPv6
+or using IPv6::
insmod netconsole netconsole=@/,@fd00:1:2:3::1/
It also supports logging to multiple remote agents by specifying
parameters for the multiple agents separated by semicolons and the
-complete string enclosed in "quotes", thusly:
+complete string enclosed in "quotes", thusly::
modprobe netconsole netconsole="@/,@10.0.0.2/;@/eth1,6892@10.0.0.3/"
@@ -67,14 +76,19 @@ for example:
On distributions using a BSD-based netcat version (e.g. Fedora,
openSUSE and Ubuntu) the listening port must be s
[PATCH 01/34] docs: filesystems: fix references for doc files there
Several files there were renamed to ReST. Fix the broken references. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-smaps_rollup | 2 +- Documentation/admin-guide/cpu-load.rst| 2 +- Documentation/admin-guide/nfs/nfsroot.rst | 2 +- Documentation/driver-api/driver-model/device.rst | 2 +- Documentation/driver-api/driver-model/overview.rst| 2 +- Documentation/filesystems/dax.txt | 2 +- Documentation/filesystems/dnotify.txt | 2 +- Documentation/filesystems/ramfs-rootfs-initramfs.rst | 2 +- Documentation/powerpc/firmware-assisted-dump.rst | 2 +- Documentation/process/adding-syscalls.rst | 2 +- .../translations/it_IT/process/adding-syscalls.rst| 2 +- Documentation/translations/zh_CN/filesystems/sysfs.txt| 6 +++--- drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h | 2 +- fs/Kconfig| 2 +- fs/Kconfig.binfmt | 2 +- fs/adfs/Kconfig | 2 +- fs/affs/Kconfig | 2 +- fs/afs/Kconfig| 6 +++--- fs/bfs/Kconfig| 2 +- fs/cramfs/Kconfig | 2 +- fs/ecryptfs/Kconfig | 2 +- fs/fat/Kconfig| 8 fs/fuse/Kconfig | 2 +- fs/fuse/dev.c | 2 +- fs/hfs/Kconfig| 2 +- fs/hpfs/Kconfig | 2 +- fs/isofs/Kconfig | 2 +- fs/namespace.c| 2 +- fs/notify/inotify/Kconfig | 2 +- fs/ntfs/Kconfig | 2 +- fs/ocfs2/Kconfig | 2 +- fs/overlayfs/Kconfig | 6 +++--- fs/proc/Kconfig | 4 ++-- fs/romfs/Kconfig | 2 +- fs/sysfs/dir.c| 2 +- fs/sysfs/file.c | 2 +- fs/sysfs/mount.c | 2 +- fs/sysfs/symlink.c| 2 +- fs/sysv/Kconfig | 2 +- fs/udf/Kconfig| 2 +- include/linux/relay.h | 2 +- include/linux/sysfs.h | 2 +- kernel/relay.c| 2 +- 44 files changed, 54 insertions(+), 54 deletions(-) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index df8413cf1468..484fc04bcc25 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -54,7 +54,7 @@ Date: October 2002 Contact: Linux Memory Management list Description: Provides information about the node's distribution and memory - utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.txt + utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.rst What: /sys/devices/system/node/nodeX/numastat Date: October 2002 diff --git a/Documentation/ABI/testing/procfs-smaps_rollup b/Documentation/ABI/testing/procfs-smaps_rollup index 274df44d8b1b..046978193368 100644 --- a/Documentation/ABI/testing/procfs-smaps_rollup +++ b/Documentation/ABI/testing/procfs-smaps_rollup @@ -11,7 +11,7 @@ Description: Additionally, the fields Pss_Anon, Pss_File and Pss_Shmem are not present in /proc/pid/smaps. These fields represent the sum of the Pss field of each type (anon, file, shmem). - For more details, see Documentation/filesystems/proc.txt + For more details, see Documentation/filesystems/proc.rst and the procfs man page. Typical output looks like this: diff --git a/Documentation/admin-guide/cpu-load.rst b/Documentation/admin-guide/cpu-load.rst index 2d01ce43d2a2..ebdecf864080 100644 --- a/Documentation/admin-guide/cpu-load.rst +++ b/Documentation/admin-guide/cpu-load.rst @@ -105,7 +105,7 @@ References -- - http://lkml.org/lkml/2007/2/12/6 -- Documentation/filesystems/proc.txt (1.8) +- Documentation/filesystems/proc.rst (1.8) Thanks diff --git a/Documentation/admin-guide/nfs/nfsroot.rst
[PATCH v2 09/33] docs: fix broken references to text files
Several references got broken due to txt to ReST conversion. Several of them can be automatically fixed with: scripts/documentation-file-ref-check --fix Reviewed-by: Mathieu Poirier # hwtracing/coresight/Kconfig Reviewed-by: Paul E. McKenney # memory-barrier.txt Acked-by: Alex Shi # translations/zh_CN Acked-by: Federico Vaga # translations/it_IT Acked-by: Marc Zyngier # kvm/arm64 Signed-off-by: Mauro Carvalho Chehab --- Documentation/memory-barriers.txt| 2 +- Documentation/process/submit-checklist.rst | 2 +- .../translations/it_IT/process/submit-checklist.rst | 2 +- Documentation/translations/ko_KR/memory-barriers.txt | 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/process/submit-checklist.rst | 2 +- Documentation/virt/kvm/arm/pvtime.rst| 2 +- Documentation/virt/kvm/devices/vcpu.rst | 2 +- Documentation/virt/kvm/hypercalls.rst| 4 ++-- arch/powerpc/include/uapi/asm/kvm_para.h | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/gpu/drm/drm_ioctl.c | 2 +- drivers/hwtracing/coresight/Kconfig | 2 +- fs/fat/Kconfig | 8 fs/fuse/Kconfig | 2 +- fs/fuse/dev.c| 2 +- fs/overlayfs/Kconfig | 6 +++--- include/linux/mm.h | 4 ++-- include/uapi/linux/ethtool_netlink.h | 2 +- include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +- mm/gup.c | 12 ++-- virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +- virt/kvm/arm/vgic/vgic.h | 4 ++-- 23 files changed, 36 insertions(+), 36 deletions(-) diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt index e1c355e84edd..eaabc3134294 100644 --- a/Documentation/memory-barriers.txt +++ b/Documentation/memory-barriers.txt @@ -620,7 +620,7 @@ because the CPUs that the Linux kernel supports don't do writes until they are certain (1) that the write will actually happen, (2) of the location of the write, and (3) of the value to be written. But please carefully read the "CONTROL DEPENDENCIES" section and the -Documentation/RCU/rcu_dereference.txt file: The compiler can and does +Documentation/RCU/rcu_dereference.rst file: The compiler can and does break dependencies in a great many highly creative ways. CPU 1 CPU 2 diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst index 8e56337d422d..3f8e9d5d95c2 100644 --- a/Documentation/process/submit-checklist.rst +++ b/Documentation/process/submit-checklist.rst @@ -107,7 +107,7 @@ and elsewhere regarding submitting Linux kernel patches. and why. 26) If any ioctl's are added by the patch, then also update -``Documentation/ioctl/ioctl-number.rst``. +``Documentation/userspace-api/ioctl/ioctl-number.rst``. 27) If your modified source code depends on or uses any of the kernel APIs or features that are related to the following ``Kconfig`` symbols, diff --git a/Documentation/translations/it_IT/process/submit-checklist.rst b/Documentation/translations/it_IT/process/submit-checklist.rst index 995ee69fab11..3e575502690f 100644 --- a/Documentation/translations/it_IT/process/submit-checklist.rst +++ b/Documentation/translations/it_IT/process/submit-checklist.rst @@ -117,7 +117,7 @@ sottomissione delle patch, in particolare sorgenti che ne spieghi la logica: cosa fanno e perché. 25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate -``Documentation/ioctl/ioctl-number.rst``. +``Documentation/userspace-api/ioctl/ioctl-number.rst``. 26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o funzionalità del kernel che è associata a uno dei seguenti simboli diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt index 2e831ece6e26..e50fe6541335 100644 --- a/Documentation/translations/ko_KR/memory-barriers.txt +++ b/Documentation/translations/ko_KR/memory-barriers.txt @@ -641,7 +641,7 @@ P 는 짝수 번호 캐시 라인에 저장되어 있고, 변수 B 는 홀수 리눅스 커널이 지원하는 CPU 들은 (1) 쓰기가 정말로 일어날지, (2) 쓰기가 어디에 이루어질지, 그리고 (3) 쓰여질 값을 확실히 알기 전까지는 쓰기를 수행하지 않기 때문입니다. 하지만 "컨트롤 의존성" 섹션과 -Documentation/RCU/rcu_dereference.txt 파일을 주의 깊게 읽어 주시기 바랍니다: +Documentation/RCU/rcu_dereference.rst 파일을 주의 깊게 읽어 주시기 바랍니다: 컴파일러는 매우 창의적인 많은 방법으로 종속성을 깰 수 있습니다. CPU 1 CPU 2 diff --git a/Documentation/translations/zh_CN/filesystems/sysfs.txt b/Documentation/translations/zh_CN/filesystems/sysfs.txt index ee1f37da5b23..a15c3ebdfa82 100644 --- a/Documentation/translations/zh_CN/f
[PATCH v2 00/33] Documentation fixes for Kernel 5.8
Patches 1 to 5 contain changes to the documentation toolset:
- The first 3 patches help to reduce a lot the number of reported
kernel-doc issues, by making the tool more smart.
- Patches 4 and 5 are meant to partially address the PDF
build, with now requires Sphinx version 2.4 or upper.
The remaining patches fix broken references detected by
this tool:
./scripts/documentation-file-ref-check
and address other random errors due to tags being mis-interpreted
or mis-used.
They are independent each other, but some may depend on
the kernel-doc improvements.
PS.: Due to the large number of C/C, I opted to keep a smaller
set of C/C at this first e-mail (only e-mails with "L:" tag from
MAINTAINERS file).
Jon,
Those patches should apply cleanly at docs-next, once you
pull from v5.7-rc1.
-
v2:
- patches re-ordered;
- added reviewed/acked-by tags;
- rebased on the top of docs-next + v5.7-rc1.
Mauro Carvalho Chehab (33):
scripts: kernel-doc: proper handle @foo->bar()
scripts: kernel-doc: accept negation like !@var
scripts: kernel-doc: accept blank lines on parameter description
docs: update recommended Sphinx version to 2.4.4
docs: LaTeX/PDF: drop list of documents
MAINTAINERS: dt: update display/allwinner file entry
MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and
RealView
docs: dt: fix broken reference to phy-cadence-torrent.yaml
docs: fix broken references to text files
docs: fix broken references for ReST files that moved around
docs: filesystems: fix renamed references
docs: amu: supress some Sphinx warnings
docs: arm64: booting.rst: get rid of some warnings
docs: pci: boot-interrupts.rst: improve html output
docs: ras: get rid of some warnings
docs: ras: don't need to repeat twice the same thing
docs: infiniband: verbs.c: fix some documentation warnings
docs: spi: spi.h: fix a doc building warning
docs: drivers: fix some warnings at base/platform.c when building docs
docs: mm: userfaultfd.rst: use ``foo`` for literals
docs: mm: userfaultfd.rst: use a cross-reference for a section
docs: vm: index.rst: add an orphan doc to the building system
docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file
docs: dt: fix a broken reference for a file converted to json
docs: powerpc: cxl.rst: mark two section titles as such
docs: i2c: rename i2c.svg to i2c_bus.svg
docs: Makefile: place final pdf docs on a separate dir
docs: dt: rockchip,dwc3.txt: fix a pointer to a renamed file
ata: libata-core: fix a doc warning
firewire: firewire-cdev.hL get rid of a docs warning
fs: inode.c: get rid of docs warnings
futex: get rid of a kernel-docs build warning
lib: bitmap.c: get rid of some doc warnings
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-smaps_rollup | 2 +-
Documentation/Makefile| 6 +-
Documentation/PCI/boot-interrupts.rst | 34 +--
Documentation/admin-guide/cpu-load.rst| 2 +-
Documentation/admin-guide/mm/userfaultfd.rst | 209 +-
Documentation/admin-guide/nfs/nfsroot.rst | 2 +-
Documentation/admin-guide/ras.rst | 18 +-
Documentation/arm64/amu.rst | 5 +
Documentation/arm64/booting.rst | 36 +--
Documentation/conf.py | 38
.../bindings/net/qualcomm-bluetooth.txt | 2 +-
.../bindings/phy/ti,phy-j721e-wiz.yaml| 2 +-
.../devicetree/bindings/usb/qcom,dwc3.txt | 4 +-
.../devicetree/bindings/usb/rockchip,dwc3.txt | 2 +-
.../doc-guide/maintainer-profile.rst | 2 +-
.../driver-api/driver-model/device.rst| 4 +-
.../driver-api/driver-model/overview.rst | 2 +-
Documentation/filesystems/dax.txt | 2 +-
Documentation/filesystems/dnotify.txt | 2 +-
.../filesystems/ramfs-rootfs-initramfs.rst| 2 +-
Documentation/filesystems/sysfs.rst | 2 +-
Documentation/i2c/{i2c.svg => i2c_bus.svg}| 2 +-
Documentation/i2c/summary.rst | 2 +-
Documentation/memory-barriers.txt | 2 +-
Documentation/powerpc/cxl.rst | 2 +
.../powerpc/firmware-assisted-dump.rst| 2 +-
Documentation/process/adding-syscalls.rst | 2 +-
Documentation/process/submit-checklist.rst| 2 +-
Documentation/sphinx/requirements.txt | 2 +-
.../it_IT/process/adding-syscalls.rst | 2 +-
.../it_IT/process/submit-checklist.rst| 2 +-
.../translations/ko_KR/memory-barriers.txt| 2 +-
.../translations/zh_CN/filesystems/sysfs.txt | 8 +-
.../zh_CN/process/submit-checklist.rst| 2 +-
Documentation/virt/kvm/arm/pvtime.rst | 2 +-
Documentation/virt/kvm/devices/vcpu.rst | 2 +-
Documentation/virt/kvm/hypercalls.rst | 4 +-
Documentation/virt/kvm/mmu.rst| 2 +-
Documentation/virt/kvm/review-check
[PATCH v2 25/33] docs: powerpc: cxl.rst: mark two section titles as such
The User API chapter contains two sub-chapters. Mark them as such. Signed-off-by: Mauro Carvalho Chehab --- Documentation/powerpc/cxl.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst index 920546d81326..d2d77057610e 100644 --- a/Documentation/powerpc/cxl.rst +++ b/Documentation/powerpc/cxl.rst @@ -133,6 +133,7 @@ User API 1. AFU character devices + For AFUs operating in AFU directed mode, two character device files will be created. /dev/cxl/afu0.0m will correspond to a @@ -395,6 +396,7 @@ read 2. Card character device (powerVM guest only) +^ In a powerVM guest, an extra character device is created for the card. The device is only used to write (flash) a new image on the -- 2.25.2
[PATCH v2 11/33] docs: filesystems: fix renamed references
Some filesystem references got broken by a previous patch series I submitted. Address those. Signed-off-by: Mauro Carvalho Chehab Acked-by: David Sterba # fs/affs/Kconfig --- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-smaps_rollup | 2 +- Documentation/admin-guide/cpu-load.rst | 2 +- Documentation/admin-guide/nfs/nfsroot.rst | 2 +- Documentation/driver-api/driver-model/device.rst| 4 ++-- Documentation/driver-api/driver-model/overview.rst | 2 +- Documentation/filesystems/dax.txt | 2 +- Documentation/filesystems/dnotify.txt | 2 +- Documentation/filesystems/ramfs-rootfs-initramfs.rst| 2 +- Documentation/filesystems/sysfs.rst | 2 +- Documentation/powerpc/firmware-assisted-dump.rst| 2 +- Documentation/process/adding-syscalls.rst | 2 +- .../translations/it_IT/process/adding-syscalls.rst | 2 +- Documentation/translations/zh_CN/filesystems/sysfs.txt | 6 +++--- drivers/base/core.c | 2 +- drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h | 2 +- fs/Kconfig | 2 +- fs/Kconfig.binfmt | 2 +- fs/adfs/Kconfig | 2 +- fs/affs/Kconfig | 2 +- fs/afs/Kconfig | 6 +++--- fs/bfs/Kconfig | 2 +- fs/cramfs/Kconfig | 2 +- fs/ecryptfs/Kconfig | 2 +- fs/hfs/Kconfig | 2 +- fs/hpfs/Kconfig | 2 +- fs/isofs/Kconfig| 2 +- fs/namespace.c | 2 +- fs/notify/inotify/Kconfig | 2 +- fs/ntfs/Kconfig | 2 +- fs/ocfs2/Kconfig| 2 +- fs/proc/Kconfig | 4 ++-- fs/romfs/Kconfig| 2 +- fs/sysfs/dir.c | 2 +- fs/sysfs/file.c | 2 +- fs/sysfs/mount.c| 2 +- fs/sysfs/symlink.c | 2 +- fs/sysv/Kconfig | 2 +- fs/udf/Kconfig | 2 +- include/linux/kobject.h | 2 +- include/linux/kobject_ns.h | 2 +- include/linux/relay.h | 2 +- include/linux/sysfs.h | 2 +- kernel/relay.c | 2 +- lib/kobject.c | 4 ++-- 45 files changed, 52 insertions(+), 52 deletions(-) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index df8413cf1468..484fc04bcc25 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -54,7 +54,7 @@ Date: October 2002 Contact: Linux Memory Management list Description: Provides information about the node's distribution and memory - utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.txt + utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.rst What: /sys/devices/system/node/nodeX/numastat Date: October 2002 diff --git a/Documentation/ABI/testing/procfs-smaps_rollup b/Documentation/ABI/testing/procfs-smaps_rollup index 274df44d8b1b..046978193368 100644 --- a/Documentation/ABI/testing/procfs-smaps_rollup +++ b/Documentation/ABI/testing/procfs-smaps_rollup @@ -11,7 +11,7 @@ Description: Additionally, the fields Pss_Anon, Pss_File and Pss_Shmem are not present in /proc/pid/smaps. These fields represent the sum of the Pss field of each type (anon, file, shmem). - For more details, see Documentation/filesystems/proc.txt + For more details, see Documentation/filesystems/proc.rst and the procfs man page. Typical output looks like this: diff --git a/Documentation/admin-guide/cpu-load.rst b/Documentation/admin-guide/cpu-load.rst index 2d01ce43d2a2..ebdecf864080 100644 --- a/Documentation/admin-guide/cpu-load.rst +++ b/Documentation/admin-guide/cpu-load.rst @@ -105,7 +105,7
[PATCH 11/12] docs: filesystems: fix renamed references
Some filesystem references got broken by a previous patch series I submitted. Address those. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-smaps_rollup | 2 +- Documentation/admin-guide/cpu-load.rst| 2 +- .../admin-guide/kernel-parameters.txt | 2 +- Documentation/admin-guide/nfs/nfsroot.rst | 2 +- .../driver-api/driver-model/device.rst| 4 +- .../driver-api/driver-model/overview.rst | 2 +- Documentation/filesystems/dax.txt | 2 +- Documentation/filesystems/dnotify.txt | 2 +- .../filesystems/ramfs-rootfs-initramfs.rst| 2 +- Documentation/filesystems/sysfs.rst | 2 +- .../powerpc/firmware-assisted-dump.rst| 2 +- Documentation/process/adding-syscalls.rst | 2 +- .../it_IT/process/adding-syscalls.rst | 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 6 +-- MAINTAINERS | 54 +-- Next/merge.log| 12 ++--- drivers/base/core.c | 2 +- drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h | 2 +- fs/Kconfig| 2 +- fs/Kconfig.binfmt | 2 +- fs/adfs/Kconfig | 2 +- fs/affs/Kconfig | 2 +- fs/afs/Kconfig| 6 +-- fs/bfs/Kconfig| 2 +- fs/cramfs/Kconfig | 2 +- fs/ecryptfs/Kconfig | 2 +- fs/hfs/Kconfig| 2 +- fs/hpfs/Kconfig | 2 +- fs/isofs/Kconfig | 2 +- fs/namespace.c| 2 +- fs/notify/inotify/Kconfig | 2 +- fs/ntfs/Kconfig | 2 +- fs/ocfs2/Kconfig | 2 +- fs/proc/Kconfig | 4 +- fs/romfs/Kconfig | 2 +- fs/sysfs/dir.c| 2 +- fs/sysfs/file.c | 2 +- fs/sysfs/mount.c | 2 +- fs/sysfs/symlink.c| 2 +- fs/sysv/Kconfig | 2 +- fs/udf/Kconfig| 2 +- include/linux/kobject.h | 2 +- include/linux/kobject_ns.h| 2 +- include/linux/relay.h | 2 +- include/linux/sysfs.h | 2 +- kernel/relay.c| 2 +- lib/kobject.c | 4 +- 48 files changed, 86 insertions(+), 86 deletions(-) diff --git a/Documentation/ABI/stable/sysfs-devices-node b/Documentation/ABI/stable/sysfs-devices-node index df8413cf1468..484fc04bcc25 100644 --- a/Documentation/ABI/stable/sysfs-devices-node +++ b/Documentation/ABI/stable/sysfs-devices-node @@ -54,7 +54,7 @@ Date: October 2002 Contact: Linux Memory Management list Description: Provides information about the node's distribution and memory - utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.txt + utilization. Similar to /proc/meminfo, see Documentation/filesystems/proc.rst What: /sys/devices/system/node/nodeX/numastat Date: October 2002 diff --git a/Documentation/ABI/testing/procfs-smaps_rollup b/Documentation/ABI/testing/procfs-smaps_rollup index 274df44d8b1b..046978193368 100644 --- a/Documentation/ABI/testing/procfs-smaps_rollup +++ b/Documentation/ABI/testing/procfs-smaps_rollup @@ -11,7 +11,7 @@ Description: Additionally, the fields Pss_Anon, Pss_File and Pss_Shmem are not present in /proc/pid/smaps. These fields represent the sum of the Pss field of each type (anon, file, shmem). - For more details, see Documentation/filesystems/proc.txt + For more details, see Documentation/filesystems/proc.rst and the procfs man page. Typical output looks like this: diff --git a/Documentation/admin-guide/cpu-load.rst b/Documentation/admin-guide/cpu-load.rst index 2d01ce43d2a2..ebdecf864080 100644 --- a/Documentation/admin-guide/cpu-load.rst +++ b/Documentation/admin-guide/cpu-load.rst @@ -105,7 +105,7 @@ References -- - http://lkml.org/lkml/2007/2/12/6 -- Documentation/filesystems/proc.txt (1.8) +- Documentation/filesystems/proc.rst (1.8) Thanks diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index 28be91d4e66b..192a36a66fc9 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -683,7 +683,7
[PATCH 08/12] docs: fix broken references to text files
Several references got broken due to txt to ReST conversion. Several of them can be automatically fixed with: scripts/documentation-file-ref-check --fix Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/kernel-parameters.txt | 2 +- Documentation/memory-barriers.txt| 2 +- Documentation/process/submit-checklist.rst | 2 +- .../translations/it_IT/process/submit-checklist.rst | 2 +- Documentation/translations/ko_KR/memory-barriers.txt | 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 2 +- .../translations/zh_CN/process/submit-checklist.rst | 2 +- Documentation/virt/kvm/arm/pvtime.rst| 2 +- Documentation/virt/kvm/devices/vcpu.rst | 2 +- Documentation/virt/kvm/hypercalls.rst| 4 ++-- arch/powerpc/include/uapi/asm/kvm_para.h | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/gpu/drm/drm_ioctl.c | 2 +- drivers/hwtracing/coresight/Kconfig | 2 +- fs/fat/Kconfig | 8 fs/fuse/Kconfig | 2 +- fs/fuse/dev.c| 2 +- fs/overlayfs/Kconfig | 6 +++--- include/linux/mm.h | 4 ++-- include/uapi/linux/ethtool_netlink.h | 2 +- include/uapi/rdma/rdma_user_ioctl_cmds.h | 2 +- mm/gup.c | 12 ++-- virt/kvm/arm/vgic/vgic-mmio-v3.c | 2 +- virt/kvm/arm/vgic/vgic.h | 4 ++-- 24 files changed, 37 insertions(+), 37 deletions(-) diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index df34a4176e58..28be91d4e66b 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -960,7 +960,7 @@ edid/1680x1050.bin, or edid/1920x1080.bin is given and no file with the same name exists. Details and instructions how to build your own EDID data are - available in Documentation/driver-api/edid.rst. An EDID + available in Documentation/admin-guide/edid.rst. An EDID data set will only be used for a particular connector, if its name and a colon are prepended to the EDID name. Each connector may use a unique EDID data diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt index e1c355e84edd..eaabc3134294 100644 --- a/Documentation/memory-barriers.txt +++ b/Documentation/memory-barriers.txt @@ -620,7 +620,7 @@ because the CPUs that the Linux kernel supports don't do writes until they are certain (1) that the write will actually happen, (2) of the location of the write, and (3) of the value to be written. But please carefully read the "CONTROL DEPENDENCIES" section and the -Documentation/RCU/rcu_dereference.txt file: The compiler can and does +Documentation/RCU/rcu_dereference.rst file: The compiler can and does break dependencies in a great many highly creative ways. CPU 1 CPU 2 diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst index 8e56337d422d..3f8e9d5d95c2 100644 --- a/Documentation/process/submit-checklist.rst +++ b/Documentation/process/submit-checklist.rst @@ -107,7 +107,7 @@ and elsewhere regarding submitting Linux kernel patches. and why. 26) If any ioctl's are added by the patch, then also update -``Documentation/ioctl/ioctl-number.rst``. +``Documentation/userspace-api/ioctl/ioctl-number.rst``. 27) If your modified source code depends on or uses any of the kernel APIs or features that are related to the following ``Kconfig`` symbols, diff --git a/Documentation/translations/it_IT/process/submit-checklist.rst b/Documentation/translations/it_IT/process/submit-checklist.rst index 995ee69fab11..3e575502690f 100644 --- a/Documentation/translations/it_IT/process/submit-checklist.rst +++ b/Documentation/translations/it_IT/process/submit-checklist.rst @@ -117,7 +117,7 @@ sottomissione delle patch, in particolare sorgenti che ne spieghi la logica: cosa fanno e perché. 25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate -``Documentation/ioctl/ioctl-number.rst``. +``Documentation/userspace-api/ioctl/ioctl-number.rst``. 26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o funzionalità del kernel che è associata a uno dei seguenti simboli diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt index 2e831ece6e26..e50fe6541
[PATCH 00/12] Fix broken references for Documentation/*
This patch series is against next-20200317. It fixes all references to files under Documentation/* that were moved, renamed or removed. After this patch series, this script: ./scripts/documentation-file-ref-check Doesn't complain about any broken reference. Mauro Carvalho Chehab (12): MAINTAINERS: dt: update display/allwinner file entry MAINTAINERS: dt: update etnaviv file reference MAINTAINERS: drop an old reference to stm32 pwm timers doc docs: dt: fix references to m_can.txt file docs: dt: fix references to ap806-system-controller.txt docs: dt: fix a broken reference to input.yaml docs: dt: fix broken reference to phy-cadence-torrent.yaml docs: fix broken references to text files docs: fix broken references for ReST files that moved around docs: dt: display/ti: fix typos at the devicetree/ directory name docs: filesystems: fix renamed references docs: kernel-parameters.txt: remove reference for removed Intel MPX Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-smaps_rollup | 2 +- Documentation/admin-guide/cpu-load.rst| 2 +- .../admin-guide/kernel-parameters.txt | 11 ++-- Documentation/admin-guide/nfs/nfsroot.rst | 2 +- .../bindings/arm/freescale/fsl,scu.txt| 2 +- .../bindings/display/ti/ti,am65x-dss.yaml | 2 +- .../bindings/display/ti/ti,j721e-dss.yaml | 2 +- .../bindings/display/ti/ti,k2g-dss.yaml | 2 +- .../devicetree/bindings/gpio/gpio-mvebu.txt | 2 +- .../devicetree/bindings/net/can/tcan4x5x.txt | 2 +- .../bindings/phy/ti,phy-j721e-wiz.yaml| 2 +- .../bindings/thermal/armada-thermal.txt | 2 +- .../doc-guide/maintainer-profile.rst | 2 +- .../driver-api/driver-model/device.rst| 4 +- .../driver-api/driver-model/overview.rst | 2 +- Documentation/filesystems/dax.txt | 2 +- Documentation/filesystems/dnotify.txt | 2 +- .../filesystems/ramfs-rootfs-initramfs.rst| 2 +- Documentation/filesystems/sysfs.rst | 2 +- Documentation/memory-barriers.txt | 2 +- .../powerpc/firmware-assisted-dump.rst| 2 +- Documentation/process/adding-syscalls.rst | 2 +- Documentation/process/submit-checklist.rst| 2 +- .../it_IT/process/adding-syscalls.rst | 2 +- .../it_IT/process/submit-checklist.rst| 2 +- .../translations/ko_KR/memory-barriers.txt| 2 +- .../translations/zh_CN/filesystems/sysfs.txt | 8 +-- .../zh_CN/process/submit-checklist.rst| 2 +- Documentation/virt/kvm/arm/pvtime.rst | 2 +- Documentation/virt/kvm/devices/vcpu.rst | 2 +- Documentation/virt/kvm/hypercalls.rst | 4 +- Documentation/virt/kvm/mmu.rst| 2 +- Documentation/virt/kvm/review-checklist.rst | 2 +- MAINTAINERS | 61 +-- Next/merge.log| 12 ++-- arch/powerpc/include/uapi/asm/kvm_para.h | 2 +- arch/x86/kvm/mmu/mmu.c| 2 +- drivers/base/core.c | 2 +- .../allwinner/sun8i-ce/sun8i-ce-cipher.c | 2 +- .../crypto/allwinner/sun8i-ce/sun8i-ce-core.c | 2 +- .../allwinner/sun8i-ss/sun8i-ss-cipher.c | 2 +- .../crypto/allwinner/sun8i-ss/sun8i-ss-core.c | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/gpu/drm/drm_ioctl.c | 2 +- drivers/gpu/drm/msm/disp/dpu1/dpu_kms.h | 2 +- drivers/hwtracing/coresight/Kconfig | 2 +- drivers/media/v4l2-core/v4l2-fwnode.c | 2 +- fs/Kconfig| 2 +- fs/Kconfig.binfmt | 2 +- fs/adfs/Kconfig | 2 +- fs/affs/Kconfig | 2 +- fs/afs/Kconfig| 6 +- fs/bfs/Kconfig| 2 +- fs/cramfs/Kconfig | 2 +- fs/ecryptfs/Kconfig | 2 +- fs/fat/Kconfig| 8 +-- fs/fuse/Kconfig | 2 +- fs/fuse/dev.c | 2 +- fs/hfs/Kconfig| 2 +- fs/hpfs/Kconfig | 2 +- fs/isofs/Kconfig | 2 +- fs/namespace.c| 2 +- fs/notify/inotify/Kconfig | 2 +- fs/ntfs/Kconfig | 2 +- fs/ocfs2/Kconfig | 2 +- fs/overlayfs/Kconfig | 6 +- fs/proc/Kconfig | 4 +- fs/romfs/Kconfig | 2 +- fs/sysfs/dir.c| 2 +- fs/sysfs/file.c | 2 +- fs/sysfs/mount.c | 2 +- fs/sysfs/symlink.c
[PATCH v2 0/2] Don't generate thousands of new warnings when building docs
This small series address a regression caused by a new patch at
docs-next (and at linux-next).
Before this patch, when a cross-reference to a chapter within the
documentation is needed, we had to add a markup like:
.. _foo:
foo
===
This behavor is now different after this patch:
58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
As a Sphinx extension now creates automatically a reference
like the above, without requiring any extra markup.
That, however, comes with a price: it is not possible anymore to have
two sections with the same name within the entire Kernel docs!
This causes thousands of warnings, as we have sections named
"introduction" on lots of places.
This series solve this regression by doing two changes:
1) The references are now prefixed by the document name. So,
a file named "bar" would have the "foo" reference as "bar:foo".
2) It will only use the first two levels. The first one is (usually) the
name of the document, and the second one the chapter name.
This solves almost all problems we have. Still, there are a few places
where we have two chapters at the same document with the
same name. The first patch addresses this problem.
The second patch limits the escope of the autosectionlabel.
Mauro Carvalho Chehab (2):
docs: prevent warnings due to autosectionlabel
docs: conf.py: avoid thousands of duplicate label warning on Sphinx
Documentation/conf.py | 4
Documentation/driver-api/80211/mac80211-advanced.rst | 8
Documentation/driver-api/dmaengine/index.rst | 4 ++--
Documentation/filesystems/ecryptfs.rst| 11 +--
Documentation/kernel-hacking/hacking.rst | 4 ++--
Documentation/media/kapi/v4l2-controls.rst| 8
Documentation/networking/snmp_counter.rst | 4 ++--
Documentation/powerpc/ultravisor.rst | 4 ++--
Documentation/security/siphash.rst| 8
Documentation/target/tcmu-design.rst | 6 +++---
.../translations/zh_CN/process/5.Posting.rst | 2 +-
Documentation/x86/intel-iommu.rst | 3 ++-
12 files changed, 35 insertions(+), 31 deletions(-)
--
2.24.1
[PATCH v2 1/2] docs: prevent warnings due to autosectionlabel
Changeset 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
enabled a new feature at Sphinx: it will now generate index for each
document title, plus to each chapter inside it.
There's a drawback, though: one document cannot have two sections
with the same name anymore.
A followup patch will change the logic of autosectionlabel to
avoid most creating references for every single section title,
but still we need to be able to reference the chapters inside
a document.
There are a few places where there are two chapters with the
same name. This patch renames one of the chapters, in order to
avoid symbol conflict within the same document.
PS.: as I don't speach Chinese, I had some help from a friend
(Wen Liu) at the Chinese translation for "publishing patches"
for this document:
Documentation/translations/zh_CN/process/5.Posting.rst
Fixes: 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/driver-api/80211/mac80211-advanced.rst | 8
Documentation/driver-api/dmaengine/index.rst | 4 ++--
Documentation/filesystems/ecryptfs.rst| 11 +--
Documentation/kernel-hacking/hacking.rst | 4 ++--
Documentation/media/kapi/v4l2-controls.rst| 8
Documentation/networking/snmp_counter.rst | 4 ++--
Documentation/powerpc/ultravisor.rst | 4 ++--
Documentation/security/siphash.rst| 8
Documentation/target/tcmu-design.rst | 6 +++---
.../translations/zh_CN/process/5.Posting.rst | 2 +-
Documentation/x86/intel-iommu.rst | 3 ++-
11 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/Documentation/driver-api/80211/mac80211-advanced.rst
b/Documentation/driver-api/80211/mac80211-advanced.rst
index 9f1c5bb7ac35..24cb64b3b715 100644
--- a/Documentation/driver-api/80211/mac80211-advanced.rst
+++ b/Documentation/driver-api/80211/mac80211-advanced.rst
@@ -272,8 +272,8 @@ STA information lifetime rules
.. kernel-doc:: net/mac80211/sta_info.c
:doc: STA information lifetime rules
-Aggregation
-===
+Aggregation Functions
+=
.. kernel-doc:: net/mac80211/sta_info.h
:functions: sta_ampdu_mlme
@@ -284,8 +284,8 @@ Aggregation
.. kernel-doc:: net/mac80211/sta_info.h
:functions: tid_ampdu_rx
-Synchronisation
-===
+Synchronisation Functions
+=
TBD
diff --git a/Documentation/driver-api/dmaengine/index.rst
b/Documentation/driver-api/dmaengine/index.rst
index b9df904d0a79..bdc45d8b4cfb 100644
--- a/Documentation/driver-api/dmaengine/index.rst
+++ b/Documentation/driver-api/dmaengine/index.rst
@@ -5,8 +5,8 @@ DMAEngine documentation
DMAEngine documentation provides documents for various aspects of DMAEngine
framework.
-DMAEngine documentation
+DMAEngine development documentation
+---
This book helps with DMAengine internal APIs and guide for DMAEngine device
driver writers.
diff --git a/Documentation/filesystems/ecryptfs.rst
b/Documentation/filesystems/ecryptfs.rst
index 7236172300ef..1f2edef4c57a 100644
--- a/Documentation/filesystems/ecryptfs.rst
+++ b/Documentation/filesystems/ecryptfs.rst
@@ -30,13 +30,12 @@ Userspace requirements include:
- Libgcrypt
-Notes
-=
+.. note::
-In the beta/experimental releases of eCryptfs, when you upgrade
-eCryptfs, you should copy the files to an unencrypted location and
-then copy the files back into the new eCryptfs mount to migrate the
-files.
+ In the beta/experimental releases of eCryptfs, when you upgrade
+ eCryptfs, you should copy the files to an unencrypted location and
+ then copy the files back into the new eCryptfs mount to migrate the
+ files.
Mount-wide Passphrase
diff --git a/Documentation/kernel-hacking/hacking.rst
b/Documentation/kernel-hacking/hacking.rst
index d707a0a61cc9..eed2136d847f 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -601,7 +601,7 @@ Defined in ``include/linux/export.h``
This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol
namespace. Symbol Namespaces are documented in
-:ref:`Documentation/core-api/symbol-namespaces.rst `
+:doc:`../core-api/symbol-namespaces`
:c:func:`EXPORT_SYMBOL_NS_GPL()`
@@ -610,7 +610,7 @@ Defined in ``include/linux/export.h``
This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol
namespace. Symbol Namespaces are documented in
-:ref:`Documentation/core-api/symbol-namespaces.rst `
+:doc:`../core-api/symbol-namespaces`
Routines and Conventions
diff --git a/Documentation/media/kapi/v4l2-controls.rst
b/Documentation/media/kapi/v4l2-controls.rst
index b20800cae3f2..5129019afb49 100644
--- a
Re: [trivial PATCH] treewide: Convert switch/case fallthrough; to break;
Em Wed, 09 Sep 2020 13:06:39 -0700
Joe Perches escreveu:
> fallthrough to a separate case/default label break; isn't very readable.
>
> Convert pseudo-keyword fallthrough; statements to a simple break; when
> the next label is case or default and the only statement in the next
> label block is break;
>
> Found using:
>
> $ grep-2.5.4 -rP --include=*.[ch] -n
> "fallthrough;(\s*(case\s+\w+|default)\s*:\s*){1,7}break;" *
>
> Miscellanea:
>
> o Move or coalesce a couple label blocks above a default: block.
>
> Signed-off-by: Joe Perches
> ---
>
> Compiled allyesconfig x86-64 only.
> A few files for other arches were not compiled.
>
> drivers/media/dvb-frontends/drxd_hard.c | 2 +-
> drivers/media/i2c/ov5640.c| 2 +-
> drivers/media/i2c/ov6650.c| 5 ++---
> drivers/media/i2c/smiapp/smiapp-core.c| 2 +-
> drivers/media/i2c/tvp5150.c | 2 +-
> drivers/media/pci/ddbridge/ddbridge-core.c| 2 +-
> drivers/media/usb/cpia2/cpia2_core.c | 2 +-
For media drivers:
Reviewed-by: Mauro Carvalho Chehab
Thanks,
Mauro
[PATCH v6 59/80] docs: powerpc: syscall64-abi.rst: fix a malformed table
As reported: Documentation/powerpc/syscall64-abi.rst:53: WARNING: Malformed table. Text in column margin in table line 2. === = --- For the sc instruction, differences with the ELF ABI --- r0 Volatile (System call number.) This table requires a different notation to be valid. Signed-off-by: Mauro Carvalho Chehab --- Documentation/powerpc/syscall64-abi.rst | 32 - 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/Documentation/powerpc/syscall64-abi.rst b/Documentation/powerpc/syscall64-abi.rst index 379817ca64d2..cf9b2857c72a 100644 --- a/Documentation/powerpc/syscall64-abi.rst +++ b/Documentation/powerpc/syscall64-abi.rst @@ -49,22 +49,22 @@ Register preservation rules Register preservation rules match the ELF ABI calling sequence with the following differences: For the sc instruction, differences with the ELF ABI --- -=== = -r0 Volatile (System call number.) -r3 Volatile (Parameter 1, and return value.) -r4-r8 Volatile (Parameters 2-6.) -cr0 Volatile (cr0.SO is the return error condition.) -cr1, cr5-7 Nonvolatile -lr Nonvolatile -=== = - For the scv 0 instruction, differences with the ELF ABI --- -=== = -r0 Volatile (System call number.) -r3 Volatile (Parameter 1, and return value.) -r4-r8 Volatile (Parameters 2-6.) -=== = +++ +|For the sc instruction, differences with the ELF ABI | ++--+--+--+ +| r0 | Volatile | (System call number.) | +| rr3 | Volatile | (Parameter 1, and return value.)| +| rr4-r8 | Volatile | (Parameters 2-6.) | +| rcr0 | Volatile | (cr0.SO is the return error condition.) | +| rcr1, cr5-7 | Nonvolatile | | +| rlr | Nonvolatile | | ++--+--+--+ +| For the scv 0 instruction, differences with the ELF ABI | ++--+--+--+ +| r0 | Volatile | (System call number.) | +| r3 | Volatile | (Parameter 1, and return value.)| +| r4-r8| Volatile | (Parameters 2-6.) | ++--+--+--+ All floating point and vector data registers as well as control and status registers are nonvolatile. -- 2.26.2
[PATCH 19/33] docs: ABI: stable: make files ReST compatible
From: Mauro Carvalho Chehab Several entries at the stable ABI files won't parse if we pass them directly to the ReST output. Adjust them, in order to allow adding their contents as-is at the stable ABI book. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/stable/firewire-cdev| 4 + Documentation/ABI/stable/sysfs-acpi-pmprofile | 22 +++-- Documentation/ABI/stable/sysfs-bus-firewire | 3 + Documentation/ABI/stable/sysfs-bus-nvmem | 19 ++-- Documentation/ABI/stable/sysfs-bus-usb| 6 +- .../ABI/stable/sysfs-class-backlight | 1 + .../ABI/stable/sysfs-class-infiniband | 93 +-- Documentation/ABI/stable/sysfs-class-rfkill | 13 ++- Documentation/ABI/stable/sysfs-class-tpm | 90 +- Documentation/ABI/stable/sysfs-devices| 5 +- Documentation/ABI/stable/sysfs-driver-ib_srp | 1 + .../ABI/stable/sysfs-firmware-efi-vars| 4 + .../ABI/stable/sysfs-firmware-opal-dump | 5 + .../ABI/stable/sysfs-firmware-opal-elog | 2 + Documentation/ABI/stable/sysfs-hypervisor-xen | 3 + Documentation/ABI/stable/vdso | 5 +- 16 files changed, 176 insertions(+), 100 deletions(-) diff --git a/Documentation/ABI/stable/firewire-cdev b/Documentation/ABI/stable/firewire-cdev index f72ed653878a..c9e8ff026154 100644 --- a/Documentation/ABI/stable/firewire-cdev +++ b/Documentation/ABI/stable/firewire-cdev @@ -14,12 +14,14 @@ Description: Each /dev/fw* is associated with one IEEE 1394 node, which can be remote or local nodes. Operations on a /dev/fw* file have different scope: + - The 1394 node which is associated with the file: - Asynchronous request transmission - Get the Configuration ROM - Query node ID - Query maximum speed of the path between this node and local node + - The 1394 bus (i.e. "card") to which the node is attached to: - Isochronous stream transmission and reception - Asynchronous stream transmission and reception @@ -31,6 +33,7 @@ Description: manager - Query cycle time - Bus reset initiation, bus reset event reception + - All 1394 buses: - Allocation of IEEE 1212 address ranges on the local link layers, reception of inbound requests to such @@ -43,6 +46,7 @@ Description: userland implement different access permission models, some operations are restricted to /dev/fw* files that are associated with a local node: + - Addition of descriptors or directories to the local nodes' Configuration ROM - PHY packet transmission and reception diff --git a/Documentation/ABI/stable/sysfs-acpi-pmprofile b/Documentation/ABI/stable/sysfs-acpi-pmprofile index 964c7a8afb26..fd97d22b677f 100644 --- a/Documentation/ABI/stable/sysfs-acpi-pmprofile +++ b/Documentation/ABI/stable/sysfs-acpi-pmprofile @@ -6,17 +6,21 @@ Description: The ACPI pm_profile sysfs interface exports the platform power management (and performance) requirement expectations as provided by BIOS. The integer value is directly passed as retrieved from the FADT ACPI table. -Values: For possible values see ACPI specification: + +Values:For possible values see ACPI specification: 5.2.9 Fixed ACPI Description Table (FADT) Field: Preferred_PM_Profile Currently these values are defined by spec: - 0 Unspecified - 1 Desktop - 2 Mobile - 3 Workstation - 4 Enterprise Server - 5 SOHO Server - 6 Appliance PC - 7 Performance Server + + == = + 0 Unspecified + 1 Desktop + 2 Mobile + 3 Workstation + 4 Enterprise Server + 5 SOHO Server + 6 Appliance PC + 7 Performance Server >7 Reserved + == = diff --git a/Documentation/ABI/stable/sysfs-bus-firewire b/Documentation/ABI/stable/sysfs-bus-firewire index 41e5a0cd1e3e..9ac9eddb82ef 100644 --- a/Documentation/ABI/stable/sysfs-bus-firewire +++ b/Documentation/ABI/stable/sysfs-bus-firewire @@ -47,6 +47,7 @@ Description: IEEE 1394 node device attribute. Read-only and immutable. Values:1: The sysfs entry represents a local node (a co
[PATCH v2 11/15] docs: powerpc: fix some issues at vas-api.rst
There are a few issues on this document, when built via the
building with ``make htmldocs``:
Documentation/powerpc/vas-api.rst:116: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:116: WARNING: Inline emphasis
start-string without end-string.
Documentation/powerpc/vas-api.rst:117: WARNING: Block quote ends without a
blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:117: WARNING: Inline emphasis
start-string without end-string.
Documentation/powerpc/vas-api.rst:120: WARNING: Definition list ends
without a blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:124: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:133: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:135: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:150: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:151: WARNING: Block quote ends without a
blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:161: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:176: WARNING: Definition list ends
without a blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:253: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:253: WARNING: Inline emphasis
start-string without end-string.
Documentation/powerpc/vas-api.rst:259: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:261: WARNING: Block quote ends without a
blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:266: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:267: WARNING: Block quote ends without a
blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:270: WARNING: Definition list ends
without a blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:271: WARNING: Definition list ends
without a blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:273: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:274: WARNING: Block quote ends without a
blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:277: WARNING: Definition list ends
without a blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:278: WARNING: Definition list ends
without a blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:280: WARNING: Unexpected indentation.
Documentation/powerpc/vas-api.rst:287: WARNING: Block quote ends without a
blank line; unexpected unindent.
Documentation/powerpc/vas-api.rst:289: WARNING: Block quote ends without a
blank line; unexpected unindent.
Fixes: c12e38b1d52e ("Documentation/powerpc: VAS API")
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/powerpc/vas-api.rst | 23 ++-
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/Documentation/powerpc/vas-api.rst
b/Documentation/powerpc/vas-api.rst
index 1217c2f1595e..b7fdbe560010 100644
--- a/Documentation/powerpc/vas-api.rst
+++ b/Documentation/powerpc/vas-api.rst
@@ -87,6 +87,7 @@ Applications may chose a specific instance of the NX
co-processor using
the vas_id field in the VAS_TX_WIN_OPEN ioctl as detailed below.
A userspace library libnxz is available here but still in development:
+
https://github.com/abalib/power-gzip
Applications that use inflate / deflate calls can link with libnxz
@@ -110,6 +111,7 @@ Applications should use the VAS_TX_WIN_OPEN ioctl as
follows to establish
a connection with NX co-processor engine:
::
+
struct vas_tx_win_open_attr {
__u32 version;
__s16 vas_id; /* specific instance of vas or -1
@@ -119,8 +121,10 @@ a connection with NX co-processor engine:
__u64 reserved2[6];
};
- version: The version field must be currently set to 1.
- vas_id: If '-1' is passed, kernel will make a best-effort attempt
+ version:
+ The version field must be currently set to 1.
+ vas_id:
+ If '-1' is passed, kernel will make a best-effort attempt
to assign an optimal instance of NX for the process. To
select the specific VAS instance, refer
"Discovery of available VAS engines" section below.
@@ -129,7 +133,8 @@ a connection with NX co-processor engine:
and must be set to 0.
The attributes attr for the VAS_TX_WIN_OPEN ioctl are defined as
- follows:
+ follows::
+
#define VAS_MAGIC 'v'
#define VAS_TX_WIN_OPEN _IOW(VAS_MAGIC, 1,
struct vas_tx_win_open_attr)
@@ -141,6 +146,8 @@ a connection with NX co-processor engine:
returns -1 and sets the errno variable to indicate the error.
[PATCH v2 00/15] Documentation fixes
Hi Jon, As requested, this is a rebase of a previous series posted on Jan, 15. Since then, several patches got merged via other trees or became obsolete. There were also 2 patches before that fits better at the ReST conversion patchset. So, I'll be sending it on another patch series together with the remaining ReST conversions. I also added reviews/acks received. So, the series reduced from 29 to 15 patches. Let's hope b4 would be able to properly handle this one. Regards, Mauro Mauro Carvalho Chehab (15): mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter net: dev: add a missing kernel-doc annotation net: netdevice.h: add a description for napi_defer_hard_irqs scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK net: pylink.h: add kernel-doc descriptions for new fields at phylink_config scripts/kernel-doc: handle function pointer prototypes fs: fs.h: fix a kernel-doc parameter description kcsan: fix a kernel-doc warning selftests/vm/keys: fix a broken reference at protection_keys.c docs: hugetlbpage.rst: fix some warnings docs: powerpc: fix some issues at vas-api.rst docs: driver-model: remove a duplicated markup at driver.rst docs: ABI: fix a typo when pointing to w1-generic.rst docs: fix references for DMA*.txt files docs: fs: proc.rst: convert a new chapter to ReST .../ABI/testing/sysfs-driver-w1_therm | 2 +- Documentation/PCI/pci.rst | 6 +-- Documentation/admin-guide/mm/hugetlbpage.rst | 23 +++--- Documentation/block/biodoc.rst| 2 +- Documentation/bus-virt-phys-mapping.txt | 2 +- Documentation/core-api/dma-api.rst| 6 +-- Documentation/core-api/dma-isa-lpc.rst| 2 +- .../driver-api/driver-model/driver.rst| 2 - Documentation/driver-api/usb/dma.rst | 6 +-- Documentation/filesystems/proc.rst| 44 +-- Documentation/powerpc/vas-api.rst | 23 +++--- .../translations/ko_KR/memory-barriers.txt| 6 +-- arch/ia64/hp/common/sba_iommu.c | 12 ++--- arch/parisc/kernel/pci-dma.c | 2 +- arch/x86/include/asm/dma-mapping.h| 4 +- arch/x86/kernel/amd_gart_64.c | 2 +- drivers/parisc/sba_iommu.c| 14 +++--- include/linux/dma-mapping.h | 2 +- include/linux/fs.h| 2 +- include/linux/kcsan-checks.h | 10 +++-- include/linux/netdevice.h | 2 + include/linux/phylink.h | 4 ++ include/media/videobuf-dma-sg.h | 2 +- kernel/dma/debug.c| 2 +- mm/vmalloc.c | 1 - net/core/dev.c| 1 + scripts/kernel-doc| 7 +++ tools/testing/selftests/vm/protection_keys.c | 2 +- 28 files changed, 114 insertions(+), 79 deletions(-) -- 2.26.2
