* [PATCH 00/10] Fix documentation warnings at linux-next
@ 2021-01-14 7:53 Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 01/10] doc/zh_CN: fix Sphinx errors Mauro Carvalho Chehab
` (9 more replies)
0 siblings, 10 replies; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Chao Yu,
Daniel Vetter, David Airlie, Felipe Balbi, Harry Wei,
Ingo Molnar, Jaegeuk Kim, Mauro Carvalho Chehab, Moritz Fischer,
Peter Zijlstra, Tom Rix, Will Deacon, Wu Hao, amd-gfx, dri-devel,
kvm, linux-f2fs-devel, linux-fpga, linux-media, linux-usb
This series fixes the documentation warnings found at next-20210114.
Most of the changes here are trivial.
While those patches could be merged via the docs tree during
the next merge window, It sounds better to have those patches
merged directly via each maintainer's tree, where the new
warnings were introduced.
Regards,
Mauro
Mauro Carvalho Chehab (10):
doc/zh_CN: fix Sphinx errors
ABI: sysfs-fs-f2fs: fix a table identation
KVM: x86: hyper-v: add a blank line to remove building warnings
ABI: sysfs-firmware-sgi_uv
docs: fpga: dfl.rst: Fix a couple building issues
drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup
dwc3: document gadget_max_speed
doc: zh_CN/mips: fix doc cross-references
media: v4l2-subdev.rst: fix a missing whitespace
seqlock: kernel-doc: fix a prototype
Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 +
Documentation/ABI/testing/sysfs-fs-f2fs | 3 ++-
Documentation/driver-api/media/v4l2-subdev.rst | 2 +-
Documentation/fpga/dfl.rst | 4 ++--
Documentation/translations/zh_CN/mips/booting.rst | 2 +-
Documentation/translations/zh_CN/mips/features.rst | 2 +-
Documentation/translations/zh_CN/mips/index.rst | 2 +-
Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 6 +++---
Documentation/virt/kvm/api.rst | 1 +
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
drivers/usb/dwc3/core.h | 1 +
include/linux/seqlock.h | 2 +-
12 files changed, 16 insertions(+), 12 deletions(-)
--
2.29.2
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 01/10] doc/zh_CN: fix Sphinx errors
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 14:40 ` Jonathan Corbet
2021-01-14 7:53 ` [PATCH 02/10] ABI: sysfs-fs-f2fs: fix a table identation Mauro Carvalho Chehab
` (8 subsequent siblings)
9 siblings, 1 reply; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Harry Wei
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Linux Doc Mailing List,
Alex Shi, Yanteng Si, linux-kernel
The whitespacing with some translations are weird,
which causes errors like this one:
devel/v4l/docs/Documentation/translations/zh_CN/mips/ingenic-tcu.rst:61: WARNING: Malformed table.
Text in column margin in table line 6.
=========== =====
时钟 drivers/clk/ingenic/tcu.c
中断 drivers/irqchip/irq-ingenic-tcu.c
定时器 drivers/clocksource/ingenic-timer.c
OST drivers/clocksource/ingenic-ost.c
脉冲宽度调制器 drivers/pwm/pwm-jz4740.c
看门狗 drivers/watchdog/jz4740_wdt.c
=========== =====
Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
index 72b5d409ed89..919ae1d4734e 100644
--- a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
+++ b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
@@ -53,14 +53,14 @@
TCU硬件的功能分布在多个驱动程序:
-=========== =====
+================== ===================================
时钟 drivers/clk/ingenic/tcu.c
中断 drivers/irqchip/irq-ingenic-tcu.c
定时器 drivers/clocksource/ingenic-timer.c
OST drivers/clocksource/ingenic-ost.c
脉冲宽度调制器 drivers/pwm/pwm-jz4740.c
看门狗 drivers/watchdog/jz4740_wdt.c
-=========== =====
+================== ===================================
因为可以从相同的寄存器控制属于不同驱动程序和框架的TCU的各种功能,所以
所有这些驱动程序都通过相同的控制总线通用接口访问它们的寄存器。
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 02/10] ABI: sysfs-fs-f2fs: fix a table identation
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 01/10] doc/zh_CN: fix Sphinx errors Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 03/10] KVM: x86: hyper-v: add a blank line to remove building warnings Mauro Carvalho Chehab
` (7 subsequent siblings)
9 siblings, 0 replies; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Chao Yu, Jaegeuk Kim
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Linux Doc Mailing List,
linux-f2fs-devel, linux-kernel
Solves this doc build error:
.../Documentation/ABI/testing/sysfs-fs-f2fs:382: WARNING: Malformed table.
Text in column margin in table line 15.
===== ===================== =================================
value sb status macro description
0x1 SBI_IS_DIRTY dirty flag for checkpoint
0x2 SBI_IS_CLOSE specify unmounting
0x4 SBI_NEED_FSCK need fsck.f2fs to fix
0x8 SBI_POR_DOING recovery is doing or not
0x10 SBI_NEED_SB_WRITE need to recover superblock
0x20 SBI_NEED_CP need to checkpoint
0x40 SBI_IS_SHUTDOWN shutdown by ioctl
0x80 SBI_IS_RECOVERED recovered orphan/data
0x100 SBI_CP_DISABLED CP was disabled last mount
0x200 SBI_CP_DISABLED_QUICK CP was disabled quickly
0x400 SBI_QUOTA_NEED_FLUSH need to flush quota info in CP
0x800 SBI_QUOTA_SKIP_FLUSH skip flushing quota in current CP
0x1000 SBI_QUOTA_NEED_REPAIR quota file may be corrupted
0x2000 SBI_IS_RESIZEFS resizefs is in process
====== ===================== =================================
Fixes: 969945899a35 ("f2fs: introduce sb_status sysfs node")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/ABI/testing/sysfs-fs-f2fs | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/ABI/testing/sysfs-fs-f2fs b/Documentation/ABI/testing/sysfs-fs-f2fs
index e5918c93f3bf..1ba8d533437a 100644
--- a/Documentation/ABI/testing/sysfs-fs-f2fs
+++ b/Documentation/ABI/testing/sysfs-fs-f2fs
@@ -383,8 +383,9 @@ Date: December 2020
Contact: "Chao Yu" <yuchao0@huawei.com>
Description: Show status of f2fs superblock in real time.
- ===== ===================== =================================
+ ====== ===================== =================================
value sb status macro description
+ ====== ===================== =================================
0x1 SBI_IS_DIRTY dirty flag for checkpoint
0x2 SBI_IS_CLOSE specify unmounting
0x4 SBI_NEED_FSCK need fsck.f2fs to fix
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 03/10] KVM: x86: hyper-v: add a blank line to remove building warnings
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 01/10] doc/zh_CN: fix Sphinx errors Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 02/10] ABI: sysfs-fs-f2fs: fix a table identation Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 04/10] ABI: sysfs-firmware-sgi_uv Mauro Carvalho Chehab
` (6 subsequent siblings)
9 siblings, 0 replies; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Mauro Carvalho Chehab, Linux Doc Mailing List, Paolo Bonzini,
Vitaly Kuznetsov, kvm, linux-kernel
.../Documentation/virt/kvm/api.rst:4536: WARNING: Unexpected indentation.
.../Documentation/virt/kvm/api.rst:4538: WARNING: Block quote ends without a blank line; unexpected unindent.
Fixes: c21d54f0307f ("KVM: x86: hyper-v: allow KVM_GET_SUPPORTED_HV_CPUID as a system ioctl")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/virt/kvm/api.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index c136e254b496..c95572a66a7b 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -4532,6 +4532,7 @@ userspace should not expect to get any particular value there.
Note, vcpu version of KVM_GET_SUPPORTED_HV_CPUID is currently deprecated. Unlike
system ioctl which exposes all supported feature bits unconditionally, vcpu
version has the following quirks:
+
- HYPERV_CPUID_NESTED_FEATURES leaf and HV_X64_ENLIGHTENED_VMCS_RECOMMENDED
feature bit are only exposed when Enlightened VMCS was previously enabled
on the corresponding vCPU (KVM_CAP_HYPERV_ENLIGHTENED_VMCS).
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 04/10] ABI: sysfs-firmware-sgi_uv
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
` (2 preceding siblings ...)
2021-01-14 7:53 ` [PATCH 03/10] KVM: x86: hyper-v: add a blank line to remove building warnings Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 16:09 ` Ernst, Justin
2021-01-14 7:53 ` [PATCH 05/10] docs: fpga: dfl.rst: Fix a couple building issues Mauro Carvalho Chehab
` (5 subsequent siblings)
9 siblings, 1 reply; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Borislav Petkov,
Cezary Rojewski, Hans de Goede, Justin Ernst, Mike Travis,
Suzuki K Poulose, linux-kernel
Add a missing blank line required to identify a literal block,
fixing this warning:
.../Documentation/ABI/testing/sysfs-firmware-sgi_uv:2: WARNING: Unexpected indentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/ABI/testing/sysfs-firmware-sgi_uv b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
index 637c668cbe45..b0f79a1d14b3 100644
--- a/Documentation/ABI/testing/sysfs-firmware-sgi_uv
+++ b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
@@ -39,6 +39,7 @@ Description:
The uv_type entry contains the hub revision number.
This value can be used to identify the UV system version::
+
"0.*" = Hubless UV ('*' is subtype)
"3.0" = UV2
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 05/10] docs: fpga: dfl.rst: Fix a couple building issues
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
` (3 preceding siblings ...)
2021-01-14 7:53 ` [PATCH 04/10] ABI: sysfs-firmware-sgi_uv Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 14:56 ` Tom Rix
2021-01-14 7:53 ` [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup Mauro Carvalho Chehab
` (4 subsequent siblings)
9 siblings, 1 reply; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Jonathan Corbet, Moritz Fischer, Wu Hao
Cc: Mauro Carvalho Chehab, Linux Doc Mailing List, Tom Rix,
linux-fpga, linux-kernel
A title markup length is smaller than required;
A literal block is not marked as such.
This fixes the warnings below:
.../Documentation/fpga/dfl.rst:505: WARNING: Title underline too short.
Location of DFLs on a PCI Device
===========================
.../Documentation/fpga/dfl.rst:523: WARNING: Unexpected indentation.
.../Documentation/fpga/dfl.rst:523: WARNING: Blank line required after table.
.../Documentation/fpga/dfl.rst:524: WARNING: Block quote ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/fpga/dfl.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/fpga/dfl.rst b/Documentation/fpga/dfl.rst
index ea8cefc18bdb..716a3d705046 100644
--- a/Documentation/fpga/dfl.rst
+++ b/Documentation/fpga/dfl.rst
@@ -502,7 +502,7 @@ FME Partial Reconfiguration Sub Feature driver (see drivers/fpga/dfl-fme-pr.c)
could be a reference.
Location of DFLs on a PCI Device
-===========================
+================================
The original method for finding a DFL on a PCI device assumed the start of the
first DFL to offset 0 of bar 0. If the first node of the DFL is an FME,
then further DFLs in the port(s) are specified in FME header registers.
@@ -513,7 +513,7 @@ VSEC ID of 0x43 for this purpose. The vendor specific
data begins with a 4 byte vendor specific register for the number of DFLs followed 4 byte
Offset/BIR vendor specific registers for each DFL. Bits 2:0 of Offset/BIR register
indicates the BAR, and bits 31:3 form the 8 byte aligned offset where bits 2:0 are
-zero.
+zero::
+----------------------------+
|31 Number of DFLS 0|
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
` (4 preceding siblings ...)
2021-01-14 7:53 ` [PATCH 05/10] docs: fpga: dfl.rst: Fix a couple building issues Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 13:50 ` Christian König
2021-01-14 17:40 ` Alex Deucher
2021-01-14 7:53 ` [PATCH 07/10] dwc3: document gadget_max_speed Mauro Carvalho Chehab
` (3 subsequent siblings)
9 siblings, 2 replies; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Daniel Vetter, David Airlie
Cc: Mauro Carvalho Chehab, Christian König, Jonathan Corbet,
Linux Doc Mailing List, Alex Deucher, Aurabindo Pillai,
Bas Nieuwenhuizen, Bhawanpreet Lakha, Eryk Brol, Harry Wentland,
Leo Li, Mikita Lipski, Nicholas Kazlauskas, Rodrigo Siqueira,
Wayne Lin, amd-gfx, dri-devel, linux-kernel
There's a missing colon, causing the markup to be ignored,
solving those warnings:
../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
index f084e2fc9569..5ee1b766884e 100644
--- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
+++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
@@ -337,7 +337,7 @@ struct amdgpu_display_manager {
const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
/**
- * @active_vblank_irq_count
+ * @active_vblank_irq_count:
*
* number of currently active vblank irqs
*/
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 07/10] dwc3: document gadget_max_speed
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
` (5 preceding siblings ...)
2021-01-14 7:53 ` [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 9:02 ` Felipe Balbi
2021-01-14 7:53 ` [PATCH 08/10] doc: zh_CN/mips: fix doc cross-references Mauro Carvalho Chehab
` (2 subsequent siblings)
9 siblings, 1 reply; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Felipe Balbi
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Linux Doc Mailing List,
Greg Kroah-Hartman, linux-kernel, linux-usb
This new field was added to struct dwc3_scratchpad_array, but
a documentation for it was missed:
../drivers/usb/dwc3/core.h:1259: warning: Function parameter or member 'gadget_max_speed' not described in 'dwc3'
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
drivers/usb/dwc3/core.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index ac290d896638..eec1cf4ba268 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -964,6 +964,7 @@ struct dwc3_scratchpad_array {
* @nr_scratch: number of scratch buffers
* @u1u2: only used on revisions <1.83a for workaround
* @maximum_speed: maximum speed requested (mainly for testing purposes)
+ * @gadget_max_speed: maximum gadget speed requested
* @ip: controller's ID
* @revision: controller's version of an IP
* @version_type: VERSIONTYPE register contents, a sub release of a revision
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 08/10] doc: zh_CN/mips: fix doc cross-references
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
` (6 preceding siblings ...)
2021-01-14 7:53 ` [PATCH 07/10] dwc3: document gadget_max_speed Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 09/10] media: v4l2-subdev.rst: fix a missing whitespace Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 10/10] seqlock: kernel-doc: fix a prototype Mauro Carvalho Chehab
9 siblings, 0 replies; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Harry Wei
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Linux Doc Mailing List,
Alex Shi, Bartlomiej Zolnierkiewicz, Michael Ellerman,
Rob Herring, Thomas Bogendoerfer, Yanteng Si, linux-kernel
There are several wrong references there:
.../Documentation/translations/zh_CN/mips/booting.rst:5: WARNING: undefined label: booting (if the link has no caption the label must precede a section header)
.../Documentation/translations/zh_CN/mips/features.rst:5: WARNING: undefined label: features (if the link has no caption the label must precede a section header)
.../Documentation/translations/zh_CN/mips/index.rst:5: WARNING: undefined label: index (if the link has no caption the label must precede a section header)
.../Documentation/translations/zh_CN/mips/ingenic-tcu.rst:5: WARNING: undefined label: ingenic-tcu (if the link has no caption the label must precede a section header)
Replace them by :doc: markup, which won't require to add anything
extra at the existing documents.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/translations/zh_CN/mips/booting.rst | 2 +-
Documentation/translations/zh_CN/mips/features.rst | 2 +-
Documentation/translations/zh_CN/mips/index.rst | 2 +-
Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/translations/zh_CN/mips/booting.rst b/Documentation/translations/zh_CN/mips/booting.rst
index 3099d0fff7a6..00bebf7681f9 100644
--- a/Documentation/translations/zh_CN/mips/booting.rst
+++ b/Documentation/translations/zh_CN/mips/booting.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/booting.rst <booting>`
+:Original: :doc:`/mips/booting`
:Translator: Yanteng Si <siyanteng@loongson.cn>
.. _cn_booting:
diff --git a/Documentation/translations/zh_CN/mips/features.rst b/Documentation/translations/zh_CN/mips/features.rst
index 7e67f81a0982..72adcd9b360f 100644
--- a/Documentation/translations/zh_CN/mips/features.rst
+++ b/Documentation/translations/zh_CN/mips/features.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/features.rst <features>`
+:Original: :doc:`/mips/features`
:Translator: Yanteng Si <siyanteng@loongson.cn>
.. _cn_features:
diff --git a/Documentation/translations/zh_CN/mips/index.rst b/Documentation/translations/zh_CN/mips/index.rst
index 2c7b836a3da5..c2ab89890979 100644
--- a/Documentation/translations/zh_CN/mips/index.rst
+++ b/Documentation/translations/zh_CN/mips/index.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/index.rst <index>`
+:Original: :doc:`/mips/index`
:Translator: Yanteng Si <siyanteng@loongson.cn>
.. _cn_index:
diff --git a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
index 919ae1d4734e..cb570d7eca24 100644
--- a/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
+++ b/Documentation/translations/zh_CN/mips/ingenic-tcu.rst
@@ -2,7 +2,7 @@
.. include:: ../disclaimer-zh_CN.rst
-:Original: :ref:`Documentation/mips/ingenic-tcu.rst <ingenic-tcu>`
+:Original: :doc:`/mips/ingenic-tcu`
:Translator: Yanteng Si <siyanteng@loongson.cn>
.. _cn_ingenic-tcu:
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 09/10] media: v4l2-subdev.rst: fix a missing whitespace
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
` (7 preceding siblings ...)
2021-01-14 7:53 ` [PATCH 08/10] doc: zh_CN/mips: fix doc cross-references Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 10/10] seqlock: kernel-doc: fix a prototype Mauro Carvalho Chehab
9 siblings, 0 replies; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Linux Doc Mailing List,
linux-kernel, linux-media
Solves this warning:
.../Documentation/driver-api/media/v4l2-subdev.rst:125: WARNING: Inline interpreted text or phrase reference start-string without end-string.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/driver-api/media/v4l2-subdev.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/driver-api/media/v4l2-subdev.rst b/Documentation/driver-api/media/v4l2-subdev.rst
index 6d5c799c49fe..0e82c77cf3e2 100644
--- a/Documentation/driver-api/media/v4l2-subdev.rst
+++ b/Documentation/driver-api/media/v4l2-subdev.rst
@@ -123,7 +123,7 @@ Don't forget to cleanup the media entity before the sub-device is destroyed:
media_entity_cleanup(&sd->entity);
If a sub-device driver implements sink pads, the subdev driver may set the
-link_validate field in :c:type:`v4l2_subdev_pad_ops`to provide its own link
+link_validate field in :c:type:`v4l2_subdev_pad_ops` to provide its own link
validation function. For every link in the pipeline, the link_validate pad
operation of the sink end of the link is called. In both cases the driver is
still responsible for validating the correctness of the format configuration
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 10/10] seqlock: kernel-doc: fix a prototype
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
` (8 preceding siblings ...)
2021-01-14 7:53 ` [PATCH 09/10] media: v4l2-subdev.rst: fix a missing whitespace Mauro Carvalho Chehab
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
9 siblings, 0 replies; 17+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Ingo Molnar, Peter Zijlstra, Will Deacon
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Linux Doc Mailing List,
linux-kernel
Right now, kernel-doc produces a warning:
./include/linux/seqlock.h:829: warning: wrong kernel-doc identifier on line:
* DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
The issue is that Kernel-doc valid syntaxes for function/define
declarations are either:
function_foo - description
or:
function_foo() - description
The function parameters should be declared only afterwards.
So, replace it to:
DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
include/linux/seqlock.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h
index 2f7bb92b4c9e..209454cedf61 100644
--- a/include/linux/seqlock.h
+++ b/include/linux/seqlock.h
@@ -826,7 +826,7 @@ typedef struct {
} while (0)
/**
- * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
+ * DEFINE_SEQLOCK() - Define a statically allocated seqlock_t
* @sl: Name of the seqlock_t instance
*/
#define DEFINE_SEQLOCK(sl) \
--
2.29.2
^ permalink raw reply related [flat|nested] 17+ messages in thread
* Re: [PATCH 07/10] dwc3: document gadget_max_speed
2021-01-14 7:53 ` [PATCH 07/10] dwc3: document gadget_max_speed Mauro Carvalho Chehab
@ 2021-01-14 9:02 ` Felipe Balbi
0 siblings, 0 replies; 17+ messages in thread
From: Felipe Balbi @ 2021-01-14 9:02 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Linux Doc Mailing List,
Greg Kroah-Hartman, linux-kernel, linux-usb
[-- Attachment #1: Type: text/plain, Size: 433 bytes --]
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> This new field was added to struct dwc3_scratchpad_array, but
> a documentation for it was missed:
>
> ../drivers/usb/dwc3/core.h:1259: warning: Function parameter or member 'gadget_max_speed' not described in 'dwc3'
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thanks, Mauro.
Acked-by: Felipe Balbi <balbi@kernel.org>
--
balbi
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 857 bytes --]
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup
2021-01-14 7:53 ` [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup Mauro Carvalho Chehab
@ 2021-01-14 13:50 ` Christian König
2021-01-14 17:40 ` Alex Deucher
1 sibling, 0 replies; 17+ messages in thread
From: Christian König @ 2021-01-14 13:50 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Daniel Vetter, David Airlie
Cc: Jonathan Corbet, Linux Doc Mailing List, Alex Deucher,
Aurabindo Pillai, Bas Nieuwenhuizen, Bhawanpreet Lakha,
Eryk Brol, Harry Wentland, Leo Li, Mikita Lipski,
Nicholas Kazlauskas, Rodrigo Siqueira, Wayne Lin, amd-gfx,
dri-devel, linux-kernel
Am 14.01.21 um 08:53 schrieb Mauro Carvalho Chehab:
> There's a missing colon, causing the markup to be ignored,
> solving those warnings:
>
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Christian König <christian.koenig@amd.com>
> ---
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index f084e2fc9569..5ee1b766884e 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -337,7 +337,7 @@ struct amdgpu_display_manager {
> const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
>
> /**
> - * @active_vblank_irq_count
> + * @active_vblank_irq_count:
> *
> * number of currently active vblank irqs
> */
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 01/10] doc/zh_CN: fix Sphinx errors
2021-01-14 7:53 ` [PATCH 01/10] doc/zh_CN: fix Sphinx errors Mauro Carvalho Chehab
@ 2021-01-14 14:40 ` Jonathan Corbet
0 siblings, 0 replies; 17+ messages in thread
From: Jonathan Corbet @ 2021-01-14 14:40 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Harry Wei, Linux Doc Mailing List, Alex Shi, Yanteng Si, linux-kernel
On Thu, 14 Jan 2021 08:53:36 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> The whitespacing with some translations are weird,
> which causes errors like this one:
>
> devel/v4l/docs/Documentation/translations/zh_CN/mips/ingenic-tcu.rst:61: WARNING: Malformed table.
> Text in column margin in table line 6.
>
> =========== =====
> 时钟 drivers/clk/ingenic/tcu.c
> 中断 drivers/irqchip/irq-ingenic-tcu.c
> 定时器 drivers/clocksource/ingenic-timer.c
> OST drivers/clocksource/ingenic-ost.c
> 脉冲宽度调制器 drivers/pwm/pwm-jz4740.c
> 看门狗 drivers/watchdog/jz4740_wdt.c
> =========== =====
>
> Fix it.
This one has already been taken care of.
Thanks,
jon
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 05/10] docs: fpga: dfl.rst: Fix a couple building issues
2021-01-14 7:53 ` [PATCH 05/10] docs: fpga: dfl.rst: Fix a couple building issues Mauro Carvalho Chehab
@ 2021-01-14 14:56 ` Tom Rix
0 siblings, 0 replies; 17+ messages in thread
From: Tom Rix @ 2021-01-14 14:56 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Jonathan Corbet, Moritz Fischer, Wu Hao,
Lukas Bulwahn
Cc: Linux Doc Mailing List, linux-fpga, linux-kernel
On 1/13/21 11:53 PM, Mauro Carvalho Chehab wrote:
> A title markup length is smaller than required;
> A literal block is not marked as such.
>
> This fixes the warnings below:
>
> .../Documentation/fpga/dfl.rst:505: WARNING: Title underline too short.
>
> Location of DFLs on a PCI Device
> ===========================
> .../Documentation/fpga/dfl.rst:523: WARNING: Unexpected indentation.
> .../Documentation/fpga/dfl.rst:523: WARNING: Blank line required after table.
> .../Documentation/fpga/dfl.rst:524: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Lukas made an earlier change here
https://lore.kernel.org/linux-fpga/alpine.DEB.2.22.394.2101111016480.2457315@rhweight-WRK1/
Tom
^ permalink raw reply [flat|nested] 17+ messages in thread
* RE: [PATCH 04/10] ABI: sysfs-firmware-sgi_uv
2021-01-14 7:53 ` [PATCH 04/10] ABI: sysfs-firmware-sgi_uv Mauro Carvalho Chehab
@ 2021-01-14 16:09 ` Ernst, Justin
0 siblings, 0 replies; 17+ messages in thread
From: Ernst, Justin @ 2021-01-14 16:09 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Jonathan Corbet, Borislav Petkov, Cezary Rojewski, Hans de Goede,
Travis, Mike, Suzuki K Poulose, linux-kernel
> From: Mauro Carvalho Chehab [mailto:mchehab@kernel.org] On Behalf Of Mauro Carvalho Chehab
> Sent: Thursday, January 14, 2021 1:54 AM
> Subject: [PATCH 04/10] ABI: sysfs-firmware-sgi_uv
>
> Add a missing blank line required to identify a literal block,
> fixing this warning:
>
> .../Documentation/ABI/testing/sysfs-firmware-sgi_uv:2: WARNING: Unexpected indentation.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thanks for finding and fixing this. I was able to replicate the warning and confirm the fix.
Reviewed-by: Justin Ernst <justin.ernst@hpe.com>
> ---
> Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-sgi_uv b/Documentation/ABI/testing/sysfs-
> firmware-sgi_uv
> index 637c668cbe45..b0f79a1d14b3 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-sgi_uv
> +++ b/Documentation/ABI/testing/sysfs-firmware-sgi_uv
> @@ -39,6 +39,7 @@ Description:
>
> The uv_type entry contains the hub revision number.
> This value can be used to identify the UV system version::
> +
> "0.*" = Hubless UV ('*' is subtype)
>
> "3.0" = UV2
> --
> 2.29.2
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup
2021-01-14 7:53 ` [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup Mauro Carvalho Chehab
2021-01-14 13:50 ` Christian König
@ 2021-01-14 17:40 ` Alex Deucher
1 sibling, 0 replies; 17+ messages in thread
From: Alex Deucher @ 2021-01-14 17:40 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Daniel Vetter, David Airlie, Eryk Brol, Linux Doc Mailing List,
Harry Wentland, Wayne Lin, Jonathan Corbet, Rodrigo Siqueira,
LKML, amd-gfx list, Nicholas Kazlauskas, Leo Li,
Aurabindo Pillai, Maling list - DRI developers,
Bas Nieuwenhuizen, Alex Deucher, Mikita Lipski,
Bhawanpreet Lakha, Christian König
On Thu, Jan 14, 2021 at 2:53 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> There's a missing colon, causing the markup to be ignored,
> solving those warnings:
>
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
> ../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thanks, actually applied the same patch from Lukas Bulwahn a couple of days ago.
Alex
> ---
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index f084e2fc9569..5ee1b766884e 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -337,7 +337,7 @@ struct amdgpu_display_manager {
> const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
>
> /**
> - * @active_vblank_irq_count
> + * @active_vblank_irq_count:
> *
> * number of currently active vblank irqs
> */
> --
> 2.29.2
>
> _______________________________________________
> amd-gfx mailing list
> amd-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx
^ permalink raw reply [flat|nested] 17+ messages in thread
end of thread, other threads:[~2021-01-14 17:41 UTC | newest]
Thread overview: 17+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-14 7:53 [PATCH 00/10] Fix documentation warnings at linux-next Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 01/10] doc/zh_CN: fix Sphinx errors Mauro Carvalho Chehab
2021-01-14 14:40 ` Jonathan Corbet
2021-01-14 7:53 ` [PATCH 02/10] ABI: sysfs-fs-f2fs: fix a table identation Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 03/10] KVM: x86: hyper-v: add a blank line to remove building warnings Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 04/10] ABI: sysfs-firmware-sgi_uv Mauro Carvalho Chehab
2021-01-14 16:09 ` Ernst, Justin
2021-01-14 7:53 ` [PATCH 05/10] docs: fpga: dfl.rst: Fix a couple building issues Mauro Carvalho Chehab
2021-01-14 14:56 ` Tom Rix
2021-01-14 7:53 ` [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup Mauro Carvalho Chehab
2021-01-14 13:50 ` Christian König
2021-01-14 17:40 ` Alex Deucher
2021-01-14 7:53 ` [PATCH 07/10] dwc3: document gadget_max_speed Mauro Carvalho Chehab
2021-01-14 9:02 ` Felipe Balbi
2021-01-14 7:53 ` [PATCH 08/10] doc: zh_CN/mips: fix doc cross-references Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 09/10] media: v4l2-subdev.rst: fix a missing whitespace Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 10/10] seqlock: kernel-doc: fix a prototype Mauro Carvalho Chehab
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).