* [PATCH 00/10] Fix documentation warnings at linux-next
@ 2021-01-14 7:53 Mauro Carvalho Chehab
2021-01-14 7:53 ` [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup Mauro Carvalho Chehab
0 siblings, 1 reply; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: kvm, David Airlie, Tom Rix, linux-fpga, dri-devel, Harry Wei,
Will Deacon, Jonathan Corbet, Mauro Carvalho Chehab, amd-gfx,
Peter Zijlstra, Ingo Molnar, linux-media, Chao Yu, Moritz Fischer,
Jaegeuk Kim, Mauro Carvalho Chehab, Felipe Balbi, linux-usb,
linux-kernel, linux-f2fs-devel, Daniel Vetter, Wu Hao
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
_______________________________________________
amd-gfx mailing list
amd-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/amd-gfx
^ permalink raw reply [flat|nested] 4+ 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
@ 2021-01-14 7:53 ` Mauro Carvalho Chehab
2021-01-14 13:50 ` Christian König
2021-01-14 17:40 ` Alex Deucher
0 siblings, 2 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw)
To: Daniel Vetter, David Airlie
Cc: Eryk Brol, Linux Doc Mailing List, Mauro Carvalho Chehab,
Harry Wentland, Wayne Lin, Jonathan Corbet, Rodrigo Siqueira,
linux-kernel, amd-gfx, Nicholas Kazlauskas, Leo Li,
Aurabindo Pillai, dri-devel, Bas Nieuwenhuizen, Alex Deucher,
Mikita Lipski, Bhawanpreet Lakha, Christian König
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
_______________________________________________
amd-gfx mailing list
amd-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/amd-gfx
^ permalink raw reply related [flat|nested] 4+ 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; 4+ messages in thread
From: Christian König @ 2021-01-14 13:50 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Daniel Vetter, David Airlie
Cc: Eryk Brol, Linux Doc Mailing List, Leo Li, Harry Wentland,
Wayne Lin, Jonathan Corbet, Rodrigo Siqueira, linux-kernel,
amd-gfx, Aurabindo Pillai, dri-devel, Bas Nieuwenhuizen,
Alex Deucher, Mikita Lipski, Bhawanpreet Lakha,
Nicholas Kazlauskas
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
> */
_______________________________________________
amd-gfx mailing list
amd-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/amd-gfx
^ permalink raw reply [flat|nested] 4+ 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; 4+ messages in thread
From: Alex Deucher @ 2021-01-14 17:40 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Eryk Brol, Linux Doc Mailing List, David Airlie,
Bhawanpreet Lakha, Jonathan Corbet, Rodrigo Siqueira, LKML,
amd-gfx list, Christian König, Leo Li, Aurabindo Pillai,
Maling list - DRI developers, Daniel Vetter, Wayne Lin,
Alex Deucher, Mikita Lipski, Harry Wentland, Nicholas Kazlauskas,
Bas Nieuwenhuizen
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
_______________________________________________
amd-gfx mailing list
amd-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/amd-gfx
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-01-14 17:40 UTC | newest]
Thread overview: 4+ 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 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
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox