LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH 00/22] Some documentation fixes
@ 2019-05-29 23:23 Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
                   ` (21 more replies)
  0 siblings, 22 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, xen-devel, linux-kselftest, linux-amlogic,
	linux-gpio, linux-pm, devel, keyrings, dri-devel,
	linux-integrity, linux-mtd, patches, devicetree, netdev,
	alsa-devel, devel, virtualization, linux-mm, linux-pci,
	linux-acpi, linuxppc-dev, linux-security-module, linux-i2c, kvm,
	bpf, x86

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

-- 
2.21.0



^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-30 16:57   ` Rafael J. Wysocki
  2019-05-29 23:23 ` [PATCH 02/22] isdn: mISDN: remove a bogus reference to a non-existing doc Mauro Carvalho Chehab
                   ` (20 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Thomas Gleixner, Jon Masters,
	Greg Kroah-Hartman, Borislav Petkov, Josh Poimboeuf,
	Rafael J. Wysocki, Jiri Kosina

The cpuidle doc was split on two, one at the admin guide
and another one at the driver API guide. Instead of pointing
to a non-existent file, point to both (admin guide being
the first one).

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/ABI/testing/sysfs-devices-system-cpu | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu
index 1528239f69b2..87478ac6c2af 100644
--- a/Documentation/ABI/testing/sysfs-devices-system-cpu
+++ b/Documentation/ABI/testing/sysfs-devices-system-cpu
@@ -137,7 +137,8 @@ Description:	Discover cpuidle policy and mechanism
 		current_governor: (RW) displays current idle policy. Users can
 		switch the governor at runtime by writing to this file.
 
-		See files in Documentation/cpuidle/ for more information.
+		See Documentation/admin-guide/pm/cpuidle.rst and
+		Documentation/driver-api/pm/cpuidle.rst for more information.
 
 
 What:		/sys/devices/system/cpu/cpuX/cpuidle/stateN/name
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 02/22] isdn: mISDN: remove a bogus reference to a non-existing doc
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 03/22] dt: fix broken references to nand.txt Mauro Carvalho Chehab
                   ` (19 subsequent siblings)
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Karsten Keil, netdev

The mISDN driver was added on those commits:

	960366cf8dbb ("Add mISDN DSP")
	1b2b03f8e514 ("Add mISDN core files")
	04578dd330f1 ("Define AF_ISDN and PF_ISDN")
	e4ac9bc1f668 ("Add mISDN driver")

None of them added a Documentation/isdn/mISDN.cert file.
Also, whatever were supposed to be written there on that time,
probably doesn't make any sense nowadays, as I doubt isdn would
have any massive changes.

So, let's just get rid of the broken reference, in order to
shut up a warning produced by ./scripts/documentation-file-ref-check.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 drivers/isdn/mISDN/dsp_core.c | 2 --
 1 file changed, 2 deletions(-)

diff --git a/drivers/isdn/mISDN/dsp_core.c b/drivers/isdn/mISDN/dsp_core.c
index cd036e87335a..038e72a84b33 100644
--- a/drivers/isdn/mISDN/dsp_core.c
+++ b/drivers/isdn/mISDN/dsp_core.c
@@ -4,8 +4,6 @@
  *		Karsten Keil (keil@isdn4linux.de)
  *
  *		This file is (c) under GNU PUBLIC LICENSE
- *		For changes and modifications please read
- *		../../../Documentation/isdn/mISDN.cert
  *
  * Thanks to    Karsten Keil (great drivers)
  *              Cologne Chip (great chips)
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 03/22] dt: fix broken references to nand.txt
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 02/22] isdn: mISDN: remove a bogus reference to a non-existing doc Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 04/22] docs: zh_CN: get rid of basic_profiling.txt Mauro Carvalho Chehab
                   ` (18 subsequent siblings)
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Liang Yang, David Woodhouse, Brian Norris,
	Marek Vasut, Miquel Raynal, Richard Weinberger,
	Vignesh Raghavendra, Rob Herring, Mark Rutland, Kevin Hilman,
	Marc Gonzalez, Mans Rullgard, linux-mtd, devicetree,
	linux-arm-kernel, linux-amlogic

The Documentation/devicetree/bindings/mtd/nand.txt were both renamed
and converted to YAML on a single patch, without updating references
to it. That caused several cross-references to break.

Fixes: 212e49693592 ("dt-bindings: mtd: Add YAML schemas for the generic NAND options")

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/devicetree/bindings/mtd/amlogic,meson-nand.txt | 2 +-
 Documentation/devicetree/bindings/mtd/gpmc-nand.txt          | 2 +-
 Documentation/devicetree/bindings/mtd/marvell-nand.txt       | 2 +-
 Documentation/devicetree/bindings/mtd/tango-nand.txt         | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/mtd/amlogic,meson-nand.txt b/Documentation/devicetree/bindings/mtd/amlogic,meson-nand.txt
index 3983c11e062c..5794ab1147c1 100644
--- a/Documentation/devicetree/bindings/mtd/amlogic,meson-nand.txt
+++ b/Documentation/devicetree/bindings/mtd/amlogic,meson-nand.txt
@@ -24,7 +24,7 @@ Optional children nodes:
 Children nodes represent the available nand chips.
 
 Other properties:
-see Documentation/devicetree/bindings/mtd/nand.txt for generic bindings.
+see Documentation/devicetree/bindings/mtd/nand-controller.yaml for generic bindings.
 
 Example demonstrate on AXG SoC:
 
diff --git a/Documentation/devicetree/bindings/mtd/gpmc-nand.txt b/Documentation/devicetree/bindings/mtd/gpmc-nand.txt
index c059ab74ed88..44919d48d241 100644
--- a/Documentation/devicetree/bindings/mtd/gpmc-nand.txt
+++ b/Documentation/devicetree/bindings/mtd/gpmc-nand.txt
@@ -8,7 +8,7 @@ explained in a separate documents - please refer to
 Documentation/devicetree/bindings/memory-controllers/omap-gpmc.txt
 
 For NAND specific properties such as ECC modes or bus width, please refer to
-Documentation/devicetree/bindings/mtd/nand.txt
+Documentation/devicetree/bindings/mtd/nand-controller.yaml
 
 
 Required properties:
diff --git a/Documentation/devicetree/bindings/mtd/marvell-nand.txt b/Documentation/devicetree/bindings/mtd/marvell-nand.txt
index e0c790706b9b..7eeef1e1ed30 100644
--- a/Documentation/devicetree/bindings/mtd/marvell-nand.txt
+++ b/Documentation/devicetree/bindings/mtd/marvell-nand.txt
@@ -58,7 +58,7 @@ Optional properties:
   Step sizes are not completely random for all and follow certain
   patterns described in AN-379, "Marvell SoC NFC ECC".
 
-See Documentation/devicetree/bindings/mtd/nand.txt for more details on
+See Documentation/devicetree/bindings/mtd/nand-controller.yaml for more details on
 generic bindings.
 
 
diff --git a/Documentation/devicetree/bindings/mtd/tango-nand.txt b/Documentation/devicetree/bindings/mtd/tango-nand.txt
index cd1bf2ac9055..91c8420241af 100644
--- a/Documentation/devicetree/bindings/mtd/tango-nand.txt
+++ b/Documentation/devicetree/bindings/mtd/tango-nand.txt
@@ -11,7 +11,7 @@ Required properties:
 - #size-cells: <0>
 
 Children nodes represent the available NAND chips.
-See Documentation/devicetree/bindings/mtd/nand.txt for generic bindings.
+See Documentation/devicetree/bindings/mtd/nand-controller.yaml for generic bindings.
 
 Example:
 
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 04/22] docs: zh_CN: get rid of basic_profiling.txt
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (2 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 03/22] dt: fix broken references to nand.txt Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-06-02 14:36   ` Alex Shi
  2019-05-29 23:23 ` [PATCH 05/22] mfd: madera: Fix bad reference to pinctrl.txt file Mauro Carvalho Chehab
                   ` (17 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Harry Wei, Alex Shi

Changeset 5700d1974818 ("docs: Get rid of the "basic profiling" guide")
removed an old basic-profiling.txt file that was not updated over
the last 11 years and won't reflect the post-perf era.

It makes no sense to keep its translation, so get rid of it too.

Fixes: 5700d1974818 ("docs: Get rid of the "basic profiling" guide")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 .../translations/zh_CN/basic_profiling.txt    | 71 -------------------
 1 file changed, 71 deletions(-)
 delete mode 100644 Documentation/translations/zh_CN/basic_profiling.txt

diff --git a/Documentation/translations/zh_CN/basic_profiling.txt b/Documentation/translations/zh_CN/basic_profiling.txt
deleted file mode 100644
index 1e6bf0bdf8f5..000000000000
--- a/Documentation/translations/zh_CN/basic_profiling.txt
+++ /dev/null
@@ -1,71 +0,0 @@
-Chinese translated version of Documentation/basic_profiling
-
-If you have any comment or update to the content, please post to LKML directly.
-However, if you have problem communicating in English you can also ask the
-Chinese maintainer for help.  Contact the Chinese maintainer, if this
-translation is outdated or there is problem with translation.
-
-Chinese maintainer: Liang Xie <xieliang@xiaomi.com>
----------------------------------------------------------------------
-Documentation/basic_profiling的中文翻译
-
-如果想评论或更新本文的内容,请直接发信到LKML。如果你使用英文交流有困难的话,也可
-以向中文版维护者求助。如果本翻译更新不及时或者翻译存在问题,请联系中文版维护者。
-
-中文版维护者: 谢良 Liang Xie <xieliang007@gmail.com>
-中文版翻译者: 谢良 Liang Xie <xieliang007@gmail.com>
-中文版校译者:
-以下为正文
----------------------------------------------------------------------
-
-下面这些说明指令都是非常基础的,如果你想进一步了解请阅读相关专业文档:)
-请不要再在本文档增加新的内容,但可以修复文档中的错误:)(mbligh@aracnet.com)
-感谢John Levon,Dave Hansen等在撰写时的帮助
-
-<test> 用于表示要测量的目标
-请先确保您已经有正确的System.map / vmlinux配置!
-
-对于linux系统来说,配置vmlinuz最容易的方法可能就是使用“make install”,然后修改
-/sbin/installkernel将vmlinux拷贝到/boot目录,而System.map通常是默认安装好的
-
-Readprofile
------------
-2.6系列内核需要版本相对较新的readprofile,比如util-linux 2.12a中包含的,可以从:
-
-http://www.kernel.org/pub/linux/utils/util-linux/ 下载
-
-大部分linux发行版已经包含了.
-
-启用readprofile需要在kernel启动命令行增加”profile=2“
-
-clear		readprofile -r
-		<test>
-dump output	readprofile -m /boot/System.map > captured_profile
-
-Oprofile
---------
-
-从http://oprofile.sourceforge.net/获取源代码(请参考Changes以获取匹配的版本)
-在kernel启动命令行增加“idle=poll”
-
-配置CONFIG_PROFILING=y和CONFIG_OPROFILE=y然后重启进入新kernel
-
-./configure --with-kernel-support
-make install
-
-想得到好的测量结果,请确保启用了本地APIC特性。如果opreport显示有0Hz CPU,
-说明APIC特性没有开启。另外注意idle=poll选项可能有损性能。
-
-One time setup:
-		opcontrol --setup --vmlinux=/boot/vmlinux
-
-clear		opcontrol --reset
-start		opcontrol --start
-		<test>
-stop		opcontrol --stop
-dump output	opreport >  output_file
-
-如果只看kernel相关的报告结果,请运行命令 opreport -l /boot/vmlinux > output_file
-
-通过reset选项可以清理过期统计数据,相当于重启的效果。
-
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 05/22] mfd: madera: Fix bad reference to pinctrl.txt file
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (3 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 04/22] docs: zh_CN: get rid of basic_profiling.txt Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 06/22] doc: it_IT: fix reference to magic-number.rst Mauro Carvalho Chehab
                   ` (16 subsequent siblings)
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Otto Sabart, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Charles Keepax, Richard Fitzgerald, Lee Jones,
	alsa-devel, patches, Mauro Carvalho Chehab

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


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 06/22] doc: it_IT: fix reference to magic-number.rst
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (4 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 05/22] mfd: madera: Fix bad reference to pinctrl.txt file Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-30 20:15   ` Federico Vaga
  2019-05-29 23:23 ` [PATCH 07/22] docs: mm: numaperf.rst: get rid of a build warning Mauro Carvalho Chehab
                   ` (15 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Federico Vaga, Alessia Mantegazza

There's a typo at the referred file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/translations/it_IT/process/magic-number.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/translations/it_IT/process/magic-number.rst b/Documentation/translations/it_IT/process/magic-number.rst
index 5281d53e57ee..ed1121d0ba84 100644
--- a/Documentation/translations/it_IT/process/magic-number.rst
+++ b/Documentation/translations/it_IT/process/magic-number.rst
@@ -1,6 +1,6 @@
 .. include:: ../disclaimer-ita.rst
 
-:Original: :ref:`Documentation/process/magic-numbers.rst <magicnumbers>`
+:Original: :ref:`Documentation/process/magic-number.rst <magicnumbers>`
 :Translator: Federico Vaga <federico.vaga@vaga.pv.it>
 
 .. _it_magicnumbers:
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 07/22] docs: mm: numaperf.rst: get rid of a build warning
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (5 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 06/22] doc: it_IT: fix reference to magic-number.rst Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 08/22] docs: bpf: get rid of two warnings Mauro Carvalho Chehab
                   ` (14 subsequent siblings)
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Mike Rapoport, Jonathan Cameron, Keith Busch

When building it, it gets this warning:

	Documentation/admin-guide/mm/numaperf.rst:168: WARNING: Footnote [1] is not referenced.

The problem is that this is not really a reference, as it is not
mentioned within the documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/admin-guide/mm/numaperf.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/mm/numaperf.rst b/Documentation/admin-guide/mm/numaperf.rst
index c067ed145158..a80c3c37226e 100644
--- a/Documentation/admin-guide/mm/numaperf.rst
+++ b/Documentation/admin-guide/mm/numaperf.rst
@@ -165,5 +165,6 @@ write-through caching.
 ========
 See Also
 ========
-.. [1] https://www.uefi.org/sites/default/files/resources/ACPI_6_2.pdf
-       Section 5.2.27
+
+[1] https://www.uefi.org/sites/default/files/resources/ACPI_6_2.pdf
+- Section 5.2.27
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 08/22] docs: bpf: get rid of two warnings
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (6 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 07/22] docs: mm: numaperf.rst: get rid of a build warning Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-30 18:08   ` Song Liu
  2019-05-29 23:23 ` [PATCH 09/22] docs: mark orphan documents as such Mauro Carvalho Chehab
                   ` (13 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Alexei Starovoitov, Daniel Borkmann,
	Martin KaFai Lau, Song Liu, Yonghong Song, netdev, bpf

Documentation/bpf/btf.rst:154: WARNING: Unexpected indentation.
Documentation/bpf/btf.rst:163: WARNING: Unexpected indentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/bpf/btf.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/bpf/btf.rst b/Documentation/bpf/btf.rst
index 8820360d00da..4ae022d274ab 100644
--- a/Documentation/bpf/btf.rst
+++ b/Documentation/bpf/btf.rst
@@ -151,6 +151,7 @@ for the type. The maximum value of ``BTF_INT_BITS()`` is 128.
 
 The ``BTF_INT_OFFSET()`` specifies the starting bit offset to calculate values
 for this int. For example, a bitfield struct member has:
+
  * btf member bit offset 100 from the start of the structure,
  * btf member pointing to an int type,
  * the int type has ``BTF_INT_OFFSET() = 2`` and ``BTF_INT_BITS() = 4``
@@ -160,6 +161,7 @@ from bits ``100 + 2 = 102``.
 
 Alternatively, the bitfield struct member can be the following to access the
 same bits as the above:
+
  * btf member bit offset 102,
  * btf member pointing to an int type,
  * the int type has ``BTF_INT_OFFSET() = 0`` and ``BTF_INT_BITS() = 4``
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 09/22] docs: mark orphan documents as such
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (7 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 08/22] docs: bpf: get rid of two warnings Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-30  8:30   ` Paolo Bonzini
  2019-06-03  7:32   ` Christophe Leroy
  2019-05-29 23:23 ` [PATCH 10/22] docs: amd-memory-encryption.rst get rid of warnings Mauro Carvalho Chehab
                   ` (12 subsequent siblings)
  21 siblings, 2 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Frederic Barrat, Andrew Donnellan,
	Maxime Coquelin, Alexandre Torgue, Maarten Lankhorst,
	Maxime Ripard, Sean Paul, David Airlie, Daniel Vetter,
	Georgi Djakov, Matan Ziv-Av, Benjamin Herrenschmidt,
	Paul Mackerras, Michael Ellerman, Paolo Bonzini,
	Radim Krčmář,
	linuxppc-dev, linux-stm32, linux-arm-kernel, dri-devel, linux-pm,
	platform-driver-x86, kvm

Sphinx doesn't like orphan documents:

    Documentation/accelerators/ocxl.rst: WARNING: document isn't included in any toctree
    Documentation/arm/stm32/overview.rst: WARNING: document isn't included in any toctree
    Documentation/arm/stm32/stm32f429-overview.rst: WARNING: document isn't included in any toctree
    Documentation/arm/stm32/stm32f746-overview.rst: WARNING: document isn't included in any toctree
    Documentation/arm/stm32/stm32f769-overview.rst: WARNING: document isn't included in any toctree
    Documentation/arm/stm32/stm32h743-overview.rst: WARNING: document isn't included in any toctree
    Documentation/arm/stm32/stm32mp157-overview.rst: WARNING: document isn't included in any toctree
    Documentation/gpu/msm-crash-dump.rst: WARNING: document isn't included in any toctree
    Documentation/interconnect/interconnect.rst: WARNING: document isn't included in any toctree
    Documentation/laptops/lg-laptop.rst: WARNING: document isn't included in any toctree
    Documentation/powerpc/isa-versions.rst: WARNING: document isn't included in any toctree
    Documentation/virtual/kvm/amd-memory-encryption.rst: WARNING: document isn't included in any toctree
    Documentation/virtual/kvm/vcpu-requests.rst: WARNING: document isn't included in any toctree

So, while they aren't on any toctree, add :orphan: to them, in order
to silent this warning.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/accelerators/ocxl.rst                 | 2 ++
 Documentation/arm/stm32/overview.rst                | 2 ++
 Documentation/arm/stm32/stm32f429-overview.rst      | 2 ++
 Documentation/arm/stm32/stm32f746-overview.rst      | 2 ++
 Documentation/arm/stm32/stm32f769-overview.rst      | 2 ++
 Documentation/arm/stm32/stm32h743-overview.rst      | 2 ++
 Documentation/arm/stm32/stm32mp157-overview.rst     | 2 ++
 Documentation/gpu/msm-crash-dump.rst                | 2 ++
 Documentation/interconnect/interconnect.rst         | 2 ++
 Documentation/laptops/lg-laptop.rst                 | 2 ++
 Documentation/powerpc/isa-versions.rst              | 2 ++
 Documentation/virtual/kvm/amd-memory-encryption.rst | 2 ++
 Documentation/virtual/kvm/vcpu-requests.rst         | 2 ++
 13 files changed, 26 insertions(+)

diff --git a/Documentation/accelerators/ocxl.rst b/Documentation/accelerators/ocxl.rst
index 14cefc020e2d..b1cea19a90f5 100644
--- a/Documentation/accelerators/ocxl.rst
+++ b/Documentation/accelerators/ocxl.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ========================================================
 OpenCAPI (Open Coherent Accelerator Processor Interface)
 ========================================================
diff --git a/Documentation/arm/stm32/overview.rst b/Documentation/arm/stm32/overview.rst
index 85cfc8410798..f7e734153860 100644
--- a/Documentation/arm/stm32/overview.rst
+++ b/Documentation/arm/stm32/overview.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ========================
 STM32 ARM Linux Overview
 ========================
diff --git a/Documentation/arm/stm32/stm32f429-overview.rst b/Documentation/arm/stm32/stm32f429-overview.rst
index 18feda97f483..65bbb1c3b423 100644
--- a/Documentation/arm/stm32/stm32f429-overview.rst
+++ b/Documentation/arm/stm32/stm32f429-overview.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 STM32F429 Overview
 ==================
 
diff --git a/Documentation/arm/stm32/stm32f746-overview.rst b/Documentation/arm/stm32/stm32f746-overview.rst
index b5f4b6ce7656..42d593085015 100644
--- a/Documentation/arm/stm32/stm32f746-overview.rst
+++ b/Documentation/arm/stm32/stm32f746-overview.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 STM32F746 Overview
 ==================
 
diff --git a/Documentation/arm/stm32/stm32f769-overview.rst b/Documentation/arm/stm32/stm32f769-overview.rst
index 228656ced2fe..f6adac862b17 100644
--- a/Documentation/arm/stm32/stm32f769-overview.rst
+++ b/Documentation/arm/stm32/stm32f769-overview.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 STM32F769 Overview
 ==================
 
diff --git a/Documentation/arm/stm32/stm32h743-overview.rst b/Documentation/arm/stm32/stm32h743-overview.rst
index 3458dc00095d..c525835e7473 100644
--- a/Documentation/arm/stm32/stm32h743-overview.rst
+++ b/Documentation/arm/stm32/stm32h743-overview.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 STM32H743 Overview
 ==================
 
diff --git a/Documentation/arm/stm32/stm32mp157-overview.rst b/Documentation/arm/stm32/stm32mp157-overview.rst
index 62e176d47ca7..2c52cd020601 100644
--- a/Documentation/arm/stm32/stm32mp157-overview.rst
+++ b/Documentation/arm/stm32/stm32mp157-overview.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 STM32MP157 Overview
 ===================
 
diff --git a/Documentation/gpu/msm-crash-dump.rst b/Documentation/gpu/msm-crash-dump.rst
index 757cd257e0d8..240ef200f76c 100644
--- a/Documentation/gpu/msm-crash-dump.rst
+++ b/Documentation/gpu/msm-crash-dump.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 =====================
 MSM Crash Dump Format
 =====================
diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/interconnect/interconnect.rst
index c3e004893796..56e331dab70e 100644
--- a/Documentation/interconnect/interconnect.rst
+++ b/Documentation/interconnect/interconnect.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+:orphan:
+
 =====================================
 GENERIC SYSTEM INTERCONNECT SUBSYSTEM
 =====================================
diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst
index aa503ee9b3bc..f2c2ffe31101 100644
--- a/Documentation/laptops/lg-laptop.rst
+++ b/Documentation/laptops/lg-laptop.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0+
 
+:orphan:
+
 LG Gram laptop extra features
 =============================
 
diff --git a/Documentation/powerpc/isa-versions.rst b/Documentation/powerpc/isa-versions.rst
index 812e20cc898c..66c24140ebf1 100644
--- a/Documentation/powerpc/isa-versions.rst
+++ b/Documentation/powerpc/isa-versions.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 CPU to ISA Version Mapping
 ==========================
 
diff --git a/Documentation/virtual/kvm/amd-memory-encryption.rst b/Documentation/virtual/kvm/amd-memory-encryption.rst
index 659bbc093b52..33d697ab8a58 100644
--- a/Documentation/virtual/kvm/amd-memory-encryption.rst
+++ b/Documentation/virtual/kvm/amd-memory-encryption.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ======================================
 Secure Encrypted Virtualization (SEV)
 ======================================
diff --git a/Documentation/virtual/kvm/vcpu-requests.rst b/Documentation/virtual/kvm/vcpu-requests.rst
index 5feb3706a7ae..c1807a1b92e6 100644
--- a/Documentation/virtual/kvm/vcpu-requests.rst
+++ b/Documentation/virtual/kvm/vcpu-requests.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 =================
 KVM VCPU Requests
 =================
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 10/22] docs: amd-memory-encryption.rst get rid of warnings
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (8 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 09/22] docs: mark orphan documents as such Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-30  8:30   ` Paolo Bonzini
  2019-05-29 23:23 ` [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references Mauro Carvalho Chehab
                   ` (11 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Paolo Bonzini, Radim Krčmář,
	kvm

Get rid of those warnings:

    Documentation/virtual/kvm/amd-memory-encryption.rst:244: WARNING: Citation [white-paper] is not referenced.
    Documentation/virtual/kvm/amd-memory-encryption.rst:246: WARNING: Citation [amd-apm] is not referenced.
    Documentation/virtual/kvm/amd-memory-encryption.rst:247: WARNING: Citation [kvm-forum] is not referenced.

For references that aren't mentioned at the text by adding an
explicit reference to them.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/virtual/kvm/amd-memory-encryption.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/virtual/kvm/amd-memory-encryption.rst b/Documentation/virtual/kvm/amd-memory-encryption.rst
index 33d697ab8a58..6c37ff9a0a3c 100644
--- a/Documentation/virtual/kvm/amd-memory-encryption.rst
+++ b/Documentation/virtual/kvm/amd-memory-encryption.rst
@@ -243,6 +243,9 @@ Returns: 0 on success, -negative on error
 References
 ==========
 
+
+See [white-paper]_, [api-spec]_, [amd-apm]_ and [kvm-forum]_ for more info.
+
 .. [white-paper] http://amd-dev.wpengine.netdna-cdn.com/wordpress/media/2013/12/AMD_Memory_Encryption_Whitepaper_v7-Public.pdf
 .. [api-spec] http://support.amd.com/TechDocs/55766_SEV-KM_API_Specification.pdf
 .. [amd-apm] http://support.amd.com/TechDocs/24593.pdf (section 15.34)
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (9 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 10/22] docs: amd-memory-encryption.rst get rid of warnings Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-31 14:00   ` Christian König
  2019-05-29 23:23 ` [PATCH 12/22] gpu: i915.rst: Fix references to renamed files Mauro Carvalho Chehab
                   ` (10 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, David Airlie, Daniel Vetter, Maarten Lankhorst,
	Maxime Ripard, Sean Paul, dri-devel

This file was renamed, but docs weren't updated accordingly.

	WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function PRIME Buffer Sharing ./drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c' failed with return code 1
	WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -internal ./drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c' failed with return code 2

Fixes: 988076cd8c5c ("drm/amdgpu: rename amdgpu_prime.[ch] into amdgpu_dma_buf.[ch]")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/gpu/amdgpu.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/gpu/amdgpu.rst b/Documentation/gpu/amdgpu.rst
index a740e491dfcc..a15199b1b02e 100644
--- a/Documentation/gpu/amdgpu.rst
+++ b/Documentation/gpu/amdgpu.rst
@@ -37,10 +37,10 @@ Buffer Objects
 PRIME Buffer Sharing
 --------------------
 
-.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c
+.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
    :doc: PRIME Buffer Sharing
 
-.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c
+.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
    :internal:
 
 MMU Notifier
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 12/22] gpu: i915.rst: Fix references to renamed files
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (10 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-31  7:40   ` Jani Nikula
  2019-05-31  9:02   ` Joonas Lahtinen
  2019-05-29 23:23 ` [PATCH 13/22] docs: zh_CN: avoid duplicate citation references Mauro Carvalho Chehab
                   ` (9 subsequent siblings)
  21 siblings, 2 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Jani Nikula, Joonas Lahtinen, Rodrigo Vivi,
	David Airlie, Daniel Vetter, Maarten Lankhorst, Maxime Ripard,
	Sean Paul, intel-gfx, dri-devel

WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function Hardware workarounds ./drivers/gpu/drm/i915/intel_workarounds.c' failed with return code 1
WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function Logical Rings, Logical Ring Contexts and Execlists ./drivers/gpu/drm/i915/intel_lrc.c' failed with return code 1
WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -internal ./drivers/gpu/drm/i915/intel_lrc.c' failed with return code 2

Fixes: 112ed2d31a46 ("drm/i915: Move GraphicsTechnology files under gt/")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/gpu/i915.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index 055df45596c1..38fefeb99bba 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -61,7 +61,7 @@ Intel GVT-g Host Support(vGPU device model)
 Workarounds
 -----------
 
-.. kernel-doc:: drivers/gpu/drm/i915/intel_workarounds.c
+.. kernel-doc:: drivers/gpu/drm/i915/gt/selftest_workarounds.c
    :doc: Hardware workarounds
 
 Display Hardware Handling
@@ -379,10 +379,10 @@ User Batchbuffer Execution
 Logical Rings, Logical Ring Contexts and Execlists
 --------------------------------------------------
 
-.. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
+.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_lrc.c
    :doc: Logical Rings, Logical Ring Contexts and Execlists
 
-.. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
+.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_lrc.c
    :internal:
 
 Global GTT views
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 13/22] docs: zh_CN: avoid duplicate citation references
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (11 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 12/22] gpu: i915.rst: Fix references to renamed files Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-06-02 15:01   ` Alex Shi
  2019-05-29 23:23 ` [PATCH 14/22] docs: vm: hmm.rst: fix some warnings Mauro Carvalho Chehab
                   ` (8 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Harry Wei, Alex Shi

    Documentation/process/management-style.rst:35: WARNING: duplicate label decisions, other instance in     Documentation/translations/zh_CN/process/management-style.rst
    Documentation/process/programming-language.rst:37: WARNING: duplicate citation c-language, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:38: WARNING: duplicate citation gcc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:39: WARNING: duplicate citation clang, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:40: WARNING: duplicate citation icc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:41: WARNING: duplicate citation gcc-c-dialect-options, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:42: WARNING: duplicate citation gnu-extensions, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:43: WARNING: duplicate citation gcc-attribute-syntax, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:44: WARNING: duplicate citation n2049, other instance in     Documentation/translations/zh_CN/process/programming-language.rst

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 .../zh_CN/process/management-style.rst        |  4 +--
 .../zh_CN/process/programming-language.rst    | 28 +++++++++----------
 2 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/Documentation/translations/zh_CN/process/management-style.rst b/Documentation/translations/zh_CN/process/management-style.rst
index a181fa56d19e..c6a5bb285797 100644
--- a/Documentation/translations/zh_CN/process/management-style.rst
+++ b/Documentation/translations/zh_CN/process/management-style.rst
@@ -28,7 +28,7 @@ Linux内核管理风格
 
 不管怎样,这里是:
 
-.. _decisions:
+.. _cn_decisions:
 
 1)决策
 -------
@@ -108,7 +108,7 @@ Linux内核管理风格
 但是,为了做好作为内核管理者的准备,最好记住不要烧掉任何桥梁,不要轰炸任何
 无辜的村民,也不要疏远太多的内核开发人员。事实证明,疏远人是相当容易的,而
 亲近一个疏远的人是很难的。因此,“疏远”立即属于“不可逆”的范畴,并根据
-:ref:`decisions` 成为绝不可以做的事情。
+:ref:`cn_decisions` 成为绝不可以做的事情。
 
 这里只有几个简单的规则:
 
diff --git a/Documentation/translations/zh_CN/process/programming-language.rst b/Documentation/translations/zh_CN/process/programming-language.rst
index 51fd4ef48ea1..9de9a3108c4d 100644
--- a/Documentation/translations/zh_CN/process/programming-language.rst
+++ b/Documentation/translations/zh_CN/process/programming-language.rst
@@ -8,21 +8,21 @@
 程序设计语言
 ============
 
-内核是用C语言 [c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [gcc]_
-在 ``-std=gnu89`` [gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
+内核是用C语言 [cn_c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [cn_gcc]_
+在 ``-std=gnu89`` [cn_gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
 包括一些C99特性)
 
-这种方言包含对语言 [gnu-extensions]_ 的许多扩展,当然,它们许多都在内核中使用。
+这种方言包含对语言 [cn_gnu-extensions]_ 的许多扩展,当然,它们许多都在内核中使用。
 
-对于一些体系结构,有一些使用 ``clang`` [clang]_ 和 ``icc`` [icc]_ 编译内核
+对于一些体系结构,有一些使用 ``clang`` [cn_clang]_ 和 ``icc`` [cn_icc]_ 编译内核
 的支持,尽管在编写此文档时还没有完成,仍需要第三方补丁。
 
 属性
 ----
 
-在整个内核中使用的一个常见扩展是属性(attributes) [gcc-attribute-syntax]_
+在整个内核中使用的一个常见扩展是属性(attributes) [cn_gcc-attribute-syntax]_
 属性允许将实现定义的语义引入语言实体(如变量、函数或类型),而无需对语言进行
-重大的语法更改(例如添加新关键字) [n2049]_
+重大的语法更改(例如添加新关键字) [cn_n2049]_
 
 在某些情况下,属性是可选的(即不支持这些属性的编译器仍然应该生成正确的代码,
 即使其速度较慢或执行的编译时检查/诊断次数不够)
@@ -31,11 +31,11 @@
 ``__attribute__((__pure__))`` ),以检测可以使用哪些关键字和/或缩短代码, 具体
 请参阅 ``include/linux/compiler_attributes.h``
 
-.. [c-language] http://www.open-std.org/jtc1/sc22/wg14/www/standards
-.. [gcc] https://gcc.gnu.org
-.. [clang] https://clang.llvm.org
-.. [icc] https://software.intel.com/en-us/c-compilers
-.. [gcc-c-dialect-options] https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html
-.. [gnu-extensions] https://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html
-.. [gcc-attribute-syntax] https://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html
-.. [n2049] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2049.pdf
+.. [cn_c-language] http://www.open-std.org/jtc1/sc22/wg14/www/standards
+.. [cn_gcc] https://gcc.gnu.org
+.. [cn_clang] https://clang.llvm.org
+.. [cn_icc] https://software.intel.com/en-us/c-compilers
+.. [cn_gcc-c-dialect-options] https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html
+.. [cn_gnu-extensions] https://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html
+.. [cn_gcc-attribute-syntax] https://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html
+.. [cn_n2049] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2049.pdf
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 14/22] docs: vm: hmm.rst: fix some warnings
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (12 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 13/22] docs: zh_CN: avoid duplicate citation references Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 15/22] docs: it: license-rules.rst: get rid of warnings Mauro Carvalho Chehab
                   ` (7 subsequent siblings)
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Jérôme Glisse, linux-mm

    Documentation/vm/hmm.rst:292: WARNING: Unexpected indentation.
    Documentation/vm/hmm.rst:300: WARNING: Unexpected indentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/vm/hmm.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/vm/hmm.rst b/Documentation/vm/hmm.rst
index ec1efa32af3c..1ab609ca7835 100644
--- a/Documentation/vm/hmm.rst
+++ b/Documentation/vm/hmm.rst
@@ -283,12 +283,14 @@ The hmm_range struct has 2 fields default_flags and pfn_flags_mask that allows
 to set fault or snapshot policy for a whole range instead of having to set them
 for each entries in the range.
 
-For instance if the device flags for device entries are:
+For instance if the device flags for device entries are::
+
     VALID (1 << 63)
     WRITE (1 << 62)
 
 Now let say that device driver wants to fault with at least read a range then
-it does set:
+it does set::
+
     range->default_flags = (1 << 63)
     range->pfn_flags_mask = 0;
 
@@ -296,7 +298,8 @@ and calls hmm_range_fault() as described above. This will fill fault all page
 in the range with at least read permission.
 
 Now let say driver wants to do the same except for one page in the range for
-which its want to have write. Now driver set:
+which its want to have write. Now driver set::
+
     range->default_flags = (1 << 63);
     range->pfn_flags_mask = (1 << 62);
     range->pfns[index_of_write] = (1 << 62);
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 15/22] docs: it: license-rules.rst: get rid of warnings
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (13 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 14/22] docs: vm: hmm.rst: fix some warnings Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-30 20:23   ` Federico Vaga
  2019-05-29 23:23 ` [PATCH 16/22] docs: gpio: driver.rst: fix a bad tag Mauro Carvalho Chehab
                   ` (6 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Federico Vaga

There's a wrong identation on a code block, and it tries to use
a reference that was not defined at the Italian translation.

    Documentation/translations/it_IT/process/license-rules.rst:329: WARNING: Literal block expected; none found.
    Documentation/translations/it_IT/process/license-rules.rst:332: WARNING: Unexpected indentation.
    Documentation/translations/it_IT/process/license-rules.rst:339: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/translations/it_IT/process/license-rules.rst:341: WARNING: Unexpected indentation.
    Documentation/translations/it_IT/process/license-rules.rst:305: WARNING: Unknown target name: "metatags".

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 .../it_IT/process/license-rules.rst           | 28 +++++++++----------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/Documentation/translations/it_IT/process/license-rules.rst b/Documentation/translations/it_IT/process/license-rules.rst
index f058e06996dc..06abeb7dd307 100644
--- a/Documentation/translations/it_IT/process/license-rules.rst
+++ b/Documentation/translations/it_IT/process/license-rules.rst
@@ -303,7 +303,7 @@ essere categorizzate in:
      LICENSES/dual
 
    I file in questa cartella contengono il testo completo della rispettiva
-   licenza e i suoi `Metatags`_.  I nomi dei file sono identici agli
+   licenza e i suoi `Metatags`.  I nomi dei file sono identici agli
    identificatori di licenza SPDX che dovrebbero essere usati nei file
    sorgenti.
 
@@ -326,19 +326,19 @@ essere categorizzate in:
 
    Esempio del formato del file::
 
-   Valid-License-Identifier: MPL-1.1
-   SPDX-URL: https://spdx.org/licenses/MPL-1.1.html
-   Usage-Guide:
-     Do NOT use. The MPL-1.1 is not GPL2 compatible. It may only be used for
-     dual-licensed files where the other license is GPL2 compatible.
-     If you end up using this it MUST be used together with a GPL2 compatible
-     license using "OR".
-     To use the Mozilla Public License version 1.1 put the following SPDX
-     tag/value pair into a comment according to the placement guidelines in
-     the licensing rules documentation:
-   SPDX-License-Identifier: MPL-1.1
-   License-Text:
-     Full license text
+    Valid-License-Identifier: MPL-1.1
+    SPDX-URL: https://spdx.org/licenses/MPL-1.1.html
+    Usage-Guide:
+      Do NOT use. The MPL-1.1 is not GPL2 compatible. It may only be used for
+      dual-licensed files where the other license is GPL2 compatible.
+      If you end up using this it MUST be used together with a GPL2 compatible
+      license using "OR".
+      To use the Mozilla Public License version 1.1 put the following SPDX
+      tag/value pair into a comment according to the placement guidelines in
+      the licensing rules documentation:
+    SPDX-License-Identifier: MPL-1.1
+    License-Text:
+      Full license text
 
 |
 
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 16/22] docs: gpio: driver.rst: fix a bad tag
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (14 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 15/22] docs: it: license-rules.rst: get rid of warnings Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-06-07 20:57   ` Linus Walleij
  2019-05-29 23:23 ` [PATCH 17/22] docs: soundwire: locking: fix tags for a code-block Mauro Carvalho Chehab
                   ` (5 subsequent siblings)
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Linus Walleij, Bartosz Golaszewski, linux-gpio

With ReST, [foo]_ means a reference to foo, causing this warning:

    Documentation/driver-api/gpio/driver.rst:419: WARNING: Unknown target name: "devm".

Fix it by using a literal for the name.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/driver-api/gpio/driver.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst
index 1ce7fcd0f989..25e2ddeb4f31 100644
--- a/Documentation/driver-api/gpio/driver.rst
+++ b/Documentation/driver-api/gpio/driver.rst
@@ -418,7 +418,7 @@ symbol:
 
 If there is a need to exclude certain GPIO lines from the IRQ domain handled by
 these helpers, we can set .irq.need_valid_mask of the gpiochip before
-[devm_]gpiochip_add_data() is called. This allocates an .irq.valid_mask with as
+``[devm_]gpiochip_add_data()`` is called. This allocates an .irq.valid_mask with as
 many bits set as there are GPIO lines in the chip, each bit representing line
 0..n-1. Drivers can exclude GPIO lines by clearing bits from this mask. The mask
 must be filled in before gpiochip_irqchip_add() or gpiochip_irqchip_add_nested()
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 17/22] docs: soundwire: locking: fix tags for a code-block
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (15 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 16/22] docs: gpio: driver.rst: fix a bad tag Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag Mauro Carvalho Chehab
                   ` (4 subsequent siblings)
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Vinod Koul, Sanyog Kale, Pierre-Louis Bossart,
	alsa-devel

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
+
+     ::
 
 	+----------+                    +---------+
 	|          |                    |         |
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (16 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 17/22] docs: soundwire: locking: fix tags for a code-block Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-30 19:43   ` James Morris
  2019-06-03 20:29   ` Jarkko Sakkinen
  2019-05-29 23:23 ` [PATCH 19/22] docs: security: core.rst: Fix several warnings Mauro Carvalho Chehab
                   ` (3 subsequent siblings)
  21 siblings, 2 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Mimi Zohar, James Bottomley, Jarkko Sakkinen,
	linux-integrity, keyrings

The code-block tag is at the wrong place, causing those
warnings:

    Documentation/security/keys/trusted-encrypted.rst:112: WARNING: Literal block expected; none found.
    Documentation/security/keys/trusted-encrypted.rst:121: WARNING: Unexpected indentation.
    Documentation/security/keys/trusted-encrypted.rst:122: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/security/keys/trusted-encrypted.rst:123: WARNING: Block quote ends without a blank line; unexpected unindent.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/security/keys/trusted-encrypted.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/security/keys/trusted-encrypted.rst b/Documentation/security/keys/trusted-encrypted.rst
index 7b35fcb58933..50ac8bcd6970 100644
--- a/Documentation/security/keys/trusted-encrypted.rst
+++ b/Documentation/security/keys/trusted-encrypted.rst
@@ -107,12 +107,14 @@ Where::
 
 Examples of trusted and encrypted key usage:
 
-Create and save a trusted key named "kmk" of length 32 bytes::
+Create and save a trusted key named "kmk" of length 32 bytes.
 
 Note: When using a TPM 2.0 with a persistent key with handle 0x81000001,
 append 'keyhandle=0x81000001' to statements between quotes, such as
 "new 32 keyhandle=0x81000001".
 
+::
+
     $ keyctl add trusted kmk "new 32" @u
     440502848
 
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 19/22] docs: security: core.rst: Fix several warnings
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (17 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 20/22] docs: net: dpio-driver.rst: fix two codeblock warnings Mauro Carvalho Chehab
                   ` (2 subsequent siblings)
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, David Howells, keyrings

Multi-line literal markups only work when they're idented at the
same level, with is not the case here:

   Documentation/security/keys/core.rst:1597: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1597: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1597: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1598: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1598: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.

Fix it by using a code-block instead.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/security/keys/core.rst | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/Documentation/security/keys/core.rst b/Documentation/security/keys/core.rst
index 9521c4207f01..3fd60dcb2dc6 100644
--- a/Documentation/security/keys/core.rst
+++ b/Documentation/security/keys/core.rst
@@ -1594,10 +1594,12 @@ The structure has a number of fields, some of which are mandatory:
      attempted key link operation. If there is no match, -EINVAL is returned.
 
 
-  *  ``int (*asym_eds_op)(struct kernel_pkey_params *params,
-			  const void *in, void *out);``
-     ``int (*asym_verify_signature)(struct kernel_pkey_params *params,
-				    const void *in, const void *in2);``
+  *  ``asym_eds_op`` and ``asym_verify_signature``::
+
+       int (*asym_eds_op)(struct kernel_pkey_params *params,
+			  const void *in, void *out);
+       int (*asym_verify_signature)(struct kernel_pkey_params *params,
+				    const void *in, const void *in2);
 
      These methods are optional.  If provided the first allows a key to be
      used to encrypt, decrypt or sign a blob of data, and the second allows a
@@ -1662,8 +1664,10 @@ The structure has a number of fields, some of which are mandatory:
      required crypto isn't available.
 
 
-  *  ``int (*asym_query)(const struct kernel_pkey_params *params,
-			 struct kernel_pkey_query *info);``
+  *  ``asym_query``::
+
+       int (*asym_query)(const struct kernel_pkey_params *params,
+			 struct kernel_pkey_query *info);
 
      This method is optional.  If provided it allows information about the
      public or asymmetric key held in the key to be determined.
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 20/22] docs: net: dpio-driver.rst: fix two codeblock warnings
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (18 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 19/22] docs: security: core.rst: Fix several warnings Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:23 ` [PATCH 21/22] docs: net: sja1105.rst: fix table format Mauro Carvalho Chehab
       [not found] ` <f9fecacbe4ce0b2b3aed38d71ae3753f2daf3ce3.1559171394.git.mchehab+samsung@kernel.org>
  21 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, David S. Miller, Ioana Radulescu, Roy Pledge,
	Horia Geantă,
	Jakub Kicinski, Randy Dunlap, netdev

    Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst:43: WARNING: Definition list ends without a blank line; unexpected unindent.
    Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst:63: WARNING: Unexpected indentation. looking for now-outdated files... none found

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 .../networking/device_drivers/freescale/dpaa2/dpio-driver.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst b/Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst
index 5045df990a4c..17dbee1ac53e 100644
--- a/Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst
+++ b/Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst
@@ -39,8 +39,7 @@ The Linux DPIO driver consists of 3 primary components--
 
    DPIO service-- provides APIs to other Linux drivers for services
 
-   QBman portal interface-- sends portal commands, gets responses
-::
+   QBman portal interface-- sends portal commands, gets responses::
 
           fsl-mc          other
            bus           drivers
@@ -60,6 +59,7 @@ The Linux DPIO driver consists of 3 primary components--
 
 The diagram below shows how the DPIO driver components fit with the other
 DPAA2 Linux driver components::
+
                                                    +------------+
                                                    | OS Network |
                                                    |   Stack    |
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* [PATCH 21/22] docs: net: sja1105.rst: fix table format
  2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
                   ` (19 preceding siblings ...)
  2019-05-29 23:23 ` [PATCH 20/22] docs: net: dpio-driver.rst: fix two codeblock warnings Mauro Carvalho Chehab
@ 2019-05-29 23:23 ` Mauro Carvalho Chehab
  2019-05-29 23:26   ` Vladimir Oltean
       [not found] ` <f9fecacbe4ce0b2b3aed38d71ae3753f2daf3ce3.1559171394.git.mchehab+samsung@kernel.org>
  21 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-05-29 23:23 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, David S. Miller, Vladimir Oltean,
	Florian Fainelli, netdev

There's a table there with produces two warnings when built
with Sphinx:

    Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.

It will still produce a table, but the html output is wrong, as
it won't interpret the second line as the continuation for the
first ones, because identation doesn't match.

After the change, the output looks a way better and we got rid
of two warnings.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/networking/dsa/sja1105.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/dsa/sja1105.rst b/Documentation/networking/dsa/sja1105.rst
index ea7bac438cfd..cb2858dece93 100644
--- a/Documentation/networking/dsa/sja1105.rst
+++ b/Documentation/networking/dsa/sja1105.rst
@@ -86,13 +86,13 @@ functionality.
 The following traffic modes are supported over the switch netdevices:
 
 +--------------------+------------+------------------+------------------+
-|                    | Standalone |   Bridged with   |   Bridged with   |
-|                    |    ports   | vlan_filtering 0 | vlan_filtering 1 |
+|                    | Standalone | Bridged with     | Bridged with     |
+|                    | ports      | vlan_filtering 0 | vlan_filtering 1 |
 +====================+============+==================+==================+
 | Regular traffic    |     Yes    |       Yes        |  No (use master) |
 +--------------------+------------+------------------+------------------+
 | Management traffic |     Yes    |       Yes        |       Yes        |
-|    (BPDU, PTP)     |            |                  |                  |
+| (BPDU, PTP)        |            |                  |                  |
 +--------------------+------------+------------------+------------------+
 
 Switching features
-- 
2.21.0


^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 21/22] docs: net: sja1105.rst: fix table format
  2019-05-29 23:23 ` [PATCH 21/22] docs: net: sja1105.rst: fix table format Mauro Carvalho Chehab
@ 2019-05-29 23:26   ` Vladimir Oltean
  0 siblings, 0 replies; 44+ messages in thread
From: Vladimir Oltean @ 2019-05-29 23:26 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, lkml,
	Jonathan Corbet, David S. Miller, Florian Fainelli, netdev

On Thu, 30 May 2019 at 02:24, Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
>
> There's a table there with produces two warnings when built
> with Sphinx:
>
>     Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.
>     Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> It will still produce a table, but the html output is wrong, as
> it won't interpret the second line as the continuation for the
> first ones, because identation doesn't match.
>
> After the change, the output looks a way better and we got rid
> of two warnings.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  Documentation/networking/dsa/sja1105.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/networking/dsa/sja1105.rst b/Documentation/networking/dsa/sja1105.rst
> index ea7bac438cfd..cb2858dece93 100644
> --- a/Documentation/networking/dsa/sja1105.rst
> +++ b/Documentation/networking/dsa/sja1105.rst
> @@ -86,13 +86,13 @@ functionality.
>  The following traffic modes are supported over the switch netdevices:
>
>  +--------------------+------------+------------------+------------------+
> -|                    | Standalone |   Bridged with   |   Bridged with   |
> -|                    |    ports   | vlan_filtering 0 | vlan_filtering 1 |
> +|                    | Standalone | Bridged with     | Bridged with     |
> +|                    | ports      | vlan_filtering 0 | vlan_filtering 1 |
>  +====================+============+==================+==================+
>  | Regular traffic    |     Yes    |       Yes        |  No (use master) |
>  +--------------------+------------+------------------+------------------+
>  | Management traffic |     Yes    |       Yes        |       Yes        |
> -|    (BPDU, PTP)     |            |                  |                  |
> +| (BPDU, PTP)        |            |                  |                  |
>  +--------------------+------------+------------------+------------------+
>
>  Switching features
> --
> 2.21.0
>

Acked-by: Vladimir Oltean <olteanv@gmail.com>

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 09/22] docs: mark orphan documents as such
  2019-05-29 23:23 ` [PATCH 09/22] docs: mark orphan documents as such Mauro Carvalho Chehab
@ 2019-05-30  8:30   ` Paolo Bonzini
  2019-06-03  7:32   ` Christophe Leroy
  1 sibling, 0 replies; 44+ messages in thread
From: Paolo Bonzini @ 2019-05-30  8:30 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
	Frederic Barrat, Andrew Donnellan, Maxime Coquelin,
	Alexandre Torgue, Maarten Lankhorst, Maxime Ripard, Sean Paul,
	David Airlie, Daniel Vetter, Georgi Djakov, Matan Ziv-Av,
	Benjamin Herrenschmidt, Paul Mackerras, Michael Ellerman,
	Radim Krčmář,
	linuxppc-dev, linux-stm32, linux-arm-kernel, dri-devel, linux-pm,
	platform-driver-x86, kvm

On 30/05/19 01:23, Mauro Carvalho Chehab wrote:
> Sphinx doesn't like orphan documents:
> 
>     Documentation/accelerators/ocxl.rst: WARNING: document isn't included in any toctree
>     Documentation/arm/stm32/overview.rst: WARNING: document isn't included in any toctree
>     Documentation/arm/stm32/stm32f429-overview.rst: WARNING: document isn't included in any toctree
>     Documentation/arm/stm32/stm32f746-overview.rst: WARNING: document isn't included in any toctree
>     Documentation/arm/stm32/stm32f769-overview.rst: WARNING: document isn't included in any toctree
>     Documentation/arm/stm32/stm32h743-overview.rst: WARNING: document isn't included in any toctree
>     Documentation/arm/stm32/stm32mp157-overview.rst: WARNING: document isn't included in any toctree
>     Documentation/gpu/msm-crash-dump.rst: WARNING: document isn't included in any toctree
>     Documentation/interconnect/interconnect.rst: WARNING: document isn't included in any toctree
>     Documentation/laptops/lg-laptop.rst: WARNING: document isn't included in any toctree
>     Documentation/powerpc/isa-versions.rst: WARNING: document isn't included in any toctree
>     Documentation/virtual/kvm/amd-memory-encryption.rst: WARNING: document isn't included in any toctree
>     Documentation/virtual/kvm/vcpu-requests.rst: WARNING: document isn't included in any toctree
> 
> So, while they aren't on any toctree, add :orphan: to them, in order
> to silent this warning.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Please leave out KVM, I'll fix that instead.  Thanks for the report!

Paolo

> ---
>  Documentation/accelerators/ocxl.rst                 | 2 ++
>  Documentation/arm/stm32/overview.rst                | 2 ++
>  Documentation/arm/stm32/stm32f429-overview.rst      | 2 ++
>  Documentation/arm/stm32/stm32f746-overview.rst      | 2 ++
>  Documentation/arm/stm32/stm32f769-overview.rst      | 2 ++
>  Documentation/arm/stm32/stm32h743-overview.rst      | 2 ++
>  Documentation/arm/stm32/stm32mp157-overview.rst     | 2 ++
>  Documentation/gpu/msm-crash-dump.rst                | 2 ++
>  Documentation/interconnect/interconnect.rst         | 2 ++
>  Documentation/laptops/lg-laptop.rst                 | 2 ++
>  Documentation/powerpc/isa-versions.rst              | 2 ++
>  Documentation/virtual/kvm/amd-memory-encryption.rst | 2 ++
>  Documentation/virtual/kvm/vcpu-requests.rst         | 2 ++
>  13 files changed, 26 insertions(+)
> 
> diff --git a/Documentation/accelerators/ocxl.rst b/Documentation/accelerators/ocxl.rst
> index 14cefc020e2d..b1cea19a90f5 100644
> --- a/Documentation/accelerators/ocxl.rst
> +++ b/Documentation/accelerators/ocxl.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  ========================================================
>  OpenCAPI (Open Coherent Accelerator Processor Interface)
>  ========================================================
> diff --git a/Documentation/arm/stm32/overview.rst b/Documentation/arm/stm32/overview.rst
> index 85cfc8410798..f7e734153860 100644
> --- a/Documentation/arm/stm32/overview.rst
> +++ b/Documentation/arm/stm32/overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  ========================
>  STM32 ARM Linux Overview
>  ========================
> diff --git a/Documentation/arm/stm32/stm32f429-overview.rst b/Documentation/arm/stm32/stm32f429-overview.rst
> index 18feda97f483..65bbb1c3b423 100644
> --- a/Documentation/arm/stm32/stm32f429-overview.rst
> +++ b/Documentation/arm/stm32/stm32f429-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  STM32F429 Overview
>  ==================
>  
> diff --git a/Documentation/arm/stm32/stm32f746-overview.rst b/Documentation/arm/stm32/stm32f746-overview.rst
> index b5f4b6ce7656..42d593085015 100644
> --- a/Documentation/arm/stm32/stm32f746-overview.rst
> +++ b/Documentation/arm/stm32/stm32f746-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  STM32F746 Overview
>  ==================
>  
> diff --git a/Documentation/arm/stm32/stm32f769-overview.rst b/Documentation/arm/stm32/stm32f769-overview.rst
> index 228656ced2fe..f6adac862b17 100644
> --- a/Documentation/arm/stm32/stm32f769-overview.rst
> +++ b/Documentation/arm/stm32/stm32f769-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  STM32F769 Overview
>  ==================
>  
> diff --git a/Documentation/arm/stm32/stm32h743-overview.rst b/Documentation/arm/stm32/stm32h743-overview.rst
> index 3458dc00095d..c525835e7473 100644
> --- a/Documentation/arm/stm32/stm32h743-overview.rst
> +++ b/Documentation/arm/stm32/stm32h743-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  STM32H743 Overview
>  ==================
>  
> diff --git a/Documentation/arm/stm32/stm32mp157-overview.rst b/Documentation/arm/stm32/stm32mp157-overview.rst
> index 62e176d47ca7..2c52cd020601 100644
> --- a/Documentation/arm/stm32/stm32mp157-overview.rst
> +++ b/Documentation/arm/stm32/stm32mp157-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  STM32MP157 Overview
>  ===================
>  
> diff --git a/Documentation/gpu/msm-crash-dump.rst b/Documentation/gpu/msm-crash-dump.rst
> index 757cd257e0d8..240ef200f76c 100644
> --- a/Documentation/gpu/msm-crash-dump.rst
> +++ b/Documentation/gpu/msm-crash-dump.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  =====================
>  MSM Crash Dump Format
>  =====================
> diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/interconnect/interconnect.rst
> index c3e004893796..56e331dab70e 100644
> --- a/Documentation/interconnect/interconnect.rst
> +++ b/Documentation/interconnect/interconnect.rst
> @@ -1,5 +1,7 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> +:orphan:
> +
>  =====================================
>  GENERIC SYSTEM INTERCONNECT SUBSYSTEM
>  =====================================
> diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst
> index aa503ee9b3bc..f2c2ffe31101 100644
> --- a/Documentation/laptops/lg-laptop.rst
> +++ b/Documentation/laptops/lg-laptop.rst
> @@ -1,5 +1,7 @@
>  .. SPDX-License-Identifier: GPL-2.0+
>  
> +:orphan:
> +
>  LG Gram laptop extra features
>  =============================
>  
> diff --git a/Documentation/powerpc/isa-versions.rst b/Documentation/powerpc/isa-versions.rst
> index 812e20cc898c..66c24140ebf1 100644
> --- a/Documentation/powerpc/isa-versions.rst
> +++ b/Documentation/powerpc/isa-versions.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  CPU to ISA Version Mapping
>  ==========================
>  
> diff --git a/Documentation/virtual/kvm/amd-memory-encryption.rst b/Documentation/virtual/kvm/amd-memory-encryption.rst
> index 659bbc093b52..33d697ab8a58 100644
> --- a/Documentation/virtual/kvm/amd-memory-encryption.rst
> +++ b/Documentation/virtual/kvm/amd-memory-encryption.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  ======================================
>  Secure Encrypted Virtualization (SEV)
>  ======================================
> diff --git a/Documentation/virtual/kvm/vcpu-requests.rst b/Documentation/virtual/kvm/vcpu-requests.rst
> index 5feb3706a7ae..c1807a1b92e6 100644
> --- a/Documentation/virtual/kvm/vcpu-requests.rst
> +++ b/Documentation/virtual/kvm/vcpu-requests.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>  =================
>  KVM VCPU Requests
>  =================
> 


^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 10/22] docs: amd-memory-encryption.rst get rid of warnings
  2019-05-29 23:23 ` [PATCH 10/22] docs: amd-memory-encryption.rst get rid of warnings Mauro Carvalho Chehab
@ 2019-05-30  8:30   ` Paolo Bonzini
  0 siblings, 0 replies; 44+ messages in thread
From: Paolo Bonzini @ 2019-05-30  8:30 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
	Radim Krčmář,
	kvm

On 30/05/19 01:23, Mauro Carvalho Chehab wrote:
> Get rid of those warnings:
> 
>     Documentation/virtual/kvm/amd-memory-encryption.rst:244: WARNING: Citation [white-paper] is not referenced.
>     Documentation/virtual/kvm/amd-memory-encryption.rst:246: WARNING: Citation [amd-apm] is not referenced.
>     Documentation/virtual/kvm/amd-memory-encryption.rst:247: WARNING: Citation [kvm-forum] is not referenced.
> 
> For references that aren't mentioned at the text by adding an
> explicit reference to them.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  Documentation/virtual/kvm/amd-memory-encryption.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/virtual/kvm/amd-memory-encryption.rst b/Documentation/virtual/kvm/amd-memory-encryption.rst
> index 33d697ab8a58..6c37ff9a0a3c 100644
> --- a/Documentation/virtual/kvm/amd-memory-encryption.rst
> +++ b/Documentation/virtual/kvm/amd-memory-encryption.rst
> @@ -243,6 +243,9 @@ Returns: 0 on success, -negative on error
>  References
>  ==========
>  
> +
> +See [white-paper]_, [api-spec]_, [amd-apm]_ and [kvm-forum]_ for more info.
> +
>  .. [white-paper] http://amd-dev.wpengine.netdna-cdn.com/wordpress/media/2013/12/AMD_Memory_Encryption_Whitepaper_v7-Public.pdf
>  .. [api-spec] http://support.amd.com/TechDocs/55766_SEV-KM_API_Specification.pdf
>  .. [amd-apm] http://support.amd.com/TechDocs/24593.pdf (section 15.34)
> 

Acked-by: Paolo Bonzini <pbonzini@redhat.com>

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 22/22] docs: fix broken documentation links
       [not found] ` <f9fecacbe4ce0b2b3aed38d71ae3753f2daf3ce3.1559171394.git.mchehab+samsung@kernel.org>
@ 2019-05-30 13:12   ` Sven Van Asbroeck
       [not found]   ` <1574052.9PXfBvmXpz@harkonnen>
  1 sibling, 0 replies; 44+ messages in thread
From: Sven Van Asbroeck @ 2019-05-30 13:12 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Greg KH, Linux Kernel Mailing List, Linux Doc Mailing List

On Wed, May 29, 2019 at 7:24 PM Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
>
> Mostly due to x86 and acpi conversion, several documentation
> links are still pointing to the old file. Fix them.

For drivers/staging/fieldbus/Documentation/fieldbus_dev.txt:

Reviewed-by: Sven Van Asbroeck <TheSven73@gmail.com>

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs
  2019-05-29 23:23 ` [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
@ 2019-05-30 16:57   ` Rafael J. Wysocki
  0 siblings, 0 replies; 44+ messages in thread
From: Rafael J. Wysocki @ 2019-05-30 16:57 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Thomas Gleixner, Jon Masters,
	Greg Kroah-Hartman, Borislav Petkov, Josh Poimboeuf,
	Rafael J. Wysocki, Jiri Kosina

On Thursday, May 30, 2019 1:23:32 AM CEST Mauro Carvalho Chehab wrote:
> The cpuidle doc was split on two, one at the admin guide
> and another one at the driver API guide. Instead of pointing
> to a non-existent file, point to both (admin guide being
> the first one).
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

> ---
>  Documentation/ABI/testing/sysfs-devices-system-cpu | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu
> index 1528239f69b2..87478ac6c2af 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-cpu
> +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu
> @@ -137,7 +137,8 @@ Description:	Discover cpuidle policy and mechanism
>  		current_governor: (RW) displays current idle policy. Users can
>  		switch the governor at runtime by writing to this file.
>  
> -		See files in Documentation/cpuidle/ for more information.
> +		See Documentation/admin-guide/pm/cpuidle.rst and
> +		Documentation/driver-api/pm/cpuidle.rst for more information.
>  
>  
>  What:		/sys/devices/system/cpu/cpuX/cpuidle/stateN/name
> 





^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 08/22] docs: bpf: get rid of two warnings
  2019-05-29 23:23 ` [PATCH 08/22] docs: bpf: get rid of two warnings Mauro Carvalho Chehab
@ 2019-05-30 18:08   ` Song Liu
  0 siblings, 0 replies; 44+ messages in thread
From: Song Liu @ 2019-05-30 18:08 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, open list,
	Jonathan Corbet, Alexei Starovoitov, Daniel Borkmann,
	Martin KaFai Lau, Song Liu, Yonghong Song, Networking, bpf

On Wed, May 29, 2019 at 4:25 PM Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
>
> Documentation/bpf/btf.rst:154: WARNING: Unexpected indentation.
> Documentation/bpf/btf.rst:163: WARNING: Unexpected indentation.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Acked-by: Song Liu <songliubraving@fb.com>

> ---
>  Documentation/bpf/btf.rst | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/Documentation/bpf/btf.rst b/Documentation/bpf/btf.rst
> index 8820360d00da..4ae022d274ab 100644
> --- a/Documentation/bpf/btf.rst
> +++ b/Documentation/bpf/btf.rst
> @@ -151,6 +151,7 @@ for the type. The maximum value of ``BTF_INT_BITS()`` is 128.
>
>  The ``BTF_INT_OFFSET()`` specifies the starting bit offset to calculate values
>  for this int. For example, a bitfield struct member has:
> +
>   * btf member bit offset 100 from the start of the structure,
>   * btf member pointing to an int type,
>   * the int type has ``BTF_INT_OFFSET() = 2`` and ``BTF_INT_BITS() = 4``
> @@ -160,6 +161,7 @@ from bits ``100 + 2 = 102``.
>
>  Alternatively, the bitfield struct member can be the following to access the
>  same bits as the above:
> +
>   * btf member bit offset 102,
>   * btf member pointing to an int type,
>   * the int type has ``BTF_INT_OFFSET() = 0`` and ``BTF_INT_BITS() = 4``
> --
> 2.21.0
>

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag
  2019-05-29 23:23 ` [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag Mauro Carvalho Chehab
@ 2019-05-30 19:43   ` James Morris
  2019-06-03 20:29   ` Jarkko Sakkinen
  1 sibling, 0 replies; 44+ messages in thread
From: James Morris @ 2019-05-30 19:43 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Mimi Zohar, James Bottomley, Jarkko Sakkinen,
	linux-integrity, keyrings

On Wed, 29 May 2019, Mauro Carvalho Chehab wrote:

> The code-block tag is at the wrong place, causing those
> warnings:
> 
>     Documentation/security/keys/trusted-encrypted.rst:112: WARNING: Literal block expected; none found.
>     Documentation/security/keys/trusted-encrypted.rst:121: WARNING: Unexpected indentation.
>     Documentation/security/keys/trusted-encrypted.rst:122: WARNING: Block quote ends without a blank line; unexpected unindent.
>     Documentation/security/keys/trusted-encrypted.rst:123: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>


Acked-by: James Morris <jamorris@linux.microsoft.com>


-- 
James Morris
<jmorris@namei.org>


^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 06/22] doc: it_IT: fix reference to magic-number.rst
  2019-05-29 23:23 ` [PATCH 06/22] doc: it_IT: fix reference to magic-number.rst Mauro Carvalho Chehab
@ 2019-05-30 20:15   ` Federico Vaga
  0 siblings, 0 replies; 44+ messages in thread
From: Federico Vaga @ 2019-05-30 20:15 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Alessia Mantegazza

On Thursday, May 30, 2019 1:23:37 AM CEST Mauro Carvalho Chehab wrote:
> There's a typo at the referred file.

I am about to send a patch that fixes all issues found by
documentation-file-ref-check in Documentation/translations/it_IT.

Of course I fixed this as well.

> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  Documentation/translations/it_IT/process/magic-number.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/translations/it_IT/process/magic-number.rst
> b/Documentation/translations/it_IT/process/magic-number.rst index
> 5281d53e57ee..ed1121d0ba84 100644
> --- a/Documentation/translations/it_IT/process/magic-number.rst
> +++ b/Documentation/translations/it_IT/process/magic-number.rst
> @@ -1,6 +1,6 @@
>  .. include:: ../disclaimer-ita.rst
> 
> -:Original: :ref:`Documentation/process/magic-numbers.rst <magicnumbers>`
> +:Original: :ref:`Documentation/process/magic-number.rst <magicnumbers>`
> 
>  :Translator: Federico Vaga <federico.vaga@vaga.pv.it>
> 
>  .. _it_magicnumbers:





^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 15/22] docs: it: license-rules.rst: get rid of warnings
  2019-05-29 23:23 ` [PATCH 15/22] docs: it: license-rules.rst: get rid of warnings Mauro Carvalho Chehab
@ 2019-05-30 20:23   ` Federico Vaga
  0 siblings, 0 replies; 44+ messages in thread
From: Federico Vaga @ 2019-05-30 20:23 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet

On Thursday, May 30, 2019 1:23:46 AM CEST Mauro Carvalho Chehab wrote:
> There's a wrong identation on a code block, and it tries to use
> a reference that was not defined at the Italian translation.
> 
>     Documentation/translations/it_IT/process/license-rules.rst:329: WARNING:
> Literal block expected; none found.
> Documentation/translations/it_IT/process/license-rules.rst:332: WARNING:
> Unexpected indentation.
> Documentation/translations/it_IT/process/license-rules.rst:339: WARNING:
> Block quote ends without a blank line; unexpected unindent.
> Documentation/translations/it_IT/process/license-rules.rst:341: WARNING:
> Unexpected indentation.
> Documentation/translations/it_IT/process/license-rules.rst:305: WARNING:
> Unknown target name: "metatags".
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  .../it_IT/process/license-rules.rst           | 28 +++++++++----------
>  1 file changed, 14 insertions(+), 14 deletions(-)
> 
> diff --git a/Documentation/translations/it_IT/process/license-rules.rst
> b/Documentation/translations/it_IT/process/license-rules.rst index
> f058e06996dc..06abeb7dd307 100644
> --- a/Documentation/translations/it_IT/process/license-rules.rst
> +++ b/Documentation/translations/it_IT/process/license-rules.rst
> @@ -303,7 +303,7 @@ essere categorizzate in:
>       LICENSES/dual
> 
>     I file in questa cartella contengono il testo completo della rispettiva
> -   licenza e i suoi `Metatags`_.  I nomi dei file sono identici agli
> +   licenza e i suoi `Metatags`.  I nomi dei file sono identici agli

Remove 's' instead of '_' and then the link is correct

`Metatag`_

>     identificatori di licenza SPDX che dovrebbero essere usati nei file
>     sorgenti.
> 
> @@ -326,19 +326,19 @@ essere categorizzate in:
> 
>     Esempio del formato del file::
> 
> -   Valid-License-Identifier: MPL-1.1
> -   SPDX-URL: https://spdx.org/licenses/MPL-1.1.html
> -   Usage-Guide:
> -     Do NOT use. The MPL-1.1 is not GPL2 compatible. It may only be used
> for -     dual-licensed files where the other license is GPL2 compatible. -
>     If you end up using this it MUST be used together with a GPL2
> compatible -     license using "OR".
> -     To use the Mozilla Public License version 1.1 put the following SPDX
> -     tag/value pair into a comment according to the placement guidelines in
> -     the licensing rules documentation:
> -   SPDX-License-Identifier: MPL-1.1
> -   License-Text:
> -     Full license text
> +    Valid-License-Identifier: MPL-1.1
> +    SPDX-URL: https://spdx.org/licenses/MPL-1.1.html
> +    Usage-Guide:
> +      Do NOT use. The MPL-1.1 is not GPL2 compatible. It may only be used
> for +      dual-licensed files where the other license is GPL2 compatible.
> +      If you end up using this it MUST be used together with a GPL2
> compatible +      license using "OR".
> +      To use the Mozilla Public License version 1.1 put the following SPDX
> +      tag/value pair into a comment according to the placement guidelines
> in +      the licensing rules documentation:
> +    SPDX-License-Identifier: MPL-1.1
> +    License-Text:
> +      Full license text





^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 22/22] docs: fix broken documentation links
       [not found]   ` <1574052.9PXfBvmXpz@harkonnen>
@ 2019-05-30 22:49     ` Michael S. Tsirkin
  0 siblings, 0 replies; 44+ messages in thread
From: Michael S. Tsirkin @ 2019-05-30 22:49 UTC (permalink / raw)
  To: Federico Vaga
  Cc: Linux Doc Mailing List, linux-kernel, x86, linux-acpi,
	linux-edac, netdev, devicetree, linux-pci, linux-arm-kernel,
	linux-amlogic, linux-arm-msm, linux-gpio, linux-i2c,
	linuxppc-dev, xen-devel, platform-driver-x86, devel, kvm,
	virtualization, devel, linux-mm, linux-security-module,
	linux-kselftest

On Thu, May 30, 2019 at 10:17:32PM +0200, Federico Vaga wrote:
> On Thursday, May 30, 2019 1:23:53 AM CEST Mauro Carvalho Chehab wrote:
> > Mostly due to x86 and acpi conversion, several documentation
> > links are still pointing to the old file. Fix them.
> 
> For the Italian documentation I just send I patch to fix them in a dedicated 
> patch


Acked-by: Michael S. Tsirkin <mst@redhat.com>

for the vhost change.

> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> >  Documentation/acpi/dsd/leds.txt                  |  2 +-
> >  Documentation/admin-guide/kernel-parameters.rst  |  6 +++---
> >  Documentation/admin-guide/kernel-parameters.txt  | 16 ++++++++--------
> >  Documentation/admin-guide/ras.rst                |  2 +-
> >  .../devicetree/bindings/net/fsl-enetc.txt        |  7 +++----
> >  .../bindings/pci/amlogic,meson-pcie.txt          |  2 +-
> >  .../bindings/regulator/qcom,rpmh-regulator.txt   |  2 +-
> >  Documentation/devicetree/booting-without-of.txt  |  2 +-
> >  Documentation/driver-api/gpio/board.rst          |  2 +-
> >  Documentation/driver-api/gpio/consumer.rst       |  2 +-
> >  .../firmware-guide/acpi/enumeration.rst          |  2 +-
> >  .../firmware-guide/acpi/method-tracing.rst       |  2 +-
> >  Documentation/i2c/instantiating-devices          |  2 +-
> >  Documentation/sysctl/kernel.txt                  |  4 ++--
> >  .../translations/it_IT/process/howto.rst         |  2 +-
> >  .../it_IT/process/stable-kernel-rules.rst        |  4 ++--
> >  .../translations/zh_CN/process/4.Coding.rst      |  2 +-
> >  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/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 +-
> >  mm/Kconfig                                       |  2 +-
> >  security/Kconfig                                 |  2 +-
> >  tools/include/linux/err.h                        |  2 +-
> >  tools/objtool/Documentation/stack-validation.txt |  4 ++--
> >  tools/testing/selftests/x86/protection_keys.c    |  2 +-
> >  48 files changed, 77 insertions(+), 78 deletions(-)
> > 
> > diff --git a/Documentation/acpi/dsd/leds.txt
> > b/Documentation/acpi/dsd/leds.txt index 81a63af42ed2..cc58b1a574c5 100644
> > --- a/Documentation/acpi/dsd/leds.txt
> > +++ b/Documentation/acpi/dsd/leds.txt
> > @@ -96,4 +96,4 @@ where
> >     
> > <URL:http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-da
> > ta-extension-UUID-v1.1.pdf>, referenced 2019-02-21.
> > 
> > -[7] Documentation/acpi/dsd/data-node-reference.txt
> > +[7] Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> > diff --git a/Documentation/admin-guide/kernel-parameters.rst
> > b/Documentation/admin-guide/kernel-parameters.rst index
> > 0124980dca2d..8d3273e32eb1 100644
> > --- a/Documentation/admin-guide/kernel-parameters.rst
> > +++ b/Documentation/admin-guide/kernel-parameters.rst
> > @@ -167,7 +167,7 @@ parameter is applicable::
> >  	X86-32	X86-32, aka i386 architecture is enabled.
> >  	X86-64	X86-64 architecture is enabled.
> >  			More X86-64 boot options can be found in
> > -			Documentation/x86/x86_64/boot-options.txt 
> .
> > +			Documentation/x86/x86_64/boot-options.rst.
> >  	X86	Either 32-bit or 64-bit x86 (same as X86-32+X86-64)
> >  	X86_UV	SGI UV support is enabled.
> >  	XEN	Xen support is enabled
> > @@ -181,10 +181,10 @@ In addition, the following text indicates that the
> > option:: Parameters denoted with BOOT are actually interpreted by the boot
> > loader, and have no meaning to the kernel directly.
> >  Do not modify the syntax of boot loader parameters without extreme
> > -need or coordination with <Documentation/x86/boot.txt>.
> > +need or coordination with <Documentation/x86/boot.rst>.
> > 
> >  There are also arch-specific kernel-parameters not documented here.
> > -See for example <Documentation/x86/x86_64/boot-options.txt>.
> > +See for example <Documentation/x86/x86_64/boot-options.rst>.
> > 
> >  Note that ALL kernel parameters listed below are CASE SENSITIVE, and that
> >  a trailing = on the name of any parameter states that that parameter will
> > diff --git a/Documentation/admin-guide/kernel-parameters.txt
> > b/Documentation/admin-guide/kernel-parameters.txt index
> > 138f6664b2e2..4a02d1346635 100644
> > --- a/Documentation/admin-guide/kernel-parameters.txt
> > +++ b/Documentation/admin-guide/kernel-parameters.txt
> > @@ -53,7 +53,7 @@
> >  			ACPI_DEBUG_PRINT statements, e.g.,
> >  			    ACPI_DEBUG_PRINT((ACPI_DB_INFO, ...
> >  			The debug_level mask defaults to "info".  
> See
> > -			Documentation/acpi/debug.txt for more 
> information about
> > +			Documentation/firmware-guide/acpi/debug.rst 
> for more information about
> >  			debug layers and levels.
> > 
> >  			Enable processor driver info messages:
> > @@ -963,7 +963,7 @@
> >  			for details.
> > 
> >  	nompx		[X86] Disables Intel Memory Protection 
> Extensions.
> > -			See Documentation/x86/intel_mpx.txt for 
> more
> > +			See Documentation/x86/intel_mpx.rst for 
> more
> >  			information about the feature.
> > 
> >  	nopku		[X86] Disable Memory Protection Keys CPU 
> feature found
> > @@ -1189,7 +1189,7 @@
> >  			that is to be dynamically loaded by Linux. 
> If there are
> >  			multiple variables with the same name but 
> with different
> >  			vendor GUIDs, all of them will be loaded. 
> See
> > -			Documentation/acpi/ssdt-overlays.txt for 
> details.
> > +			Documentation/admin-guide/acpi/ssdt-
> overlays.rst for details.
> > 
> > 
> >  	eisa_irq_edge=	[PARISC,HW]
> > @@ -2383,7 +2383,7 @@
> > 
> >  	mce		[X86-32] Machine Check Exception
> > 
> > -	mce=option	[X86-64] See Documentation/x86/x86_64/boot-
> options.txt
> > +	mce=option	[X86-64] See Documentation/x86/x86_64/boot-
> options.rst
> > 
> >  	md=		[HW] RAID subsystems devices and level
> >  			See Documentation/admin-guide/md.rst.
> > @@ -2439,7 +2439,7 @@
> >  			set according to the
> >  			CONFIG_MEMORY_HOTPLUG_DEFAULT_ONLINE 
> kernel config
> >  			option.
> > -			See Documentation/memory-hotplug.txt.
> > +			See Documentation/admin-guide/mm/memory-
> hotplug.rst.
> > 
> >  	memmap=exactmap	[KNL,X86] Enable setting of an exact
> >  			E820 memory map, as specified by the user.
> > @@ -2528,7 +2528,7 @@
> >  			mem_encrypt=on:		Activate 
> SME
> >  			mem_encrypt=off:	Do not activate SME
> > 
> > -			Refer to Documentation/x86/amd-memory-
> encryption.txt
> > +			Refer to Documentation/virtual/kvm/amd-
> memory-encryption.rst
> >  			for details on when memory encryption can 
> be activated.
> > 
> >  	mem_sleep_default=	[SUSPEND] Default system suspend mode:
> > @@ -3528,7 +3528,7 @@
> >  			See Documentation/blockdev/paride.txt.
> > 
> >  	pirq=		[SMP,APIC] Manual mp-table setup
> > -			See Documentation/x86/i386/IO-APIC.txt.
> > +			See Documentation/x86/i386/IO-APIC.rst.
> > 
> >  	plip=		[PPT,NET] Parallel port network link
> >  			Format: { parport<nr> | timid | 0 }
> > @@ -5054,7 +5054,7 @@
> >  			Can be used multiple times for multiple 
> devices.
> > 
> >  	vga=		[BOOT,X86-32] Select a particular video 
> mode
> > -			See Documentation/x86/boot.txt and
> > +			See Documentation/x86/boot.rst and
> >  			Documentation/svga.txt.
> >  			Use vga=ask for menu.
> >  			This is actually a boot loader parameter; 
> the value is
> > diff --git a/Documentation/admin-guide/ras.rst
> > b/Documentation/admin-guide/ras.rst index c7495e42e6f4..2b20f5f7380d 100644
> > --- a/Documentation/admin-guide/ras.rst
> > +++ b/Documentation/admin-guide/ras.rst
> > @@ -199,7 +199,7 @@ Architecture (MCA)\ [#f3]_.
> >    mode).
> > 
> >  .. [#f3] For more details about the Machine Check Architecture (MCA),
> > -  please read Documentation/x86/x86_64/machinecheck at the Kernel tree.
> > +  please read Documentation/x86/x86_64/machinecheck.rst at the Kernel tree.
> > 
> >  EDAC - Error Detection And Correction
> >  *************************************
> > diff --git a/Documentation/devicetree/bindings/net/fsl-enetc.txt
> > b/Documentation/devicetree/bindings/net/fsl-enetc.txt index
> > c812e25ae90f..25fc687419db 100644
> > --- a/Documentation/devicetree/bindings/net/fsl-enetc.txt
> > +++ b/Documentation/devicetree/bindings/net/fsl-enetc.txt
> > @@ -16,8 +16,8 @@ Required properties:
> >  In this case, the ENETC node should include a "mdio" sub-node
> >  that in turn should contain the "ethernet-phy" node describing the
> >  external phy.  Below properties are required, their bindings
> > -already defined in ethernet.txt or phy.txt, under
> > -Documentation/devicetree/bindings/net/*.
> > +already defined in Documentation/devicetree/bindings/net/ethernet.txt or
> > +Documentation/devicetree/bindings/net/phy.txt.
> > 
> >  Required:
> > 
> > @@ -51,8 +51,7 @@ Example:
> >  connection:
> > 
> >  In this case, the ENETC port node defines a fixed link connection,
> > -as specified by "fixed-link.txt", under
> > -Documentation/devicetree/bindings/net/*.
> > +as specified by Documentation/devicetree/bindings/net/fixed-link.txt.
> > 
> >  Required:
> > 
> > diff --git a/Documentation/devicetree/bindings/pci/amlogic,meson-pcie.txt
> > b/Documentation/devicetree/bindings/pci/amlogic,meson-pcie.txt index
> > 12b18f82d441..efa2c8b9b85a 100644
> > --- a/Documentation/devicetree/bindings/pci/amlogic,meson-pcie.txt
> > +++ b/Documentation/devicetree/bindings/pci/amlogic,meson-pcie.txt
> > @@ -3,7 +3,7 @@ Amlogic Meson AXG DWC PCIE SoC controller
> >  Amlogic Meson PCIe host controller is based on the Synopsys DesignWare PCI
> > core. It shares common functions with the PCIe DesignWare core driver and
> > inherits common properties defined in
> > -Documentation/devicetree/bindings/pci/designware-pci.txt.
> > +Documentation/devicetree/bindings/pci/designware-pcie.txt.
> > 
> >  Additional properties are described here:
> > 
> > diff --git
> > a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt
> > b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt index
> > 7ef2dbe48e8a..14d2eee96b3d 100644
> > --- a/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt
> > +++ b/Documentation/devicetree/bindings/regulator/qcom,rpmh-regulator.txt
> > @@ -97,7 +97,7 @@ Second Level Nodes - Regulators
> >  		    sent for this regulator including those which are 
> for a
> >  		    strictly lower power state.
> > 
> > -Other properties defined in Documentation/devicetree/bindings/regulator.txt
> > +Other properties defined in
> > Documentation/devicetree/bindings/regulator/regulator.txt may also be used.
> >  regulator-initial-mode and regulator-allowed-modes may be specified for
> > VRM regulators using mode values from
> >  include/dt-bindings/regulator/qcom,rpmh-regulator.h. 
> > regulator-allow-bypass diff --git
> > a/Documentation/devicetree/booting-without-of.txt
> > b/Documentation/devicetree/booting-without-of.txt index
> > e86bd2f64117..60f8640f2b2f 100644
> > --- a/Documentation/devicetree/booting-without-of.txt
> > +++ b/Documentation/devicetree/booting-without-of.txt
> > @@ -277,7 +277,7 @@ it with special cases.
> >    the decompressor (the real mode entry point goes to the same  32bit
> >    entry point once it switched into protected mode). That entry point
> >    supports one calling convention which is documented in
> > -  Documentation/x86/boot.txt
> > +  Documentation/x86/boot.rst
> >    The physical pointer to the device-tree block (defined in chapter II)
> >    is passed via setup_data which requires at least boot protocol 2.09.
> >    The type filed is defined as
> > diff --git a/Documentation/driver-api/gpio/board.rst
> > b/Documentation/driver-api/gpio/board.rst index b37f3f7b8926..ce91518bf9f4
> > 100644
> > --- a/Documentation/driver-api/gpio/board.rst
> > +++ b/Documentation/driver-api/gpio/board.rst
> > @@ -101,7 +101,7 @@ with the help of _DSD (Device Specific Data), introduced
> > in ACPI 5.1:: }
> > 
> >  For more information about the ACPI GPIO bindings see
> > -Documentation/acpi/gpio-properties.txt.
> > +Documentation/firmware-guide/acpi/gpio-properties.rst.
> > 
> >  Platform Data
> >  -------------
> > diff --git a/Documentation/driver-api/gpio/consumer.rst
> > b/Documentation/driver-api/gpio/consumer.rst index
> > 5e4d8aa68913..fdecb6d711db 100644
> > --- a/Documentation/driver-api/gpio/consumer.rst
> > +++ b/Documentation/driver-api/gpio/consumer.rst
> > @@ -437,7 +437,7 @@ case, it will be handled by the GPIO subsystem
> > automatically.  However, if the _DSD is not present, the mappings between
> > GpioIo()/GpioInt() resources and GPIO connection IDs need to be provided by
> > device drivers.
> > 
> > -For details refer to Documentation/acpi/gpio-properties.txt
> > +For details refer to Documentation/firmware-guide/acpi/gpio-properties.rst
> > 
> > 
> >  Interacting With the Legacy GPIO Subsystem
> > diff --git a/Documentation/firmware-guide/acpi/enumeration.rst
> > b/Documentation/firmware-guide/acpi/enumeration.rst index
> > 850be9696931..1252617b520f 100644
> > --- a/Documentation/firmware-guide/acpi/enumeration.rst
> > +++ b/Documentation/firmware-guide/acpi/enumeration.rst
> > @@ -339,7 +339,7 @@ a code like this::
> >  There are also devm_* versions of these functions which release the
> >  descriptors once the device is released.
> > 
> > -See Documentation/acpi/gpio-properties.txt for more information about the
> > +See Documentation/firmware-guide/acpi/gpio-properties.rst for more
> > information about the _DSD binding related to GPIOs.
> > 
> >  MFD devices
> > diff --git a/Documentation/firmware-guide/acpi/method-tracing.rst
> > b/Documentation/firmware-guide/acpi/method-tracing.rst index
> > d0b077b73f5f..0aa7e2c5d32a 100644
> > --- a/Documentation/firmware-guide/acpi/method-tracing.rst
> > +++ b/Documentation/firmware-guide/acpi/method-tracing.rst
> > @@ -68,7 +68,7 @@ c. Filter out the debug layer/level matched logs when the
> > specified
> > 
> >  Where:
> >     0xXXXXXXXX/0xYYYYYYYY
> > -     Refer to Documentation/acpi/debug.txt for possible debug layer/level
> > +     Refer to Documentation/firmware-guide/acpi/debug.rst for possible
> > debug layer/level masking values.
> >     \PPPP.AAAA.TTTT.HHHH
> >       Full path of a control method that can be found in the ACPI namespace.
> > diff --git a/Documentation/i2c/instantiating-devices
> > b/Documentation/i2c/instantiating-devices index 0d85ac1935b7..5a3e2f331e8c
> > 100644
> > --- a/Documentation/i2c/instantiating-devices
> > +++ b/Documentation/i2c/instantiating-devices
> > @@ -85,7 +85,7 @@ Method 1c: Declare the I2C devices via ACPI
> >  -------------------------------------------
> > 
> >  ACPI can also describe I2C devices. There is special documentation for this
> > -which is currently located at Documentation/acpi/enumeration.txt. +which
> > is currently located at Documentation/firmware-guide/acpi/enumeration.rst.
> > 
> > 
> >  Method 2: Instantiate the devices explicitly
> > diff --git a/Documentation/sysctl/kernel.txt
> > b/Documentation/sysctl/kernel.txt index f0c86fbb3b48..92f7f34b021a 100644
> > --- a/Documentation/sysctl/kernel.txt
> > +++ b/Documentation/sysctl/kernel.txt
> > @@ -155,7 +155,7 @@ is 0x15 and the full version number is 0x234, this file
> > will contain the value 340 = 0x154.
> > 
> >  See the type_of_loader and ext_loader_type fields in
> > -Documentation/x86/boot.txt for additional information.
> > +Documentation/x86/boot.rst for additional information.
> > 
> >  ==============================================================
> > 
> > @@ -167,7 +167,7 @@ The complete bootloader version number.  In the example
> > above, this file will contain the value 564 = 0x234.
> > 
> >  See the type_of_loader and ext_loader_ver fields in
> > -Documentation/x86/boot.txt for additional information.
> > +Documentation/x86/boot.rst for additional information.
> > 
> >  ==============================================================
> > 
> > diff --git a/Documentation/translations/it_IT/process/howto.rst
> > b/Documentation/translations/it_IT/process/howto.rst index
> > 9903ac7c566b..44e6077730e8 100644
> > --- a/Documentation/translations/it_IT/process/howto.rst
> > +++ b/Documentation/translations/it_IT/process/howto.rst
> > @@ -131,7 +131,7 @@ Di seguito una lista di file che sono presenti nei
> > sorgente del kernel e che "Linux kernel patch submission format"
> >  		http://linux.yyz.us/patch-format.html
> > 
> > -  :ref:`Documentation/process/translations/it_IT/stable-api-nonsense.rst
> > <it_stable_api_nonsense>` + 
> > :ref:`Documentation/translations/it_IT/process/stable-api-nonsense.rst
> > <it_stable_api_nonsense>`
> > 
> >      Questo file descrive la motivazioni sottostanti la conscia decisione di
> > non avere un API stabile all'interno del kernel, incluso cose come: diff
> > --git a/Documentation/translations/it_IT/process/stable-kernel-rules.rst
> > b/Documentation/translations/it_IT/process/stable-kernel-rules.rst index
> > 48e88e5ad2c5..4f206cee31a7 100644
> > --- a/Documentation/translations/it_IT/process/stable-kernel-rules.rst
> > +++ b/Documentation/translations/it_IT/process/stable-kernel-rules.rst
> > @@ -33,7 +33,7 @@ Regole sul tipo di patch che vengono o non vengono
> > accettate nei sorgenti - Non deve includere alcuna correzione "banale"
> > (correzioni grammaticali, pulizia dagli spazi bianchi, eccetera).
> >   - Deve rispettare le regole scritte in
> > -   :ref:`Documentation/translation/it_IT/process/submitting-patches.rst
> > <it_submittingpatches>` +  
> > :ref:`Documentation/translations/it_IT/process/submitting-patches.rst
> > <it_submittingpatches>` - Questa patch o una equivalente deve esistere già
> > nei sorgenti principali di Linux
> > 
> > @@ -43,7 +43,7 @@ Procedura per sottomettere patch per i sorgenti -stable
> > 
> >   - Se la patch contiene modifiche a dei file nelle cartelle net/ o
> > drivers/net, allora seguite le linee guida descritte in
> > -   :ref:`Documentation/translation/it_IT/networking/netdev-FAQ.rst
> > <it_netdev-FAQ>`; +  
> > :ref:`Documentation/translations/it_IT/networking/netdev-FAQ.rst
> > <it_netdev-FAQ>`; ma solo dopo aver verificato al seguente indirizzo che la
> > patch non sia già in coda:
> >    
> > https://patchwork.ozlabs.org/bundle/davem/stable/?series=&submitter=&state=
> > *&q=&archive= diff --git
> > a/Documentation/translations/zh_CN/process/4.Coding.rst
> > b/Documentation/translations/zh_CN/process/4.Coding.rst index
> > 5301e9d55255..8bb777941394 100644
> > --- a/Documentation/translations/zh_CN/process/4.Coding.rst
> > +++ b/Documentation/translations/zh_CN/process/4.Coding.rst
> > @@ -241,7 +241,7 @@ scripts/coccinelle目录下已经打包了相当多的内核“语义补丁”
> > 
> >  任何添加新用户空间界面的代码(包括新的sysfs或/proc文件)都应该包含该界面的
> >  文档,该文档使用户空间开发人员能够知道他们在使用什么。请参阅
> > -Documentation/abi/readme,了解如何格式化此文档以及需要提供哪些信息。
> > +Documentation/ABI/README,了解如何格式化此文档以及需要提供哪些信息。
> > 
> >  文件 :ref:`Documentation/admin-guide/kernel-parameters.rst
> > <kernelparameters>` 描述了内核的所有引导时间参数。任何添加新参数的补丁都应该向该文件添加适当的
> > diff --git a/Documentation/x86/x86_64/5level-paging.rst
> > b/Documentation/x86/x86_64/5level-paging.rst index
> > ab88a4514163..44856417e6a5 100644
> > --- a/Documentation/x86/x86_64/5level-paging.rst
> > +++ b/Documentation/x86/x86_64/5level-paging.rst
> > @@ -20,7 +20,7 @@ physical address space. This "ought to be enough for
> > anybody" ©. QEMU 2.9 and later support 5-level paging.
> > 
> >  Virtual memory layout for 5-level paging is described in
> > -Documentation/x86/x86_64/mm.txt
> > +Documentation/x86/x86_64/mm.rst
> > 
> > 
> >  Enabling 5-level paging
> > diff --git a/Documentation/x86/x86_64/boot-options.rst
> > b/Documentation/x86/x86_64/boot-options.rst index
> > 2f69836b8445..6a4285a3c7a4 100644
> > --- a/Documentation/x86/x86_64/boot-options.rst
> > +++ b/Documentation/x86/x86_64/boot-options.rst
> > @@ -9,7 +9,7 @@ only the AMD64 specific ones are listed here.
> > 
> >  Machine check
> >  =============
> > -Please see Documentation/x86/x86_64/machinecheck for sysfs runtime
> > tunables. +Please see Documentation/x86/x86_64/machinecheck.rst for sysfs
> > runtime tunables.
> > 
> >     mce=off
> >  		Disable machine check
> > @@ -89,7 +89,7 @@ APICs
> >       Don't use the local APIC (alias for i386 compatibility)
> > 
> >     pirq=...
> > -	See Documentation/x86/i386/IO-APIC.txt
> > +	See Documentation/x86/i386/IO-APIC.rst
> > 
> >     noapictimer
> >  	Don't set up the APIC timer
> > diff --git a/Documentation/x86/x86_64/fake-numa-for-cpusets.rst
> > b/Documentation/x86/x86_64/fake-numa-for-cpusets.rst index
> > 74fbb78b3c67..04df57b9aa3f 100644
> > --- a/Documentation/x86/x86_64/fake-numa-for-cpusets.rst
> > +++ b/Documentation/x86/x86_64/fake-numa-for-cpusets.rst
> > @@ -18,7 +18,7 @@ For more information on the features of cpusets, see
> >  Documentation/cgroup-v1/cpusets.txt.
> >  There are a number of different configurations you can use for your needs. 
> > For more information on the numa=fake command line option and its various
> > ways of -configuring fake nodes, see
> > Documentation/x86/x86_64/boot-options.txt. +configuring fake nodes, see
> > Documentation/x86/x86_64/boot-options.rst.
> > 
> >  For the purposes of this introduction, we'll assume a very primitive NUMA
> >  emulation setup of "numa=fake=4*512,".  This will split our system memory
> > into diff --git a/MAINTAINERS b/MAINTAINERS
> > index 5cfbea4ce575..a38d7273705a 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -3874,7 +3874,7 @@
> > F:	Documentation/devicetree/bindings/hwmon/cirrus,lochnagar.txt
> > F:	Documentation/devicetree/bindings/pinctrl/cirrus,lochnagar.txt
> > F:	Documentation/devicetree/bindings/regulator/cirrus,lochnagar.txt
> > F:	Documentation/devicetree/bindings/sound/cirrus,lochnagar.txt
> > -F:	Documentation/hwmon/lochnagar
> > +F:	Documentation/hwmon/lochnagar.rst
> > 
> >  CISCO FCOE HBA DRIVER
> >  M:	Satish Kharat <satishkh@cisco.com>
> > @@ -11272,7 +11272,7 @@ NXP FXAS21002C DRIVER
> >  M:	Rui Miguel Silva <rmfrfs@gmail.com>
> >  L:	linux-iio@vger.kernel.org
> >  S:	Maintained
> > -F:	Documentation/devicetree/bindings/iio/gyroscope/fxas21002c.txt
> > +F:	Documentation/devicetree/bindings/iio/gyroscope/nxp,fxas21002c.txt
> >  F:	drivers/iio/gyro/fxas21002c_core.c
> >  F:	drivers/iio/gyro/fxas21002c.h
> >  F:	drivers/iio/gyro/fxas21002c_i2c.c
> > @@ -13043,7 +13043,7 @@ M:	Niklas Cassel <niklas.cassel@linaro.org>
> >  L:	netdev@vger.kernel.org
> >  S:	Maintained
> >  F:	drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c
> > -F:	Documentation/devicetree/bindings/net/qcom,dwmac.txt
> > +F:	Documentation/devicetree/bindings/net/qcom,ethqos.txt
> > 
> >  QUALCOMM GENERIC INTERFACE I2C DRIVER
> >  M:	Alok Chauhan <alokc@codeaurora.org>
> > diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig
> > index 8869742a85df..0f220264cc23 100644
> > --- a/arch/arm/Kconfig
> > +++ b/arch/arm/Kconfig
> > @@ -1263,7 +1263,7 @@ config SMP
> >  	  uniprocessor machines. On a uniprocessor machine, the kernel
> >  	  will run faster if you say N here.
> > 
> > -	  See also <file:Documentation/x86/i386/IO-APIC.txt>,
> > +	  See also <file:Documentation/x86/i386/IO-APIC.rst>,
> >  	  <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO 
> available at
> > <http://tldp.org/HOWTO/SMP-HOWTO.html>.
> > 
> > diff --git a/arch/arm64/kernel/kexec_image.c
> > b/arch/arm64/kernel/kexec_image.c index 07bf740bea91..31cc2f423aa8 100644
> > --- a/arch/arm64/kernel/kexec_image.c
> > +++ b/arch/arm64/kernel/kexec_image.c
> > @@ -53,7 +53,7 @@ static void *image_load(struct kimage *image,
> > 
> >  	/*
> >  	 * We require a kernel with an unambiguous Image header. Per
> > -	 * Documentation/booting.txt, this is the case when image_size
> > +	 * Documentation/arm64/booting.txt, this is the case when 
> image_size
> >  	 * is non-zero (practically speaking, since v3.17).
> >  	 */
> >  	h = (struct arm64_image_header *)kernel;
> > diff --git a/arch/powerpc/Kconfig b/arch/powerpc/Kconfig
> > index 8c1c636308c8..e868d2bd48b8 100644
> > --- a/arch/powerpc/Kconfig
> > +++ b/arch/powerpc/Kconfig
> > @@ -898,7 +898,7 @@ config PPC_MEM_KEYS
> >  	  page-based protections, but without requiring modification of 
> the
> >  	  page tables when an application changes protection domains.
> > 
> > -	  For details, see Documentation/vm/protection-keys.rst
> > +	  For details, see Documentation/x86/protection-keys.rst
> > 
> >  	  If unsure, say y.
> > 
> > diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
> > index 2bbbd4d1ba31..78fdf2dd71d1 100644
> > --- a/arch/x86/Kconfig
> > +++ b/arch/x86/Kconfig
> > @@ -395,7 +395,7 @@ config SMP
> >  	  Y to "Enhanced Real Time Clock Support", below. The "Advanced 
> Power
> >  	  Management" code will be disabled if you say Y here.
> > 
> > -	  See also <file:Documentation/x86/i386/IO-APIC.txt>,
> > +	  See also <file:Documentation/x86/i386/IO-APIC.rst>,
> >  	  <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO 
> available at
> > <http://www.tldp.org/docs.html#howto>.
> > 
> > @@ -1290,7 +1290,7 @@ config MICROCODE
> >  	  the Linux kernel.
> > 
> >  	  The preferred method to load microcode from a detached initrd is
> > described -	  in Documentation/x86/microcode.txt. For that you 
> need to
> > enable +	  in Documentation/x86/microcode.rst. For that you need to enable
> > CONFIG_BLK_DEV_INITRD in order for the loader to be able to scan the initrd
> > for microcode blobs.
> > 
> > @@ -1329,7 +1329,7 @@ config MICROCODE_OLD_INTERFACE
> >  	  It is inadequate because it runs too late to be able to properly
> >  	  load microcode on a machine and it needs special tools. Instead, 
> you
> >  	  should've switched to the early loading method with the initrd 
> or
> > -	  builtin microcode by now: Documentation/x86/microcode.txt
> > +	  builtin microcode by now: Documentation/x86/microcode.rst
> > 
> >  config X86_MSR
> >  	tristate "/dev/cpu/*/msr - Model-specific register support"
> > @@ -1478,7 +1478,7 @@ config X86_5LEVEL
> >  	  A kernel with the option enabled can be booted on machines that
> >  	  support 4- or 5-level paging.
> > 
> > -	  See Documentation/x86/x86_64/5level-paging.txt for more
> > +	  See Documentation/x86/x86_64/5level-paging.rst for more
> >  	  information.
> > 
> >  	  Say N if unsure.
> > @@ -1626,7 +1626,7 @@ config ARCH_MEMORY_PROBE
> >  	depends on X86_64 && MEMORY_HOTPLUG
> >  	help
> >  	  This option enables a sysfs memory/probe interface for testing.
> > -	  See Documentation/memory-hotplug.txt for more information.
> > +	  See Documentation/admin-guide/mm/memory-hotplug.rst for more
> > information. If you are unsure how to answer this question, answer N.
> > 
> >  config ARCH_PROC_KCORE_TEXT
> > @@ -1783,7 +1783,7 @@ config MTRR
> >  	  You can safely say Y even if your machine doesn't have MTRRs, 
> you'll
> >  	  just add about 9 KB to your kernel.
> > 
> > -	  See <file:Documentation/x86/mtrr.txt> for more information.
> > +	  See <file:Documentation/x86/mtrr.rst> for more information.
> > 
> >  config MTRR_SANITIZER
> >  	def_bool y
> > @@ -1895,7 +1895,7 @@ config X86_INTEL_MPX
> >  	  process and adds some branches to paths used during
> >  	  exec() and munmap().
> > 
> > -	  For details, see Documentation/x86/intel_mpx.txt
> > +	  For details, see Documentation/x86/intel_mpx.rst
> > 
> >  	  If unsure, say N.
> > 
> > @@ -1911,7 +1911,7 @@ config X86_INTEL_MEMORY_PROTECTION_KEYS
> >  	  page-based protections, but without requiring modification of 
> the
> >  	  page tables when an application changes protection domains.
> > 
> > -	  For details, see Documentation/x86/protection-keys.txt
> > +	  For details, see Documentation/x86/protection-keys.rst
> > 
> >  	  If unsure, say y.
> > 
> > diff --git a/arch/x86/Kconfig.debug b/arch/x86/Kconfig.debug
> > index f730680dc818..59f598543203 100644
> > --- a/arch/x86/Kconfig.debug
> > +++ b/arch/x86/Kconfig.debug
> > @@ -156,7 +156,7 @@ config IOMMU_DEBUG
> >  	  code. When you use it make sure you have a big enough
> >  	  IOMMU/AGP aperture.  Most of the options enabled by this can
> >  	  be set more finegrained using the iommu= command line
> > -	  options. See Documentation/x86/x86_64/boot-options.txt for more
> > +	  options. See Documentation/x86/x86_64/boot-options.rst for more
> >  	  details.
> > 
> >  config IOMMU_LEAK
> > diff --git a/arch/x86/boot/header.S b/arch/x86/boot/header.S
> > index 850b8762e889..90d791ca1a95 100644
> > --- a/arch/x86/boot/header.S
> > +++ b/arch/x86/boot/header.S
> > @@ -313,7 +313,7 @@ start_sys_seg:	.word	SYSSEG		
> # obsolete and meaningless,
> > but just
> > 
> >  type_of_loader:	.byte	0		# 0 means ancient 
> bootloader, newer
> >  					# bootloaders know 
> to change this.
> > -					# See 
> Documentation/x86/boot.txt for
> > +					# See 
> Documentation/x86/boot.rst for
> >  					# assigned ids
> > 
> >  # flags, unused bits must be zero (RFU) bit within loadflags
> > diff --git a/arch/x86/entry/entry_64.S b/arch/x86/entry/entry_64.S
> > index 11aa3b2afa4d..33f9fc38d014 100644
> > --- a/arch/x86/entry/entry_64.S
> > +++ b/arch/x86/entry/entry_64.S
> > @@ -8,7 +8,7 @@
> >   *
> >   * entry.S contains the system-call and fault low-level handling routines.
> >   *
> > - * Some of this is documented in Documentation/x86/entry_64.txt
> > + * Some of this is documented in Documentation/x86/entry_64.rst
> >   *
> >   * A note on terminology:
> >   * - iret frame:	Architecture defined interrupt frame from SS to RIP
> > diff --git a/arch/x86/include/asm/bootparam_utils.h
> > b/arch/x86/include/asm/bootparam_utils.h index f6f6ef436599..101eb944f13c
> > 100644
> > --- a/arch/x86/include/asm/bootparam_utils.h
> > +++ b/arch/x86/include/asm/bootparam_utils.h
> > @@ -24,7 +24,7 @@ static void sanitize_boot_params(struct boot_params
> > *boot_params) * IMPORTANT NOTE TO BOOTLOADER AUTHORS: do not simply clear
> >  	 * this field.  The purpose of this field is to guarantee
> >  	 * compliance with the x86 boot spec located in
> > -	 * Documentation/x86/boot.txt .  That spec says that the
> > +	 * Documentation/x86/boot.rst .  That spec says that the
> >  	 * *whole* structure should be cleared, after which only the
> >  	 * portion defined by struct setup_header (boot_params->hdr)
> >  	 * should be copied in.
> > diff --git a/arch/x86/include/asm/page_64_types.h
> > b/arch/x86/include/asm/page_64_types.h index 793c14c372cb..288b065955b7
> > 100644
> > --- a/arch/x86/include/asm/page_64_types.h
> > +++ b/arch/x86/include/asm/page_64_types.h
> > @@ -48,7 +48,7 @@
> > 
> >  #define __START_KERNEL_map	_AC(0xffffffff80000000, UL)
> > 
> > -/* See Documentation/x86/x86_64/mm.txt for a description of the memory map.
> > */ +/* See Documentation/x86/x86_64/mm.rst for a description of the memory
> > map. */
> > 
> >  #define __PHYSICAL_MASK_SHIFT	52
> > 
> > diff --git a/arch/x86/include/asm/pgtable_64_types.h
> > b/arch/x86/include/asm/pgtable_64_types.h index 88bca456da99..52e5f5f2240d
> > 100644
> > --- a/arch/x86/include/asm/pgtable_64_types.h
> > +++ b/arch/x86/include/asm/pgtable_64_types.h
> > @@ -103,7 +103,7 @@ extern unsigned int ptrs_per_p4d;
> >  #define PGDIR_MASK	(~(PGDIR_SIZE - 1))
> > 
> >  /*
> > - * See Documentation/x86/x86_64/mm.txt for a description of the memory map.
> > + * See Documentation/x86/x86_64/mm.rst for a description of the memory
> > map. *
> >   * Be very careful vs. KASLR when changing anything here. The KASLR address
> > * range must not overlap with anything except the KASAN shadow area, which
> > diff --git a/arch/x86/kernel/cpu/microcode/amd.c
> > b/arch/x86/kernel/cpu/microcode/amd.c index e1f3ba19ba54..06d4e67f31ab
> > 100644
> > --- a/arch/x86/kernel/cpu/microcode/amd.c
> > +++ b/arch/x86/kernel/cpu/microcode/amd.c
> > @@ -61,7 +61,7 @@ static u8 amd_ucode_patch[PATCH_MAX_SIZE];
> > 
> >  /*
> >   * Microcode patch container file is prepended to the initrd in cpio
> > - * format. See Documentation/x86/microcode.txt
> > + * format. See Documentation/x86/microcode.rst
> >   */
> >  static const char
> >  ucode_path[] __maybe_unused = "kernel/x86/microcode/AuthenticAMD.bin";
> > diff --git a/arch/x86/kernel/kexec-bzimage64.c
> > b/arch/x86/kernel/kexec-bzimage64.c index 22f60dd26460..b07e7069b09e 100644
> > --- a/arch/x86/kernel/kexec-bzimage64.c
> > +++ b/arch/x86/kernel/kexec-bzimage64.c
> > @@ -416,7 +416,7 @@ static void *bzImage64_load(struct kimage *image, char
> > *kernel, efi_map_offset = params_cmdline_sz;
> >  	efi_setup_data_offset = efi_map_offset + ALIGN(efi_map_sz, 16);
> > 
> > -	/* Copy setup header onto bootparams. Documentation/x86/boot.txt 
> */
> > +	/* Copy setup header onto bootparams. Documentation/x86/boot.rst */
> >  	setup_header_size = 0x0202 + kernel[0x0201] - setup_hdr_offset;
> > 
> >  	/* Is there a limit on setup header size? */
> > diff --git a/arch/x86/kernel/pci-dma.c b/arch/x86/kernel/pci-dma.c
> > index dcd272dbd0a9..f62b498b18fb 100644
> > --- a/arch/x86/kernel/pci-dma.c
> > +++ b/arch/x86/kernel/pci-dma.c
> > @@ -70,7 +70,7 @@ void __init pci_iommu_alloc(void)
> >  }
> > 
> >  /*
> > - * See <Documentation/x86/x86_64/boot-options.txt> for the iommu kernel
> > + * See <Documentation/x86/x86_64/boot-options.rst> for the iommu kernel
> >   * parameter documentation.
> >   */
> >  static __init int iommu_setup(char *p)
> > diff --git a/arch/x86/mm/tlb.c b/arch/x86/mm/tlb.c
> > index 7f61431c75fb..400c1ba033aa 100644
> > --- a/arch/x86/mm/tlb.c
> > +++ b/arch/x86/mm/tlb.c
> > @@ -711,7 +711,7 @@ void native_flush_tlb_others(const struct cpumask
> > *cpumask, }
> > 
> >  /*
> > - * See Documentation/x86/tlb.txt for details.  We choose 33
> > + * See Documentation/x86/tlb.rst for details.  We choose 33
> >   * because it is large enough to cover the vast majority (at
> >   * least 95%) of allocations, and is small enough that we are
> >   * confident it will not cause too much overhead.  Each single
> > diff --git a/arch/x86/platform/pvh/enlighten.c
> > b/arch/x86/platform/pvh/enlighten.c index 1861a2ba0f2b..c0a502f7e3a7 100644
> > --- a/arch/x86/platform/pvh/enlighten.c
> > +++ b/arch/x86/platform/pvh/enlighten.c
> > @@ -86,7 +86,7 @@ static void __init init_pvh_bootparams(bool xen_guest)
> >  	}
> > 
> >  	/*
> > -	 * See Documentation/x86/boot.txt.
> > +	 * See Documentation/x86/boot.rst.
> >  	 *
> >  	 * Version 2.12 supports Xen entry point but we will use default 
> x86/PC
> >  	 * environment (i.e. hardware_subarch 0).
> > diff --git a/drivers/acpi/Kconfig b/drivers/acpi/Kconfig
> > index 283ee94224c6..2438f37f2ca1 100644
> > --- a/drivers/acpi/Kconfig
> > +++ b/drivers/acpi/Kconfig
> > @@ -333,7 +333,7 @@ config ACPI_CUSTOM_DSDT_FILE
> >  	depends on !STANDALONE
> >  	help
> >  	  This option supports a custom DSDT by linking it into the 
> kernel.
> > -	  See Documentation/acpi/dsdt-override.txt
> > +	  See Documentation/admin-guide/acpi/dsdt-override.rst
> > 
> >  	  Enter the full path name to the file which includes the AmlCode
> >  	  or dsdt_aml_code declaration.
> > @@ -355,7 +355,7 @@ config ACPI_TABLE_UPGRADE
> >  	  This option provides functionality to upgrade arbitrary ACPI 
> tables
> >  	  via initrd. No functional change if no ACPI tables are passed 
> via
> >  	  initrd, therefore it's safe to say Y.
> > -	  See Documentation/acpi/initrd_table_override.txt for details
> > +	  See Documentation/admin-guide/acpi/initrd_table_override.rst for 
> details
> > 
> >  config ACPI_TABLE_OVERRIDE_VIA_BUILTIN_INITRD
> >  	bool "Override ACPI tables from built-in initrd"
> > @@ -365,7 +365,7 @@ config ACPI_TABLE_OVERRIDE_VIA_BUILTIN_INITRD
> >  	  This option provides functionality to override arbitrary ACPI 
> tables
> >  	  from built-in uncompressed initrd.
> > 
> > -	  See Documentation/acpi/initrd_table_override.txt for details
> > +	  See Documentation/admin-guide/acpi/initrd_table_override.rst for 
> details
> > 
> >  config ACPI_DEBUG
> >  	bool "Debug Statements"
> > @@ -374,7 +374,7 @@ config ACPI_DEBUG
> >  	  output and increases the kernel size by around 50K.
> > 
> >  	  Use the acpi.debug_layer and acpi.debug_level kernel command-
> line
> > -	  parameters documented in Documentation/acpi/debug.txt and
> > +	  parameters documented in Documentation/firmware-guide/acpi/
> debug.rst and
> > Documentation/admin-guide/kernel-parameters.rst to control the type and
> > amount of debug output.
> > 
> > @@ -445,7 +445,7 @@ config ACPI_CUSTOM_METHOD
> >  	help
> >  	  This debug facility allows ACPI AML methods to be inserted and/
> or
> >  	  replaced without rebooting the system. For details refer to:
> > -	  Documentation/acpi/method-customizing.txt.
> > +	  Documentation/firmware-guide/acpi/method-customizing.rst.
> > 
> >  	  NOTE: This option is security sensitive, because it allows 
> arbitrary
> >  	  kernel memory to be written to by root (uid=0) users, allowing 
> them
> > diff --git a/drivers/net/ethernet/faraday/ftgmac100.c
> > b/drivers/net/ethernet/faraday/ftgmac100.c index b17b79e612a3..ac6280ad43a1
> > 100644
> > --- a/drivers/net/ethernet/faraday/ftgmac100.c
> > +++ b/drivers/net/ethernet/faraday/ftgmac100.c
> > @@ -1075,7 +1075,7 @@ static int ftgmac100_mii_probe(struct ftgmac100 *priv,
> > phy_interface_t intf) }
> > 
> >  	/* Indicate that we support PAUSE frames (see comment in
> > -	 * Documentation/networking/phy.txt)
> > +	 * Documentation/networking/phy.rst)
> >  	 */
> >  	phy_support_asym_pause(phydev);
> > 
> > diff --git a/drivers/staging/fieldbus/Documentation/fieldbus_dev.txt
> > b/drivers/staging/fieldbus/Documentation/fieldbus_dev.txt index
> > 56af3f650fa3..89fb8e14676f 100644
> > --- a/drivers/staging/fieldbus/Documentation/fieldbus_dev.txt
> > +++ b/drivers/staging/fieldbus/Documentation/fieldbus_dev.txt
> > @@ -54,8 +54,8 @@ a limited few common behaviours and properties. This
> > allows us to define a simple interface consisting of a character device and
> > a set of sysfs files:
> > 
> >  See:
> > -Documentation/ABI/testing/sysfs-class-fieldbus-dev
> > -Documentation/ABI/testing/fieldbus-dev-cdev
> > +drivers/staging/fieldbus/Documentation/ABI/sysfs-class-fieldbus-dev
> > +drivers/staging/fieldbus/Documentation/ABI/fieldbus-dev-cdev
> > 
> >  Note that this simple interface does not provide a way to modify adapter
> >  configuration settings. It is therefore useful only for adapters that get
> > their diff --git a/drivers/vhost/vhost.c b/drivers/vhost/vhost.c
> > index 1e3ed41ae1f3..69938dbae2d0 100644
> > --- a/drivers/vhost/vhost.c
> > +++ b/drivers/vhost/vhost.c
> > @@ -1694,7 +1694,7 @@ EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
> > 
> >  /* TODO: This is really inefficient.  We need something like get_user()
> >   * (instruction directly accesses the data, with an exception table entry
> > - * returning -EFAULT). See Documentation/x86/exception-tables.txt.
> > + * returning -EFAULT). See Documentation/x86/exception-tables.rst.
> >   */
> >  static int set_bit_to_user(int nr, void __user *addr)
> >  {
> > diff --git a/include/acpi/acpi_drivers.h b/include/acpi/acpi_drivers.h
> > index de1804aeaf69..98e3db7a89cd 100644
> > --- a/include/acpi/acpi_drivers.h
> > +++ b/include/acpi/acpi_drivers.h
> > @@ -25,7 +25,7 @@
> >  #define ACPI_MAX_STRING			80
> > 
> >  /*
> > - * Please update drivers/acpi/debug.c and Documentation/acpi/debug.txt
> > + * Please update drivers/acpi/debug.c and
> > Documentation/firmware-guide/acpi/debug.rst * if you add to this list.
> >   */
> >  #define ACPI_BUS_COMPONENT		0x00010000
> > diff --git a/include/linux/fs_context.h b/include/linux/fs_context.h
> > index 1f966670c8dc..623eb58560b9 100644
> > --- a/include/linux/fs_context.h
> > +++ b/include/linux/fs_context.h
> > @@ -85,7 +85,7 @@ struct fs_parameter {
> >   * Superblock creation fills in ->root whereas reconfiguration begins with
> > this * already set.
> >   *
> > - * See Documentation/filesystems/mounting.txt
> > + * See Documentation/filesystems/mount_api.txt
> >   */
> >  struct fs_context {
> >  	const struct fs_context_operations *ops;
> > diff --git a/include/linux/lsm_hooks.h b/include/linux/lsm_hooks.h
> > index 47f58cfb6a19..df1318d85f7d 100644
> > --- a/include/linux/lsm_hooks.h
> > +++ b/include/linux/lsm_hooks.h
> > @@ -77,7 +77,7 @@
> >   *	state.  This is called immediately after commit_creds().
> >   *
> >   * Security hooks for mount using fs_context.
> > - *	[See also Documentation/filesystems/mounting.txt]
> > + *	[See also Documentation/filesystems/mount_api.txt]
> >   *
> >   * @fs_context_dup:
> >   *	Allocate and attach a security structure to sc->security.  This 
> pointer
> > diff --git a/mm/Kconfig b/mm/Kconfig
> > index ee8d1f311858..6e5fb81bde4b 100644
> > --- a/mm/Kconfig
> > +++ b/mm/Kconfig
> > @@ -165,7 +165,7 @@ config MEMORY_HOTPLUG_DEFAULT_ONLINE
> >  	  onlining policy (/sys/devices/system/memory/auto_online_blocks) 
> which
> >  	  determines what happens to newly added memory regions. Policy 
> setting
> >  	  can always be changed at runtime.
> > -	  See Documentation/memory-hotplug.txt for more information.
> > +	  See Documentation/admin-guide/mm/memory-hotplug.rst for more
> > information.
> > 
> >  	  Say Y here if you want all hot-plugged memory blocks to appear 
> in
> >  	  'online' state by default.
> > diff --git a/security/Kconfig b/security/Kconfig
> > index aeac3676dd4d..6d75ed71970c 100644
> > --- a/security/Kconfig
> > +++ b/security/Kconfig
> > @@ -62,7 +62,7 @@ config PAGE_TABLE_ISOLATION
> >  	  ensuring that the majority of kernel addresses are not mapped
> >  	  into userspace.
> > 
> > -	  See Documentation/x86/pti.txt for more details.
> > +	  See Documentation/x86/pti.rst for more details.
> > 
> >  config SECURITY_INFINIBAND
> >  	bool "Infiniband Security Hooks"
> > diff --git a/tools/include/linux/err.h b/tools/include/linux/err.h
> > index 2f5a12b88a86..25f2bb3a991d 100644
> > --- a/tools/include/linux/err.h
> > +++ b/tools/include/linux/err.h
> > @@ -20,7 +20,7 @@
> >   * Userspace note:
> >   * The same principle works for userspace, because 'error' pointers
> >   * fall down to the unused hole far from user space, as described
> > - * in Documentation/x86/x86_64/mm.txt for x86_64 arch:
> > + * in Documentation/x86/x86_64/mm.rst for x86_64 arch:
> >   *
> >   * 0000000000000000 - 00007fffffffffff (=47 bits) user space, different per
> > mm hole caused by [48:63] sign extension * ffffffffffe00000 -
> > ffffffffffffffff (=2 MB) unused hole
> > diff --git a/tools/objtool/Documentation/stack-validation.txt
> > b/tools/objtool/Documentation/stack-validation.txt index
> > 4dd11a554b9b..de094670050b 100644
> > --- a/tools/objtool/Documentation/stack-validation.txt
> > +++ b/tools/objtool/Documentation/stack-validation.txt
> > @@ -21,7 +21,7 @@ instructions).  Similarly, it knows how to follow switch
> > statements, for which gcc sometimes uses jump tables.
> > 
> >  (Objtool also has an 'orc generate' subcommand which generates debuginfo
> > -for the ORC unwinder.  See Documentation/x86/orc-unwinder.txt in the
> > +for the ORC unwinder.  See Documentation/x86/orc-unwinder.rst in the
> >  kernel tree for more details.)
> > 
> > 
> > @@ -101,7 +101,7 @@ b) ORC (Oops Rewind Capability) unwind table generation
> >     band.  So it doesn't affect runtime performance and it can be
> >     reliable even when interrupts or exceptions are involved.
> > 
> > -   For more details, see Documentation/x86/orc-unwinder.txt.
> > +   For more details, see Documentation/x86/orc-unwinder.rst.
> > 
> >  c) Higher live patching compatibility rate
> > 
> > diff --git a/tools/testing/selftests/x86/protection_keys.c
> > b/tools/testing/selftests/x86/protection_keys.c index
> > 5d546dcdbc80..798a5ddeee55 100644
> > --- a/tools/testing/selftests/x86/protection_keys.c
> > +++ b/tools/testing/selftests/x86/protection_keys.c
> > @@ -1,6 +1,6 @@
> >  // SPDX-License-Identifier: GPL-2.0
> >  /*
> > - * Tests x86 Memory Protection Keys (see
> > Documentation/x86/protection-keys.txt) + * Tests x86 Memory Protection Keys
> > (see Documentation/x86/protection-keys.rst) *
> >   * There are examples in here of:
> >   *  * how to set protection keys on memory
> 
> 
> 

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 12/22] gpu: i915.rst: Fix references to renamed files
  2019-05-29 23:23 ` [PATCH 12/22] gpu: i915.rst: Fix references to renamed files Mauro Carvalho Chehab
@ 2019-05-31  7:40   ` Jani Nikula
  2019-05-31  9:02   ` Joonas Lahtinen
  1 sibling, 0 replies; 44+ messages in thread
From: Jani Nikula @ 2019-05-31  7:40 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Joonas Lahtinen, Rodrigo Vivi, David Airlie,
	Daniel Vetter, Maarten Lankhorst, Maxime Ripard, Sean Paul,
	intel-gfx, dri-devel

On Wed, 29 May 2019, Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function Hardware workarounds ./drivers/gpu/drm/i915/intel_workarounds.c' failed with return code 1
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function Logical Rings, Logical Ring Contexts and Execlists ./drivers/gpu/drm/i915/intel_lrc.c' failed with return code 1
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -internal ./drivers/gpu/drm/i915/intel_lrc.c' failed with return code 2
>
> Fixes: 112ed2d31a46 ("drm/i915: Move GraphicsTechnology files under gt/")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  Documentation/gpu/i915.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index 055df45596c1..38fefeb99bba 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst
> @@ -61,7 +61,7 @@ Intel GVT-g Host Support(vGPU device model)
>  Workarounds
>  -----------
>  
> -.. kernel-doc:: drivers/gpu/drm/i915/intel_workarounds.c
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/selftest_workarounds.c
>     :doc: Hardware workarounds

Thanks for the patch. The basename should remain the same here.

I can pick up the updated version via drm-intel.

BR,
Jani.


>  
>  Display Hardware Handling
> @@ -379,10 +379,10 @@ User Batchbuffer Execution
>  Logical Rings, Logical Ring Contexts and Execlists
>  --------------------------------------------------
>  
> -.. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_lrc.c
>     :doc: Logical Rings, Logical Ring Contexts and Execlists
>  
> -.. kernel-doc:: drivers/gpu/drm/i915/intel_lrc.c
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_lrc.c
>     :internal:
>  
>  Global GTT views

-- 
Jani Nikula, Intel Open Source Graphics Center

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 12/22] gpu: i915.rst: Fix references to renamed files
  2019-05-29 23:23 ` [PATCH 12/22] gpu: i915.rst: Fix references to renamed files Mauro Carvalho Chehab
  2019-05-31  7:40   ` Jani Nikula
@ 2019-05-31  9:02   ` Joonas Lahtinen
  1 sibling, 0 replies; 44+ messages in thread
From: Joonas Lahtinen @ 2019-05-31  9:02 UTC (permalink / raw)
  To: Linux Doc Mailing List, Mauro Carvalho Chehab
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Jani Nikula, Rodrigo Vivi, David Airlie,
	Daniel Vetter, Maarten Lankhorst, Maxime Ripard, Sean Paul,
	intel-gfx, dri-devel

Quoting Mauro Carvalho Chehab (2019-05-30 02:23:43)
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function Hardware workarounds ./drivers/gpu/drm/i915/intel_workarounds.c' failed with return code 1
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function Logical Rings, Logical Ring Contexts and Execlists ./drivers/gpu/drm/i915/intel_lrc.c' failed with return code 1
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -internal ./drivers/gpu/drm/i915/intel_lrc.c' failed with return code 2
> 
> Fixes: 112ed2d31a46 ("drm/i915: Move GraphicsTechnology files under gt/")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  Documentation/gpu/i915.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index 055df45596c1..38fefeb99bba 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst
> @@ -61,7 +61,7 @@ Intel GVT-g Host Support(vGPU device model)
>  Workarounds
>  -----------
>  
> -.. kernel-doc:: drivers/gpu/drm/i915/intel_workarounds.c
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/selftest_workarounds.c

This should be gt/intel_workarounds.c

Do you want me to merge this, or do you plan on merging through
documentation tree?

Regards, Joonas

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references
  2019-05-29 23:23 ` [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references Mauro Carvalho Chehab
@ 2019-05-31 14:00   ` Christian König
  2019-05-31 15:03     ` Alex Deucher
  0 siblings, 1 reply; 44+ messages in thread
From: Christian König @ 2019-05-31 14:00 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Jonathan Corbet, David Airlie, linux-kernel, dri-devel,
	Mauro Carvalho Chehab, Maxime Ripard, Sean Paul

Am 30.05.19 um 01:23 schrieb Mauro Carvalho Chehab:
> This file was renamed, but docs weren't updated accordingly.
>
> 	WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function PRIME Buffer Sharing ./drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c' failed with return code 1
> 	WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -internal ./drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c' failed with return code 2
>
> Fixes: 988076cd8c5c ("drm/amdgpu: rename amdgpu_prime.[ch] into amdgpu_dma_buf.[ch]")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Reviewed-by: Christian König <christian.koenig@amd.com>

> ---
>   Documentation/gpu/amdgpu.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/gpu/amdgpu.rst b/Documentation/gpu/amdgpu.rst
> index a740e491dfcc..a15199b1b02e 100644
> --- a/Documentation/gpu/amdgpu.rst
> +++ b/Documentation/gpu/amdgpu.rst
> @@ -37,10 +37,10 @@ Buffer Objects
>   PRIME Buffer Sharing
>   --------------------
>   
> -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c
> +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
>      :doc: PRIME Buffer Sharing
>   
> -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c
> +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
>      :internal:
>   
>   MMU Notifier


^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references
  2019-05-31 14:00   ` Christian König
@ 2019-05-31 15:03     ` Alex Deucher
  0 siblings, 0 replies; 44+ messages in thread
From: Alex Deucher @ 2019-05-31 15:03 UTC (permalink / raw)
  To: Christian Koenig
  Cc: Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet,
	David Airlie, LKML, Maling list - DRI developers,
	Mauro Carvalho Chehab, Maxime Ripard, Sean Paul

On Fri, May 31, 2019 at 10:00 AM Christian König
<ckoenig.leichtzumerken@gmail.com> wrote:
>
> Am 30.05.19 um 01:23 schrieb Mauro Carvalho Chehab:
> > This file was renamed, but docs weren't updated accordingly.
> >
> >       WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -function PRIME Buffer Sharing ./drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c' failed with return code 1
> >       WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -internal ./drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c' failed with return code 2
> >
> > Fixes: 988076cd8c5c ("drm/amdgpu: rename amdgpu_prime.[ch] into amdgpu_dma_buf.[ch]")
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
>
> Reviewed-by: Christian König <christian.koenig@amd.com>
>

Applied.  thanks!

Alex

> > ---
> >   Documentation/gpu/amdgpu.rst | 4 ++--
> >   1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/Documentation/gpu/amdgpu.rst b/Documentation/gpu/amdgpu.rst
> > index a740e491dfcc..a15199b1b02e 100644
> > --- a/Documentation/gpu/amdgpu.rst
> > +++ b/Documentation/gpu/amdgpu.rst
> > @@ -37,10 +37,10 @@ Buffer Objects
> >   PRIME Buffer Sharing
> >   --------------------
> >
> > -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c
> > +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
> >      :doc: PRIME Buffer Sharing
> >
> > -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c
> > +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
> >      :internal:
> >
> >   MMU Notifier
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 04/22] docs: zh_CN: get rid of basic_profiling.txt
  2019-05-29 23:23 ` [PATCH 04/22] docs: zh_CN: get rid of basic_profiling.txt Mauro Carvalho Chehab
@ 2019-06-02 14:36   ` Alex Shi
  0 siblings, 0 replies; 44+ messages in thread
From: Alex Shi @ 2019-06-02 14:36 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Harry Wei



On 2019/5/30 7:23 上午, Mauro Carvalho Chehab wrote:
> Changeset 5700d1974818 ("docs: Get rid of the "basic profiling" guide")
> removed an old basic-profiling.txt file that was not updated over
> the last 11 years and won't reflect the post-perf era.
> 
> It makes no sense to keep its translation, so get rid of it too.
> 
> Fixes: 5700d1974818 ("docs: Get rid of the "basic profiling" guide")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---

Acked-by: Alex Shi <alex.shi@linux.alibaba.com>

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 13/22] docs: zh_CN: avoid duplicate citation references
  2019-05-29 23:23 ` [PATCH 13/22] docs: zh_CN: avoid duplicate citation references Mauro Carvalho Chehab
@ 2019-06-02 15:01   ` Alex Shi
  2019-06-04 10:20     ` Mauro Carvalho Chehab
  0 siblings, 1 reply; 44+ messages in thread
From: Alex Shi @ 2019-06-02 15:01 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Harry Wei



On 2019/5/30 7:23 上午, Mauro Carvalho Chehab wrote:
>     Documentation/process/management-style.rst:35: WARNING: duplicate label decisions, other instance in     Documentation/translations/zh_CN/process/management-style.rst
>     Documentation/process/programming-language.rst:37: WARNING: duplicate citation c-language, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
>     Documentation/process/programming-language.rst:38: WARNING: duplicate citation gcc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
>     Documentation/process/programming-language.rst:39: WARNING: duplicate citation clang, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
>     Documentation/process/programming-language.rst:40: WARNING: duplicate citation icc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
>     Documentation/process/programming-language.rst:41: WARNING: duplicate citation gcc-c-dialect-options, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
>     Documentation/process/programming-language.rst:42: WARNING: duplicate citation gnu-extensions, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
>     Documentation/process/programming-language.rst:43: WARNING: duplicate citation gcc-attribute-syntax, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
>     Documentation/process/programming-language.rst:44: WARNING: duplicate citation n2049, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>  .../zh_CN/process/management-style.rst        |  4 +--
>  .../zh_CN/process/programming-language.rst    | 28 +++++++++----------
>  2 files changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/Documentation/translations/zh_CN/process/management-style.rst b/Documentation/translations/zh_CN/process/management-style.rst
> index a181fa56d19e..c6a5bb285797 100644
> --- a/Documentation/translations/zh_CN/process/management-style.rst
> +++ b/Documentation/translations/zh_CN/process/management-style.rst
> @@ -28,7 +28,7 @@ Linux内核管理风格
>  
>  不管怎样,这里是:
>  
> -.. _decisions:
> +.. _cn_decisions:
>  
>  1)决策
>  -------
> @@ -108,7 +108,7 @@ Linux内核管理风格
>  但是,为了做好作为内核管理者的准备,最好记住不要烧掉任何桥梁,不要轰炸任何
>  无辜的村民,也不要疏远太多的内核开发人员。事实证明,疏远人是相当容易的,而
>  亲近一个疏远的人是很难的。因此,“疏远”立即属于“不可逆”的范畴,并根据
> -:ref:`decisions` 成为绝不可以做的事情。
> +:ref:`cn_decisions` 成为绝不可以做的事情。

It's good to have.

>  
>  这里只有几个简单的规则:
>  
> diff --git a/Documentation/translations/zh_CN/process/programming-language.rst b/Documentation/translations/zh_CN/process/programming-language.rst
> index 51fd4ef48ea1..9de9a3108c4d 100644
> --- a/Documentation/translations/zh_CN/process/programming-language.rst
> +++ b/Documentation/translations/zh_CN/process/programming-language.rst
> @@ -8,21 +8,21 @@
>  程序设计语言
>  ============
>  
> -内核是用C语言 [c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [gcc]_
> -在 ``-std=gnu89`` [gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
> +内核是用C语言 [cn_c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [cn_gcc]_

this change isn't good. cn_gcc will show in docs, it looks wired and confusing for peoples. other changes have the same issue. Could you find other way to fix the warning? or I'd rather tolerant it.

Thanks
Alex

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 09/22] docs: mark orphan documents as such
  2019-05-29 23:23 ` [PATCH 09/22] docs: mark orphan documents as such Mauro Carvalho Chehab
  2019-05-30  8:30   ` Paolo Bonzini
@ 2019-06-03  7:32   ` Christophe Leroy
  2019-06-04 10:10     ` Mauro Carvalho Chehab
  1 sibling, 1 reply; 44+ messages in thread
From: Christophe Leroy @ 2019-06-03  7:32 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: kvm, Radim Krčmář,
	Maxime Ripard, dri-devel, platform-driver-x86, Paul Mackerras,
	linux-stm32, Alexandre Torgue, Jonathan Corbet, David Airlie,
	Andrew Donnellan, linux-pm, Maarten Lankhorst, Matan Ziv-Av,
	Mauro Carvalho Chehab, Daniel Vetter, Sean Paul,
	linux-arm-kernel, linux-kernel, Maxime Coquelin, Frederic Barrat,
	Paolo Bonzini, linuxppc-dev, Georgi Djakov



Le 30/05/2019 à 01:23, Mauro Carvalho Chehab a écrit :
> Sphinx doesn't like orphan documents:
> 
>      Documentation/accelerators/ocxl.rst: WARNING: document isn't included in any toctree
>      Documentation/arm/stm32/overview.rst: WARNING: document isn't included in any toctree
>      Documentation/arm/stm32/stm32f429-overview.rst: WARNING: document isn't included in any toctree
>      Documentation/arm/stm32/stm32f746-overview.rst: WARNING: document isn't included in any toctree
>      Documentation/arm/stm32/stm32f769-overview.rst: WARNING: document isn't included in any toctree
>      Documentation/arm/stm32/stm32h743-overview.rst: WARNING: document isn't included in any toctree
>      Documentation/arm/stm32/stm32mp157-overview.rst: WARNING: document isn't included in any toctree
>      Documentation/gpu/msm-crash-dump.rst: WARNING: document isn't included in any toctree
>      Documentation/interconnect/interconnect.rst: WARNING: document isn't included in any toctree
>      Documentation/laptops/lg-laptop.rst: WARNING: document isn't included in any toctree
>      Documentation/powerpc/isa-versions.rst: WARNING: document isn't included in any toctree
>      Documentation/virtual/kvm/amd-memory-encryption.rst: WARNING: document isn't included in any toctree
>      Documentation/virtual/kvm/vcpu-requests.rst: WARNING: document isn't included in any toctree
> 
> So, while they aren't on any toctree, add :orphan: to them, in order
> to silent this warning.

Are those files really not meant to be included in a toctree ?

Shouldn't we include them in the relevant toctree instead of just 
shutting up Sphinx warnings ?

Christophe

> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>   Documentation/accelerators/ocxl.rst                 | 2 ++
>   Documentation/arm/stm32/overview.rst                | 2 ++
>   Documentation/arm/stm32/stm32f429-overview.rst      | 2 ++
>   Documentation/arm/stm32/stm32f746-overview.rst      | 2 ++
>   Documentation/arm/stm32/stm32f769-overview.rst      | 2 ++
>   Documentation/arm/stm32/stm32h743-overview.rst      | 2 ++
>   Documentation/arm/stm32/stm32mp157-overview.rst     | 2 ++
>   Documentation/gpu/msm-crash-dump.rst                | 2 ++
>   Documentation/interconnect/interconnect.rst         | 2 ++
>   Documentation/laptops/lg-laptop.rst                 | 2 ++
>   Documentation/powerpc/isa-versions.rst              | 2 ++
>   Documentation/virtual/kvm/amd-memory-encryption.rst | 2 ++
>   Documentation/virtual/kvm/vcpu-requests.rst         | 2 ++
>   13 files changed, 26 insertions(+)
> 
> diff --git a/Documentation/accelerators/ocxl.rst b/Documentation/accelerators/ocxl.rst
> index 14cefc020e2d..b1cea19a90f5 100644
> --- a/Documentation/accelerators/ocxl.rst
> +++ b/Documentation/accelerators/ocxl.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   ========================================================
>   OpenCAPI (Open Coherent Accelerator Processor Interface)
>   ========================================================
> diff --git a/Documentation/arm/stm32/overview.rst b/Documentation/arm/stm32/overview.rst
> index 85cfc8410798..f7e734153860 100644
> --- a/Documentation/arm/stm32/overview.rst
> +++ b/Documentation/arm/stm32/overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   ========================
>   STM32 ARM Linux Overview
>   ========================
> diff --git a/Documentation/arm/stm32/stm32f429-overview.rst b/Documentation/arm/stm32/stm32f429-overview.rst
> index 18feda97f483..65bbb1c3b423 100644
> --- a/Documentation/arm/stm32/stm32f429-overview.rst
> +++ b/Documentation/arm/stm32/stm32f429-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   STM32F429 Overview
>   ==================
>   
> diff --git a/Documentation/arm/stm32/stm32f746-overview.rst b/Documentation/arm/stm32/stm32f746-overview.rst
> index b5f4b6ce7656..42d593085015 100644
> --- a/Documentation/arm/stm32/stm32f746-overview.rst
> +++ b/Documentation/arm/stm32/stm32f746-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   STM32F746 Overview
>   ==================
>   
> diff --git a/Documentation/arm/stm32/stm32f769-overview.rst b/Documentation/arm/stm32/stm32f769-overview.rst
> index 228656ced2fe..f6adac862b17 100644
> --- a/Documentation/arm/stm32/stm32f769-overview.rst
> +++ b/Documentation/arm/stm32/stm32f769-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   STM32F769 Overview
>   ==================
>   
> diff --git a/Documentation/arm/stm32/stm32h743-overview.rst b/Documentation/arm/stm32/stm32h743-overview.rst
> index 3458dc00095d..c525835e7473 100644
> --- a/Documentation/arm/stm32/stm32h743-overview.rst
> +++ b/Documentation/arm/stm32/stm32h743-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   STM32H743 Overview
>   ==================
>   
> diff --git a/Documentation/arm/stm32/stm32mp157-overview.rst b/Documentation/arm/stm32/stm32mp157-overview.rst
> index 62e176d47ca7..2c52cd020601 100644
> --- a/Documentation/arm/stm32/stm32mp157-overview.rst
> +++ b/Documentation/arm/stm32/stm32mp157-overview.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   STM32MP157 Overview
>   ===================
>   
> diff --git a/Documentation/gpu/msm-crash-dump.rst b/Documentation/gpu/msm-crash-dump.rst
> index 757cd257e0d8..240ef200f76c 100644
> --- a/Documentation/gpu/msm-crash-dump.rst
> +++ b/Documentation/gpu/msm-crash-dump.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   =====================
>   MSM Crash Dump Format
>   =====================
> diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/interconnect/interconnect.rst
> index c3e004893796..56e331dab70e 100644
> --- a/Documentation/interconnect/interconnect.rst
> +++ b/Documentation/interconnect/interconnect.rst
> @@ -1,5 +1,7 @@
>   .. SPDX-License-Identifier: GPL-2.0
>   
> +:orphan:
> +
>   =====================================
>   GENERIC SYSTEM INTERCONNECT SUBSYSTEM
>   =====================================
> diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst
> index aa503ee9b3bc..f2c2ffe31101 100644
> --- a/Documentation/laptops/lg-laptop.rst
> +++ b/Documentation/laptops/lg-laptop.rst
> @@ -1,5 +1,7 @@
>   .. SPDX-License-Identifier: GPL-2.0+
>   
> +:orphan:
> +
>   LG Gram laptop extra features
>   =============================
>   
> diff --git a/Documentation/powerpc/isa-versions.rst b/Documentation/powerpc/isa-versions.rst
> index 812e20cc898c..66c24140ebf1 100644
> --- a/Documentation/powerpc/isa-versions.rst
> +++ b/Documentation/powerpc/isa-versions.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   CPU to ISA Version Mapping
>   ==========================
>   
> diff --git a/Documentation/virtual/kvm/amd-memory-encryption.rst b/Documentation/virtual/kvm/amd-memory-encryption.rst
> index 659bbc093b52..33d697ab8a58 100644
> --- a/Documentation/virtual/kvm/amd-memory-encryption.rst
> +++ b/Documentation/virtual/kvm/amd-memory-encryption.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   ======================================
>   Secure Encrypted Virtualization (SEV)
>   ======================================
> diff --git a/Documentation/virtual/kvm/vcpu-requests.rst b/Documentation/virtual/kvm/vcpu-requests.rst
> index 5feb3706a7ae..c1807a1b92e6 100644
> --- a/Documentation/virtual/kvm/vcpu-requests.rst
> +++ b/Documentation/virtual/kvm/vcpu-requests.rst
> @@ -1,3 +1,5 @@
> +:orphan:
> +
>   =================
>   KVM VCPU Requests
>   =================
> 

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag
  2019-05-29 23:23 ` [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag Mauro Carvalho Chehab
  2019-05-30 19:43   ` James Morris
@ 2019-06-03 20:29   ` Jarkko Sakkinen
  1 sibling, 0 replies; 44+ messages in thread
From: Jarkko Sakkinen @ 2019-06-03 20:29 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Mimi Zohar, James Bottomley, linux-integrity,
	keyrings

On Wed, May 29, 2019 at 08:23:49PM -0300, Mauro Carvalho Chehab wrote:
> The code-block tag is at the wrong place, causing those
> warnings:
> 
>     Documentation/security/keys/trusted-encrypted.rst:112: WARNING: Literal block expected; none found.
>     Documentation/security/keys/trusted-encrypted.rst:121: WARNING: Unexpected indentation.
>     Documentation/security/keys/trusted-encrypted.rst:122: WARNING: Block quote ends without a blank line; unexpected unindent.
>     Documentation/security/keys/trusted-encrypted.rst:123: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Acked-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>

/Jarkko

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 09/22] docs: mark orphan documents as such
  2019-06-03  7:32   ` Christophe Leroy
@ 2019-06-04 10:10     ` Mauro Carvalho Chehab
  0 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-06-04 10:10 UTC (permalink / raw)
  To: Christophe Leroy
  Cc: Linux Doc Mailing List, kvm, Radim Krčmář,
	Maxime Ripard, dri-devel, platform-driver-x86, Paul Mackerras,
	linux-stm32, Alexandre Torgue, Jonathan Corbet, David Airlie,
	Andrew Donnellan, linux-pm, Maarten Lankhorst, Matan Ziv-Av,
	Mauro Carvalho Chehab, Daniel Vetter, Sean Paul,
	linux-arm-kernel, linux-kernel, Maxime Coquelin, Frederic Barrat,
	Paolo Bonzini, linuxppc-dev, Georgi Djakov

Em Mon, 3 Jun 2019 09:32:54 +0200
Christophe Leroy <christophe.leroy@c-s.fr> escreveu:

> Le 30/05/2019 à 01:23, Mauro Carvalho Chehab a écrit :
> > Sphinx doesn't like orphan documents:
> > 
> >      Documentation/accelerators/ocxl.rst: WARNING: document isn't included in any toctree
> >      Documentation/arm/stm32/overview.rst: WARNING: document isn't included in any toctree
> >      Documentation/arm/stm32/stm32f429-overview.rst: WARNING: document isn't included in any toctree
> >      Documentation/arm/stm32/stm32f746-overview.rst: WARNING: document isn't included in any toctree
> >      Documentation/arm/stm32/stm32f769-overview.rst: WARNING: document isn't included in any toctree
> >      Documentation/arm/stm32/stm32h743-overview.rst: WARNING: document isn't included in any toctree
> >      Documentation/arm/stm32/stm32mp157-overview.rst: WARNING: document isn't included in any toctree
> >      Documentation/gpu/msm-crash-dump.rst: WARNING: document isn't included in any toctree
> >      Documentation/interconnect/interconnect.rst: WARNING: document isn't included in any toctree
> >      Documentation/laptops/lg-laptop.rst: WARNING: document isn't included in any toctree
> >      Documentation/powerpc/isa-versions.rst: WARNING: document isn't included in any toctree
> >      Documentation/virtual/kvm/amd-memory-encryption.rst: WARNING: document isn't included in any toctree
> >      Documentation/virtual/kvm/vcpu-requests.rst: WARNING: document isn't included in any toctree
> > 
> > So, while they aren't on any toctree, add :orphan: to them, in order
> > to silent this warning.  
> 
> Are those files really not meant to be included in a toctree ?
> 
> Shouldn't we include them in the relevant toctree instead of just 
> shutting up Sphinx warnings ?

This is a good point. My understanding is that those orphaned docs
are there for two reasons:

1) someone created a new document as .rst but there's no index.rst file yet,
as there are lots of other documents already there not converted. That's
the case, for example, of the ones under Documentation/arm;

2) They're part of an undergoing effort of converting stuff to ReST.
One opted to keep it orphaned temporarily in order to avoid merge
conflicts.

That's said, I have myself a big (/86 patches and growing) series
with do a huge step on txt->rst conversion (it covers a significant
amount of documentation). On this series, I'm removing the orphaned
tags for several files (including, for example, those at Documentation/arm).

Yet, it is a lot easier to see if such series is not introducing
warnings regressions if we first address those.

It should be notice that discovering the orphaned files should be as
simple as:

	git grep -l ":orphan:" Documentation

> 
> Christophe
> 
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> >   Documentation/accelerators/ocxl.rst                 | 2 ++
> >   Documentation/arm/stm32/overview.rst                | 2 ++
> >   Documentation/arm/stm32/stm32f429-overview.rst      | 2 ++
> >   Documentation/arm/stm32/stm32f746-overview.rst      | 2 ++
> >   Documentation/arm/stm32/stm32f769-overview.rst      | 2 ++
> >   Documentation/arm/stm32/stm32h743-overview.rst      | 2 ++
> >   Documentation/arm/stm32/stm32mp157-overview.rst     | 2 ++
> >   Documentation/gpu/msm-crash-dump.rst                | 2 ++
> >   Documentation/interconnect/interconnect.rst         | 2 ++
> >   Documentation/laptops/lg-laptop.rst                 | 2 ++
> >   Documentation/powerpc/isa-versions.rst              | 2 ++
> >   Documentation/virtual/kvm/amd-memory-encryption.rst | 2 ++
> >   Documentation/virtual/kvm/vcpu-requests.rst         | 2 ++
> >   13 files changed, 26 insertions(+)
> > 
> > diff --git a/Documentation/accelerators/ocxl.rst b/Documentation/accelerators/ocxl.rst
> > index 14cefc020e2d..b1cea19a90f5 100644
> > --- a/Documentation/accelerators/ocxl.rst
> > +++ b/Documentation/accelerators/ocxl.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   ========================================================
> >   OpenCAPI (Open Coherent Accelerator Processor Interface)
> >   ========================================================
> > diff --git a/Documentation/arm/stm32/overview.rst b/Documentation/arm/stm32/overview.rst
> > index 85cfc8410798..f7e734153860 100644
> > --- a/Documentation/arm/stm32/overview.rst
> > +++ b/Documentation/arm/stm32/overview.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   ========================
> >   STM32 ARM Linux Overview
> >   ========================
> > diff --git a/Documentation/arm/stm32/stm32f429-overview.rst b/Documentation/arm/stm32/stm32f429-overview.rst
> > index 18feda97f483..65bbb1c3b423 100644
> > --- a/Documentation/arm/stm32/stm32f429-overview.rst
> > +++ b/Documentation/arm/stm32/stm32f429-overview.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   STM32F429 Overview
> >   ==================
> >   
> > diff --git a/Documentation/arm/stm32/stm32f746-overview.rst b/Documentation/arm/stm32/stm32f746-overview.rst
> > index b5f4b6ce7656..42d593085015 100644
> > --- a/Documentation/arm/stm32/stm32f746-overview.rst
> > +++ b/Documentation/arm/stm32/stm32f746-overview.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   STM32F746 Overview
> >   ==================
> >   
> > diff --git a/Documentation/arm/stm32/stm32f769-overview.rst b/Documentation/arm/stm32/stm32f769-overview.rst
> > index 228656ced2fe..f6adac862b17 100644
> > --- a/Documentation/arm/stm32/stm32f769-overview.rst
> > +++ b/Documentation/arm/stm32/stm32f769-overview.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   STM32F769 Overview
> >   ==================
> >   
> > diff --git a/Documentation/arm/stm32/stm32h743-overview.rst b/Documentation/arm/stm32/stm32h743-overview.rst
> > index 3458dc00095d..c525835e7473 100644
> > --- a/Documentation/arm/stm32/stm32h743-overview.rst
> > +++ b/Documentation/arm/stm32/stm32h743-overview.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   STM32H743 Overview
> >   ==================
> >   
> > diff --git a/Documentation/arm/stm32/stm32mp157-overview.rst b/Documentation/arm/stm32/stm32mp157-overview.rst
> > index 62e176d47ca7..2c52cd020601 100644
> > --- a/Documentation/arm/stm32/stm32mp157-overview.rst
> > +++ b/Documentation/arm/stm32/stm32mp157-overview.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   STM32MP157 Overview
> >   ===================
> >   
> > diff --git a/Documentation/gpu/msm-crash-dump.rst b/Documentation/gpu/msm-crash-dump.rst
> > index 757cd257e0d8..240ef200f76c 100644
> > --- a/Documentation/gpu/msm-crash-dump.rst
> > +++ b/Documentation/gpu/msm-crash-dump.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   =====================
> >   MSM Crash Dump Format
> >   =====================
> > diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/interconnect/interconnect.rst
> > index c3e004893796..56e331dab70e 100644
> > --- a/Documentation/interconnect/interconnect.rst
> > +++ b/Documentation/interconnect/interconnect.rst
> > @@ -1,5 +1,7 @@
> >   .. SPDX-License-Identifier: GPL-2.0
> >   
> > +:orphan:
> > +
> >   =====================================
> >   GENERIC SYSTEM INTERCONNECT SUBSYSTEM
> >   =====================================
> > diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst
> > index aa503ee9b3bc..f2c2ffe31101 100644
> > --- a/Documentation/laptops/lg-laptop.rst
> > +++ b/Documentation/laptops/lg-laptop.rst
> > @@ -1,5 +1,7 @@
> >   .. SPDX-License-Identifier: GPL-2.0+
> >   
> > +:orphan:
> > +
> >   LG Gram laptop extra features
> >   =============================
> >   
> > diff --git a/Documentation/powerpc/isa-versions.rst b/Documentation/powerpc/isa-versions.rst
> > index 812e20cc898c..66c24140ebf1 100644
> > --- a/Documentation/powerpc/isa-versions.rst
> > +++ b/Documentation/powerpc/isa-versions.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   CPU to ISA Version Mapping
> >   ==========================
> >   
> > diff --git a/Documentation/virtual/kvm/amd-memory-encryption.rst b/Documentation/virtual/kvm/amd-memory-encryption.rst
> > index 659bbc093b52..33d697ab8a58 100644
> > --- a/Documentation/virtual/kvm/amd-memory-encryption.rst
> > +++ b/Documentation/virtual/kvm/amd-memory-encryption.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   ======================================
> >   Secure Encrypted Virtualization (SEV)
> >   ======================================
> > diff --git a/Documentation/virtual/kvm/vcpu-requests.rst b/Documentation/virtual/kvm/vcpu-requests.rst
> > index 5feb3706a7ae..c1807a1b92e6 100644
> > --- a/Documentation/virtual/kvm/vcpu-requests.rst
> > +++ b/Documentation/virtual/kvm/vcpu-requests.rst
> > @@ -1,3 +1,5 @@
> > +:orphan:
> > +
> >   =================
> >   KVM VCPU Requests
> >   =================
> >   



Thanks,
Mauro

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 13/22] docs: zh_CN: avoid duplicate citation references
  2019-06-02 15:01   ` Alex Shi
@ 2019-06-04 10:20     ` Mauro Carvalho Chehab
  2019-06-04 10:43       ` Mauro Carvalho Chehab
  0 siblings, 1 reply; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-06-04 10:20 UTC (permalink / raw)
  To: Alex Shi
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Harry Wei

Em Sun, 2 Jun 2019 23:01:21 +0800
Alex Shi <alex.shi@linux.alibaba.com> escreveu:

> On 2019/5/30 7:23 上午, Mauro Carvalho Chehab wrote:
> >     Documentation/process/management-style.rst:35: WARNING: duplicate label decisions, other instance in     Documentation/translations/zh_CN/process/management-style.rst
> >     Documentation/process/programming-language.rst:37: WARNING: duplicate citation c-language, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> >     Documentation/process/programming-language.rst:38: WARNING: duplicate citation gcc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> >     Documentation/process/programming-language.rst:39: WARNING: duplicate citation clang, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> >     Documentation/process/programming-language.rst:40: WARNING: duplicate citation icc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> >     Documentation/process/programming-language.rst:41: WARNING: duplicate citation gcc-c-dialect-options, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> >     Documentation/process/programming-language.rst:42: WARNING: duplicate citation gnu-extensions, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> >     Documentation/process/programming-language.rst:43: WARNING: duplicate citation gcc-attribute-syntax, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> >     Documentation/process/programming-language.rst:44: WARNING: duplicate citation n2049, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> >  .../zh_CN/process/management-style.rst        |  4 +--
> >  .../zh_CN/process/programming-language.rst    | 28 +++++++++----------
> >  2 files changed, 16 insertions(+), 16 deletions(-)
> > 
> > diff --git a/Documentation/translations/zh_CN/process/management-style.rst b/Documentation/translations/zh_CN/process/management-style.rst
> > index a181fa56d19e..c6a5bb285797 100644
> > --- a/Documentation/translations/zh_CN/process/management-style.rst
> > +++ b/Documentation/translations/zh_CN/process/management-style.rst
> > @@ -28,7 +28,7 @@ Linux内核管理风格
> >  
> >  不管怎样,这里是:
> >  
> > -.. _decisions:
> > +.. _cn_decisions:
> >  
> >  1)决策
> >  -------
> > @@ -108,7 +108,7 @@ Linux内核管理风格
> >  但是,为了做好作为内核管理者的准备,最好记住不要烧掉任何桥梁,不要轰炸任何
> >  无辜的村民,也不要疏远太多的内核开发人员。事实证明,疏远人是相当容易的,而
> >  亲近一个疏远的人是很难的。因此,“疏远”立即属于“不可逆”的范畴,并根据
> > -:ref:`decisions` 成为绝不可以做的事情。
> > +:ref:`cn_decisions` 成为绝不可以做的事情。  
> 
> It's good to have.
> 
> >  
> >  这里只有几个简单的规则:
> >  
> > diff --git a/Documentation/translations/zh_CN/process/programming-language.rst b/Documentation/translations/zh_CN/process/programming-language.rst
> > index 51fd4ef48ea1..9de9a3108c4d 100644
> > --- a/Documentation/translations/zh_CN/process/programming-language.rst
> > +++ b/Documentation/translations/zh_CN/process/programming-language.rst
> > @@ -8,21 +8,21 @@
> >  程序设计语言
> >  ============
> >  
> > -内核是用C语言 [c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [gcc]_
> > -在 ``-std=gnu89`` [gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
> > +内核是用C语言 [cn_c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [cn_gcc]_  
> 
> this change isn't good. cn_gcc will show in docs, it looks wired and confusing for peoples. other changes have the same issue. Could you find other way to fix the warning? or I'd rather tolerant it.

Well, Sphinx has a way to do that, like, for example:

diff --git a/Documentation/translations/zh_CN/process/programming-language.rst b/Documentation/translations/zh_CN/process/programming-language.rst
index 9de9a3108c4d..353fb8eaf4b5 100644
--- a/Documentation/translations/zh_CN/process/programming-language.rst
+++ b/Documentation/translations/zh_CN/process/programming-language.rst
@@ -9,7 +9,7 @@
 ============
 
 内核是用C语言 [cn_c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [cn_gcc]_
-在 ``-std=gnu89`` [cn_gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
+在 ``-std=gnu89`` :ref:`gcc C dialect options <cn_gcc-c-dialect-options>` 下编译的:ISO C90的 GNU 方言(
 包括一些C99特性)
 
 这种方言包含对语言 [cn_gnu-extensions]_ 的许多扩展,当然,它们许多都在内核中使用。

If we use that, at least for some of those references, it would probably
be better to translate "dialect-options" (and similar terms) to Chinese.

Thanks,
Mauro

^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 13/22] docs: zh_CN: avoid duplicate citation references
  2019-06-04 10:20     ` Mauro Carvalho Chehab
@ 2019-06-04 10:43       ` Mauro Carvalho Chehab
  0 siblings, 0 replies; 44+ messages in thread
From: Mauro Carvalho Chehab @ 2019-06-04 10:43 UTC (permalink / raw)
  To: Alex Shi; +Cc: Linux Doc Mailing List, linux-kernel, Jonathan Corbet, Harry Wei

Em Tue, 4 Jun 2019 07:20:57 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> escreveu:

> Em Sun, 2 Jun 2019 23:01:21 +0800
> Alex Shi <alex.shi@linux.alibaba.com> escreveu:
> 
> > On 2019/5/30 7:23 上午, Mauro Carvalho Chehab wrote:  
> > >     Documentation/process/management-style.rst:35: WARNING: duplicate label decisions, other instance in     Documentation/translations/zh_CN/process/management-style.rst
> > >     Documentation/process/programming-language.rst:37: WARNING: duplicate citation c-language, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > >     Documentation/process/programming-language.rst:38: WARNING: duplicate citation gcc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > >     Documentation/process/programming-language.rst:39: WARNING: duplicate citation clang, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > >     Documentation/process/programming-language.rst:40: WARNING: duplicate citation icc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > >     Documentation/process/programming-language.rst:41: WARNING: duplicate citation gcc-c-dialect-options, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > >     Documentation/process/programming-language.rst:42: WARNING: duplicate citation gnu-extensions, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > >     Documentation/process/programming-language.rst:43: WARNING: duplicate citation gcc-attribute-syntax, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > >     Documentation/process/programming-language.rst:44: WARNING: duplicate citation n2049, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
> > > 
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > > ---
> > >  .../zh_CN/process/management-style.rst        |  4 +--
> > >  .../zh_CN/process/programming-language.rst    | 28 +++++++++----------
> > >  2 files changed, 16 insertions(+), 16 deletions(-)
> > > 
> > > diff --git a/Documentation/translations/zh_CN/process/management-style.rst b/Documentation/translations/zh_CN/process/management-style.rst
> > > index a181fa56d19e..c6a5bb285797 100644
> > > --- a/Documentation/translations/zh_CN/process/management-style.rst
> > > +++ b/Documentation/translations/zh_CN/process/management-style.rst
> > > @@ -28,7 +28,7 @@ Linux内核管理风格
> > >  
> > >  不管怎样,这里是:
> > >  
> > > -.. _decisions:
> > > +.. _cn_decisions:
> > >  
> > >  1)决策
> > >  -------
> > > @@ -108,7 +108,7 @@ Linux内核管理风格
> > >  但是,为了做好作为内核管理者的准备,最好记住不要烧掉任何桥梁,不要轰炸任何
> > >  无辜的村民,也不要疏远太多的内核开发人员。事实证明,疏远人是相当容易的,而
> > >  亲近一个疏远的人是很难的。因此,“疏远”立即属于“不可逆”的范畴,并根据
> > > -:ref:`decisions` 成为绝不可以做的事情。
> > > +:ref:`cn_decisions` 成为绝不可以做的事情。    
> > 
> > It's good to have.
> >   
> > >  
> > >  这里只有几个简单的规则:
> > >  
> > > diff --git a/Documentation/translations/zh_CN/process/programming-language.rst b/Documentation/translations/zh_CN/process/programming-language.rst
> > > index 51fd4ef48ea1..9de9a3108c4d 100644
> > > --- a/Documentation/translations/zh_CN/process/programming-language.rst
> > > +++ b/Documentation/translations/zh_CN/process/programming-language.rst
> > > @@ -8,21 +8,21 @@
> > >  程序设计语言
> > >  ============
> > >  
> > > -内核是用C语言 [c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [gcc]_
> > > -在 ``-std=gnu89`` [gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
> > > +内核是用C语言 [cn_c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [cn_gcc]_    
> > 
> > this change isn't good. cn_gcc will show in docs, it looks wired and confusing for peoples. other changes have the same issue. Could you find other way to fix the warning? or I'd rather tolerant it.  
> 
> Well, Sphinx has a way to do that, like, for example:
> 
> diff --git a/Documentation/translations/zh_CN/process/programming-language.rst b/Documentation/translations/zh_CN/process/programming-language.rst
> index 9de9a3108c4d..353fb8eaf4b5 100644
> --- a/Documentation/translations/zh_CN/process/programming-language.rst
> +++ b/Documentation/translations/zh_CN/process/programming-language.rst
> @@ -9,7 +9,7 @@
>  ============
>  
>  内核是用C语言 [cn_c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [cn_gcc]_
> -在 ``-std=gnu89`` [cn_gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
> +在 ``-std=gnu89`` :ref:`gcc C dialect options <cn_gcc-c-dialect-options>` 下编译的:ISO C90的 GNU 方言(
>  包括一些C99特性)
>  
>  这种方言包含对语言 [cn_gnu-extensions]_ 的许多扩展,当然,它们许多都在内核中使用。
> 
> If we use that, at least for some of those references, it would probably
> be better to translate "dialect-options" (and similar terms) to Chinese.
> 
> Thanks,
> Mauro

Thanks,
Mauro

This should do the work:

[PATCH] docs: zh_CN: avoid duplicate citation references

    Documentation/process/management-style.rst:35: WARNING: duplicate label decisions, other instance in     Documentation/translations/zh_CN/process/management-style.rst
    Documentation/process/programming-language.rst:37: WARNING: duplicate citation c-language, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:38: WARNING: duplicate citation gcc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:39: WARNING: duplicate citation clang, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:40: WARNING: duplicate citation icc, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:41: WARNING: duplicate citation gcc-c-dialect-options, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:42: WARNING: duplicate citation gnu-extensions, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:43: WARNING: duplicate citation gcc-attribute-syntax, other instance in     Documentation/translations/zh_CN/process/programming-language.rst
    Documentation/process/programming-language.rst:44: WARNING: duplicate citation n2049, other instance in     Documentation/translations/zh_CN/process/programming-language.rst

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

diff --git a/Documentation/translations/zh_CN/process/management-style.rst b/Documentation/translations/zh_CN/process/management-style.rst
index a181fa56d19e..c6a5bb285797 100644
--- a/Documentation/translations/zh_CN/process/management-style.rst
+++ b/Documentation/translations/zh_CN/process/management-style.rst
@@ -28,7 +28,7 @@ Linux内核管理风格
 
 不管怎样,这里是:
 
-.. _decisions:
+.. _cn_decisions:
 
 1)决策
 -------
@@ -108,7 +108,7 @@ Linux内核管理风格
 但是,为了做好作为内核管理者的准备,最好记住不要烧掉任何桥梁,不要轰炸任何
 无辜的村民,也不要疏远太多的内核开发人员。事实证明,疏远人是相当容易的,而
 亲近一个疏远的人是很难的。因此,“疏远”立即属于“不可逆”的范畴,并根据
-:ref:`decisions` 成为绝不可以做的事情。
+:ref:`cn_decisions` 成为绝不可以做的事情。
 
 这里只有几个简单的规则:
 
diff --git a/Documentation/translations/zh_CN/process/programming-language.rst b/Documentation/translations/zh_CN/process/programming-language.rst
index 51fd4ef48ea1..22b0e68c8360 100644
--- a/Documentation/translations/zh_CN/process/programming-language.rst
+++ b/Documentation/translations/zh_CN/process/programming-language.rst
@@ -8,21 +8,21 @@
 程序设计语言
 ============
 
-内核是用C语言 [c-language]_ 编写的。更准确地说,内核通常是用 ``gcc`` [gcc]_
-在 ``-std=gnu89`` [gcc-c-dialect-options]_ 下编译的:ISO C90的 GNU 方言(
+内核是用C语言 :ref:`c-language <cn_c-language>` 编写的。更准确地说,内核通常是用 ``gcc`` :ref:`gcc <cn_gcc>`
+在 ``-std=gnu89`` :ref:`gcc-c-dialect-options <cn_gcc-c-dialect-options>` 下编译的:ISO C90的 GNU 方言(
 包括一些C99特性)
 
-这种方言包含对语言 [gnu-extensions]_ 的许多扩展,当然,它们许多都在内核中使用。
+这种方言包含对语言 :ref:`gnu-extensions <cn_gnu-extensions>` 的许多扩展,当然,它们许多都在内核中使用。
 
-对于一些体系结构,有一些使用 ``clang`` [clang]_ 和 ``icc`` [icc]_ 编译内核
+对于一些体系结构,有一些使用 ``clang`` :ref:`clang <cn_clang>` 和 ``icc`` :ref:`icc <cn_icc>` 编译内核
 的支持,尽管在编写此文档时还没有完成,仍需要第三方补丁。
 
 属性
 ----
 
-在整个内核中使用的一个常见扩展是属性(attributes) [gcc-attribute-syntax]_
+在整个内核中使用的一个常见扩展是属性(attributes) :ref:`gcc-attribute-syntax <cn_gcc-attribute-syntax>`
 属性允许将实现定义的语义引入语言实体(如变量、函数或类型),而无需对语言进行
-重大的语法更改(例如添加新关键字) [n2049]_
+重大的语法更改(例如添加新关键字) :ref:`n2049 <cn_n2049>`
 
 在某些情况下,属性是可选的(即不支持这些属性的编译器仍然应该生成正确的代码,
 即使其速度较慢或执行的编译时检查/诊断次数不够)
@@ -31,11 +31,42 @@
 ``__attribute__((__pure__))`` ),以检测可以使用哪些关键字和/或缩短代码, 具体
 请参阅 ``include/linux/compiler_attributes.h``
 
-.. [c-language] http://www.open-std.org/jtc1/sc22/wg14/www/standards
-.. [gcc] https://gcc.gnu.org
-.. [clang] https://clang.llvm.org
-.. [icc] https://software.intel.com/en-us/c-compilers
-.. [gcc-c-dialect-options] https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html
-.. [gnu-extensions] https://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html
-.. [gcc-attribute-syntax] https://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html
-.. [n2049] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2049.pdf
+.. _cn_c-language:
+
+c-language
+   http://www.open-std.org/jtc1/sc22/wg14/www/standards
+
+.. _cn_gcc:
+
+gcc
+   https://gcc.gnu.org
+
+.. _cn_clang:
+
+clang
+   https://clang.llvm.org
+
+.. _cn_icc:
+
+icc
+   https://software.intel.com/en-us/c-compilers
+
+.. _cn_gcc-c-dialect-options:
+
+c-dialect-options
+   https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html
+
+.. _cn_gnu-extensions:
+
+gnu-extensions
+   https://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html
+
+.. _cn_gcc-attribute-syntax:
+
+gcc-attribute-syntax
+   https://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html
+
+.. _cn_n2049:
+
+n2049
+   http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2049.pdf


^ permalink raw reply	[flat|nested] 44+ messages in thread

* Re: [PATCH 16/22] docs: gpio: driver.rst: fix a bad tag
  2019-05-29 23:23 ` [PATCH 16/22] docs: gpio: driver.rst: fix a bad tag Mauro Carvalho Chehab
@ 2019-06-07 20:57   ` Linus Walleij
  0 siblings, 0 replies; 44+ messages in thread
From: Linus Walleij @ 2019-06-07 20:57 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Bartosz Golaszewski, open list:GPIO SUBSYSTEM

On Thu, May 30, 2019 at 1:24 AM Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:

> With ReST, [foo]_ means a reference to foo, causing this warning:
>
>     Documentation/driver-api/gpio/driver.rst:419: WARNING: Unknown target name: "devm".
>
> Fix it by using a literal for the name.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Patch applied to the GPIO tree.

Yours,
Linus Walleij

^ permalink raw reply	[flat|nested] 44+ messages in thread

end of thread, other threads:[~2019-06-07 20:57 UTC | newest]

Thread overview: 44+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
2019-05-30 16:57   ` Rafael J. Wysocki
2019-05-29 23:23 ` [PATCH 02/22] isdn: mISDN: remove a bogus reference to a non-existing doc Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 03/22] dt: fix broken references to nand.txt Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 04/22] docs: zh_CN: get rid of basic_profiling.txt Mauro Carvalho Chehab
2019-06-02 14:36   ` Alex Shi
2019-05-29 23:23 ` [PATCH 05/22] mfd: madera: Fix bad reference to pinctrl.txt file Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 06/22] doc: it_IT: fix reference to magic-number.rst Mauro Carvalho Chehab
2019-05-30 20:15   ` Federico Vaga
2019-05-29 23:23 ` [PATCH 07/22] docs: mm: numaperf.rst: get rid of a build warning Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 08/22] docs: bpf: get rid of two warnings Mauro Carvalho Chehab
2019-05-30 18:08   ` Song Liu
2019-05-29 23:23 ` [PATCH 09/22] docs: mark orphan documents as such Mauro Carvalho Chehab
2019-05-30  8:30   ` Paolo Bonzini
2019-06-03  7:32   ` Christophe Leroy
2019-06-04 10:10     ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 10/22] docs: amd-memory-encryption.rst get rid of warnings Mauro Carvalho Chehab
2019-05-30  8:30   ` Paolo Bonzini
2019-05-29 23:23 ` [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references Mauro Carvalho Chehab
2019-05-31 14:00   ` Christian König
2019-05-31 15:03     ` Alex Deucher
2019-05-29 23:23 ` [PATCH 12/22] gpu: i915.rst: Fix references to renamed files Mauro Carvalho Chehab
2019-05-31  7:40   ` Jani Nikula
2019-05-31  9:02   ` Joonas Lahtinen
2019-05-29 23:23 ` [PATCH 13/22] docs: zh_CN: avoid duplicate citation references Mauro Carvalho Chehab
2019-06-02 15:01   ` Alex Shi
2019-06-04 10:20     ` Mauro Carvalho Chehab
2019-06-04 10:43       ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 14/22] docs: vm: hmm.rst: fix some warnings Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 15/22] docs: it: license-rules.rst: get rid of warnings Mauro Carvalho Chehab
2019-05-30 20:23   ` Federico Vaga
2019-05-29 23:23 ` [PATCH 16/22] docs: gpio: driver.rst: fix a bad tag Mauro Carvalho Chehab
2019-06-07 20:57   ` Linus Walleij
2019-05-29 23:23 ` [PATCH 17/22] docs: soundwire: locking: fix tags for a code-block Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag Mauro Carvalho Chehab
2019-05-30 19:43   ` James Morris
2019-06-03 20:29   ` Jarkko Sakkinen
2019-05-29 23:23 ` [PATCH 19/22] docs: security: core.rst: Fix several warnings Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 20/22] docs: net: dpio-driver.rst: fix two codeblock warnings Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 21/22] docs: net: sja1105.rst: fix table format Mauro Carvalho Chehab
2019-05-29 23:26   ` Vladimir Oltean
     [not found] ` <f9fecacbe4ce0b2b3aed38d71ae3753f2daf3ce3.1559171394.git.mchehab+samsung@kernel.org>
2019-05-30 13:12   ` [PATCH 22/22] docs: fix broken documentation links Sven Van Asbroeck
     [not found]   ` <1574052.9PXfBvmXpz@harkonnen>
2019-05-30 22:49     ` Michael S. Tsirkin

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).