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(-)
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 */
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
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
dri-devel@lists.freedesktop.org
-
Alex Deucher -
Christian König -
Mauro Carvalho Chehab