Fix documentation warnings at linux-next

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


_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

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.

---
 Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

index 72b5d409ed89..919ae1d4734e 100644
@@ -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

This one has already been taken care of.

Thanks,

jon

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

---
 Documentation/ABI/testing/sysfs-fs-f2fs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

index e5918c93f3bf..1ba8d533437a 100644
@@ -383,8 +383,9 @@ Date:		December 2020
 Contact:	"Chao Yu" <[email protected]>
 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



_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel

.../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.

---
 Documentation/virt/kvm/api.rst | 1 +
 1 file changed, 1 insertion(+)

index c136e254b496..c95572a66a7b 100644
@@ -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

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.

---
 Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 +
 1 file changed, 1 insertion(+)

index 637c668cbe45..b0f79a1d14b3 100644
@@ -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

Thanks for finding and fixing this. I was able to replicate the warning and confirm the fix.

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.

---
 Documentation/fpga/dfl.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

index ea8cefc18bdb..716a3d705046 100644
@@ -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

Lukas made an earlier change here

https://lore.kernel.org/linux-fpga/alpine.DEB.2.22.394.2101111016480.2457315@rhweight-WRK1/

Tom

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'

---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

index f084e2fc9569..5ee1b766884e 100644
@@ -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
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

Am 14.01.21 um 08:53 schrieb Mauro Carvalho Chehab:

Thanks, actually applied the same patch from Lukas Bulwahn a couple of days ago.

Alex

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

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'

---
 drivers/usb/dwc3/core.h | 1 +
 1 file changed, 1 insertion(+)

index ac290d896638..eec1cf4ba268 100644
@@ -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

Thanks, Mauro.

balbi

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.

---
 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(-)

index 3099d0fff7a6..00bebf7681f9 100644
@@ -2,7 +2,7 @@
 
 .. include:: ../disclaimer-zh_CN.rst
 
-:Original: :ref:`Documentation/mips/booting.rst <booting>`
+:Original: :doc:`/mips/booting`
 :Translator: Yanteng Si <[email protected]>
 
 .. _cn_booting:

index 7e67f81a0982..72adcd9b360f 100644
@@ -2,7 +2,7 @@
 
 .. include:: ../disclaimer-zh_CN.rst
 
-:Original: :ref:`Documentation/mips/features.rst <features>`
+:Original: :doc:`/mips/features`
 :Translator: Yanteng Si <[email protected]>
 
 .. _cn_features:

index 2c7b836a3da5..c2ab89890979 100644
@@ -2,7 +2,7 @@
 
 .. include:: ../disclaimer-zh_CN.rst
 
-:Original: :ref:`Documentation/mips/index.rst <index>`
+:Original: :doc:`/mips/index`
 :Translator: Yanteng Si <[email protected]>
 
 .. _cn_index:

index 919ae1d4734e..cb570d7eca24 100644
@@ -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 <[email protected]>
 
 .. _cn_ingenic-tcu:

2.29.2

Solves this warning:

.../Documentation/driver-api/media/v4l2-subdev.rst:125: WARNING: Inline interpreted text or phrase reference start-string without end-string.

---
 Documentation/driver-api/media/v4l2-subdev.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

index 6d5c799c49fe..0e82c77cf3e2 100644
@@ -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

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

---
 include/linux/seqlock.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

index 2f7bb92b4c9e..209454cedf61 100644
@@ -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