[alsa-devel] [PATCH 00/22] Some documentation fixes
Fix several warnings and broken links.
This series was generated against linux-next, but was rebased to be applied at docs-next. It should apply cleanly on either tree.
There's a git tree with all of them applied on the top of docs/docs-next at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=fix_doc_links_v2
Mauro Carvalho Chehab (21): ABI: sysfs-devices-system-cpu: point to the right docs isdn: mISDN: remove a bogus reference to a non-existing doc dt: fix broken references to nand.txt docs: zh_CN: get rid of basic_profiling.txt doc: it_IT: fix reference to magic-number.rst docs: mm: numaperf.rst: get rid of a build warning docs: bpf: get rid of two warnings docs: mark orphan documents as such docs: amd-memory-encryption.rst get rid of warnings gpu: amdgpu: fix broken amdgpu_dma_buf.c references gpu: i915.rst: Fix references to renamed files docs: zh_CN: avoid duplicate citation references docs: vm: hmm.rst: fix some warnings docs: it: license-rules.rst: get rid of warnings docs: gpio: driver.rst: fix a bad tag docs: soundwire: locking: fix tags for a code-block docs: security: trusted-encrypted.rst: fix code-block tag docs: security: core.rst: Fix several warnings docs: net: dpio-driver.rst: fix two codeblock warnings docs: net: sja1105.rst: fix table format docs: fix broken documentation links
Otto Sabart (1): mfd: madera: Fix bad reference to pinctrl.txt file
.../ABI/testing/sysfs-devices-system-cpu | 3 +- Documentation/accelerators/ocxl.rst | 2 + Documentation/acpi/dsd/leds.txt | 2 +- .../admin-guide/kernel-parameters.rst | 6 +- .../admin-guide/kernel-parameters.txt | 16 ++--- Documentation/admin-guide/mm/numaperf.rst | 5 +- Documentation/admin-guide/ras.rst | 2 +- Documentation/arm/stm32/overview.rst | 2 + .../arm/stm32/stm32f429-overview.rst | 2 + .../arm/stm32/stm32f746-overview.rst | 2 + .../arm/stm32/stm32f769-overview.rst | 2 + .../arm/stm32/stm32h743-overview.rst | 2 + .../arm/stm32/stm32mp157-overview.rst | 2 + Documentation/bpf/btf.rst | 2 + .../bindings/mtd/amlogic,meson-nand.txt | 2 +- .../devicetree/bindings/mtd/gpmc-nand.txt | 2 +- .../devicetree/bindings/mtd/marvell-nand.txt | 2 +- .../devicetree/bindings/mtd/tango-nand.txt | 2 +- .../devicetree/bindings/net/fsl-enetc.txt | 7 +- .../bindings/pci/amlogic,meson-pcie.txt | 2 +- .../regulator/qcom,rpmh-regulator.txt | 2 +- .../devicetree/booting-without-of.txt | 2 +- Documentation/driver-api/gpio/board.rst | 2 +- Documentation/driver-api/gpio/consumer.rst | 2 +- Documentation/driver-api/gpio/driver.rst | 2 +- .../driver-api/soundwire/locking.rst | 4 +- .../firmware-guide/acpi/enumeration.rst | 2 +- .../firmware-guide/acpi/method-tracing.rst | 2 +- Documentation/gpu/amdgpu.rst | 4 +- Documentation/gpu/i915.rst | 6 +- Documentation/gpu/msm-crash-dump.rst | 2 + Documentation/i2c/instantiating-devices | 2 +- Documentation/interconnect/interconnect.rst | 2 + Documentation/laptops/lg-laptop.rst | 2 + .../freescale/dpaa2/dpio-driver.rst | 4 +- Documentation/networking/dsa/sja1105.rst | 6 +- Documentation/powerpc/isa-versions.rst | 2 + Documentation/security/keys/core.rst | 16 +++-- .../security/keys/trusted-encrypted.rst | 4 +- Documentation/sysctl/kernel.txt | 4 +- .../translations/it_IT/process/howto.rst | 2 +- .../it_IT/process/license-rules.rst | 28 ++++---- .../it_IT/process/magic-number.rst | 2 +- .../it_IT/process/stable-kernel-rules.rst | 4 +- .../translations/zh_CN/basic_profiling.txt | 71 ------------------- .../translations/zh_CN/process/4.Coding.rst | 2 +- .../zh_CN/process/management-style.rst | 4 +- .../zh_CN/process/programming-language.rst | 28 ++++---- .../virtual/kvm/amd-memory-encryption.rst | 5 ++ Documentation/virtual/kvm/vcpu-requests.rst | 2 + Documentation/vm/hmm.rst | 9 ++- Documentation/x86/x86_64/5level-paging.rst | 2 +- Documentation/x86/x86_64/boot-options.rst | 4 +- .../x86/x86_64/fake-numa-for-cpusets.rst | 2 +- MAINTAINERS | 6 +- arch/arm/Kconfig | 2 +- arch/arm64/kernel/kexec_image.c | 2 +- arch/powerpc/Kconfig | 2 +- arch/x86/Kconfig | 16 ++--- arch/x86/Kconfig.debug | 2 +- arch/x86/boot/header.S | 2 +- arch/x86/entry/entry_64.S | 2 +- arch/x86/include/asm/bootparam_utils.h | 2 +- arch/x86/include/asm/page_64_types.h | 2 +- arch/x86/include/asm/pgtable_64_types.h | 2 +- arch/x86/kernel/cpu/microcode/amd.c | 2 +- arch/x86/kernel/kexec-bzimage64.c | 2 +- arch/x86/kernel/pci-dma.c | 2 +- arch/x86/mm/tlb.c | 2 +- arch/x86/platform/pvh/enlighten.c | 2 +- drivers/acpi/Kconfig | 10 +-- drivers/isdn/mISDN/dsp_core.c | 2 - drivers/net/ethernet/faraday/ftgmac100.c | 2 +- .../fieldbus/Documentation/fieldbus_dev.txt | 4 +- drivers/vhost/vhost.c | 2 +- include/acpi/acpi_drivers.h | 2 +- include/linux/fs_context.h | 2 +- include/linux/lsm_hooks.h | 2 +- include/linux/mfd/madera/pdata.h | 3 +- mm/Kconfig | 2 +- security/Kconfig | 2 +- tools/include/linux/err.h | 2 +- .../Documentation/stack-validation.txt | 4 +- tools/testing/selftests/x86/protection_keys.c | 2 +- 84 files changed, 183 insertions(+), 212 deletions(-) delete mode 100644 Documentation/translations/zh_CN/basic_profiling.txt
From: Otto Sabart ottosabart@seberm.com
The pinctrl.txt file was converted into reStructuredText and moved into driver-api folder. This patch updates the broken reference.
Fixes: 5a9b73832e9e ("pinctrl.txt: move it to the driver-api book") Signed-off-by: Otto Sabart ottosabart@seberm.com Signed-off-by: Charles Keepax ckeepax@opensource.cirrus.com Signed-off-by: Mauro Carvalho Chehab mchehab+samsung@kernel.org --- include/linux/mfd/madera/pdata.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/include/linux/mfd/madera/pdata.h b/include/linux/mfd/madera/pdata.h index 8dc852402dbb..dd00ab824e5b 100644 --- a/include/linux/mfd/madera/pdata.h +++ b/include/linux/mfd/madera/pdata.h @@ -34,7 +34,8 @@ struct madera_codec_pdata; * @micvdd: Substruct of pdata for the MICVDD regulator * @irq_flags: Mode for primary IRQ (defaults to active low) * @gpio_base: Base GPIO number - * @gpio_configs: Array of GPIO configurations (See Documentation/pinctrl.txt) + * @gpio_configs: Array of GPIO configurations (See + * Documentation/driver-api/pinctl.rst) * @n_gpio_configs: Number of entries in gpio_configs * @gpsw: General purpose switch mode setting. Depends on the external * hardware connected to the switch. (See the SW1_MODE field
There's an ascii artwork at Example 1 whose code-block is not properly idented, causing those warnings.
Documentation/driver-api/soundwire/locking.rst:50: WARNING: Inconsistent literal block quoting. Documentation/driver-api/soundwire/locking.rst:51: WARNING: Line block ends without a blank line. Documentation/driver-api/soundwire/locking.rst:55: WARNING: Inline substitution_reference start-string without end-string. Documentation/driver-api/soundwire/locking.rst:56: WARNING: Line block ends without a blank line.
Signed-off-by: Mauro Carvalho Chehab mchehab+samsung@kernel.org --- Documentation/driver-api/soundwire/locking.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/driver-api/soundwire/locking.rst b/Documentation/driver-api/soundwire/locking.rst index 253f73555255..3a7ffb3d87f3 100644 --- a/Documentation/driver-api/soundwire/locking.rst +++ b/Documentation/driver-api/soundwire/locking.rst @@ -44,7 +44,9 @@ Message transfer. b. Transfer message (Read/Write) to Slave1 or broadcast message on Bus in case of bank switch.
- c. Release Message lock :: + c. Release Message lock + + ::
+----------+ +---------+ | | | |
participants (1)
-
Mauro Carvalho Chehab