linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/2] Fix some kernel-doc markups with wrong identifiers
@ 2020-12-02  8:27 Mauro Carvalho Chehab
  2020-12-02  8:27 ` [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup Mauro Carvalho Chehab
  2020-12-02  8:27 ` [PATCH 2/2] drm: amdgpu: fix " Mauro Carvalho Chehab
  0 siblings, 2 replies; 7+ messages in thread
From: Mauro Carvalho Chehab @ 2020-12-02  8:27 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
	Christian König, H. Peter Anvin, Alex Deucher,
	Borislav Petkov, Daniel Vetter, Dave Airlie, David Airlie,
	Felix Kuehling, Ingo Molnar, Jarkko Sakkinen,
	Mihir Bhogilal Patel, Nirmoy Das, Thomas Gleixner, amd-gfx,
	dri-devel, linux-sgx, x86, xinhui pan

After applying this patch over next-20201201:

   https://lore.kernel.org/linux-doc/cover.1606823973.git.mchehab+huawei@kernel.org/T/#m0072adc6eb1af595a31fcc3b019cb81ab28c7b9f

There are a couple of new warnings that the kernel-doc prototype
doesn't match the documented function.

This series address them.

Mauro Carvalho Chehab (2):
  asm: sgx.h: fix a typo on a kernel-doc markup
  drm: amdgpu: fix a kernel-doc markup

 arch/x86/include/uapi/asm/sgx.h            | 2 +-
 drivers/gpu/drm/amd/amdgpu/amdgpu_object.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

-- 
2.28.0



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

* [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup
  2020-12-02  8:27 [PATCH 0/2] Fix some kernel-doc markups with wrong identifiers Mauro Carvalho Chehab
@ 2020-12-02  8:27 ` Mauro Carvalho Chehab
  2020-12-02 10:07   ` Borislav Petkov
  2020-12-02 16:24   ` Jarkko Sakkinen
  2020-12-02  8:27 ` [PATCH 2/2] drm: amdgpu: fix " Mauro Carvalho Chehab
  1 sibling, 2 replies; 7+ messages in thread
From: Mauro Carvalho Chehab @ 2020-12-02  8:27 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, H. Peter Anvin, Jonathan Corbet,
	Borislav Petkov, Ingo Molnar, Jarkko Sakkinen, Thomas Gleixner,
	linux-kernel, linux-sgx, x86

As warned by kernel-doc:
	arch/x86/include/uapi/asm/sgx.h:19: warning: expecting prototype for enum sgx_epage_flags. Prototype was for enum sgx_page_flags instead

There is a typo at the kernel-doc markup:

	sgx_epage_flags -> sgx_page_flags

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 arch/x86/include/uapi/asm/sgx.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/include/uapi/asm/sgx.h b/arch/x86/include/uapi/asm/sgx.h
index 791e45334a4a..9034f3007c4e 100644
--- a/arch/x86/include/uapi/asm/sgx.h
+++ b/arch/x86/include/uapi/asm/sgx.h
@@ -9,7 +9,7 @@
 #include <linux/ioctl.h>
 
 /**
- * enum sgx_epage_flags - page control flags
+ * enum sgx_page_flags - page control flags
  * %SGX_PAGE_MEASURE:	Measure the page contents with a sequence of
  *			ENCLS[EEXTEND] operations.
  */
-- 
2.28.0


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

* [PATCH 2/2] drm: amdgpu: fix a kernel-doc markup
  2020-12-02  8:27 [PATCH 0/2] Fix some kernel-doc markups with wrong identifiers Mauro Carvalho Chehab
  2020-12-02  8:27 ` [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup Mauro Carvalho Chehab
@ 2020-12-02  8:27 ` Mauro Carvalho Chehab
  2020-12-02  8:45   ` Christian König
  1 sibling, 1 reply; 7+ messages in thread
From: Mauro Carvalho Chehab @ 2020-12-02  8:27 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Christian König, Jonathan Corbet,
	Alex Deucher, Daniel Vetter, Dave Airlie, David Airlie,
	Felix Kuehling, Mihir Bhogilal Patel, Nirmoy Das, amd-gfx,
	dri-devel, linux-kernel, xinhui pan

The function name at kernel-doc markup doesn't match the name
of the function:

	drivers/gpu/drm/amd/amdgpu/amdgpu_object.c:1534: warning: expecting prototype for amdgpu_debugfs_print_bo_info(). Prototype was for amdgpu_bo_print_info() instead

Fix it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_object.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
index c6c9723d3d8a..fd7a93c32235 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
@@ -1518,7 +1518,7 @@ uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
 	} while (0)
 
 /**
- * amdgpu_debugfs_print_bo_info - print BO info in debugfs file
+ * amdgpu_bo_print_info - print BO info in debugfs file
  *
  * @id: Index or Id of the BO
  * @bo: Requested BO for printing info
-- 
2.28.0


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

* Re: [PATCH 2/2] drm: amdgpu: fix a kernel-doc markup
  2020-12-02  8:27 ` [PATCH 2/2] drm: amdgpu: fix " Mauro Carvalho Chehab
@ 2020-12-02  8:45   ` Christian König
  2020-12-03  5:01     ` Alex Deucher
  0 siblings, 1 reply; 7+ messages in thread
From: Christian König @ 2020-12-02  8:45 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Jonathan Corbet, Alex Deucher, Daniel Vetter, Dave Airlie,
	David Airlie, Felix Kuehling, Mihir Bhogilal Patel, Nirmoy Das,
	amd-gfx, dri-devel, linux-kernel, xinhui pan

Am 02.12.20 um 09:27 schrieb Mauro Carvalho Chehab:
> The function name at kernel-doc markup doesn't match the name
> of the function:
>
> 	drivers/gpu/drm/amd/amdgpu/amdgpu_object.c:1534: warning: expecting prototype for amdgpu_debugfs_print_bo_info(). Prototype was for amdgpu_bo_print_info() instead
>
> Fix it.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

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

> ---
>   drivers/gpu/drm/amd/amdgpu/amdgpu_object.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
> index c6c9723d3d8a..fd7a93c32235 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
> @@ -1518,7 +1518,7 @@ uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
>   	} while (0)
>   
>   /**
> - * amdgpu_debugfs_print_bo_info - print BO info in debugfs file
> + * amdgpu_bo_print_info - print BO info in debugfs file
>    *
>    * @id: Index or Id of the BO
>    * @bo: Requested BO for printing info


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

* Re: [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup
  2020-12-02  8:27 ` [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup Mauro Carvalho Chehab
@ 2020-12-02 10:07   ` Borislav Petkov
  2020-12-02 16:24   ` Jarkko Sakkinen
  1 sibling, 0 replies; 7+ messages in thread
From: Borislav Petkov @ 2020-12-02 10:07 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, H. Peter Anvin, Jonathan Corbet,
	Ingo Molnar, Jarkko Sakkinen, Thomas Gleixner, linux-kernel,
	linux-sgx, x86

On Wed, Dec 02, 2020 at 09:27:14AM +0100, Mauro Carvalho Chehab wrote:
> As warned by kernel-doc:
> 	arch/x86/include/uapi/asm/sgx.h:19: warning: expecting prototype for enum sgx_epage_flags. Prototype was for enum sgx_page_flags instead
> 
> There is a typo at the kernel-doc markup:
> 
> 	sgx_epage_flags -> sgx_page_flags
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  arch/x86/include/uapi/asm/sgx.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/arch/x86/include/uapi/asm/sgx.h b/arch/x86/include/uapi/asm/sgx.h
> index 791e45334a4a..9034f3007c4e 100644
> --- a/arch/x86/include/uapi/asm/sgx.h
> +++ b/arch/x86/include/uapi/asm/sgx.h
> @@ -9,7 +9,7 @@
>  #include <linux/ioctl.h>
>  
>  /**
> - * enum sgx_epage_flags - page control flags
> + * enum sgx_page_flags - page control flags
>   * %SGX_PAGE_MEASURE:	Measure the page contents with a sequence of
>   *			ENCLS[EEXTEND] operations.
>   */
> -- 

Acked-by: Borislav Petkov <bp@suse.de>

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette

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

* Re: [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup
  2020-12-02  8:27 ` [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup Mauro Carvalho Chehab
  2020-12-02 10:07   ` Borislav Petkov
@ 2020-12-02 16:24   ` Jarkko Sakkinen
  1 sibling, 0 replies; 7+ messages in thread
From: Jarkko Sakkinen @ 2020-12-02 16:24 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, H. Peter Anvin, Jonathan Corbet,
	Borislav Petkov, Ingo Molnar, Thomas Gleixner, linux-kernel,
	linux-sgx, x86

On Wed, Dec 02, 2020 at 09:27:14AM +0100, Mauro Carvalho Chehab wrote:
> As warned by kernel-doc:
> 	arch/x86/include/uapi/asm/sgx.h:19: warning: expecting prototype for enum sgx_epage_flags. Prototype was for enum sgx_page_flags instead
> 
> There is a typo at the kernel-doc markup:
> 
> 	sgx_epage_flags -> sgx_page_flags
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Thank you.

Acked-by: Jarkko Sakkinen <jarkko@kernel.org>

/Jarkko

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

* Re: [PATCH 2/2] drm: amdgpu: fix a kernel-doc markup
  2020-12-02  8:45   ` Christian König
@ 2020-12-03  5:01     ` Alex Deucher
  0 siblings, 0 replies; 7+ messages in thread
From: Alex Deucher @ 2020-12-03  5:01 UTC (permalink / raw)
  To: Christian König
  Cc: Mauro Carvalho Chehab, Linux Doc Mailing List,
	Mihir Bhogilal Patel, Jonathan Corbet, David Airlie,
	Felix Kuehling, xinhui pan, LKML, amd-gfx list,
	Maling list - DRI developers, Daniel Vetter, Alex Deucher,
	Dave Airlie, Nirmoy Das

On Wed, Dec 2, 2020 at 3:45 AM Christian König <christian.koenig@amd.com> wrote:
>
> Am 02.12.20 um 09:27 schrieb Mauro Carvalho Chehab:
> > The function name at kernel-doc markup doesn't match the name
> > of the function:
> >
> >       drivers/gpu/drm/amd/amdgpu/amdgpu_object.c:1534: warning: expecting prototype for amdgpu_debugfs_print_bo_info(). Prototype was for amdgpu_bo_print_info() instead
> >
> > Fix it.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>
> Reviewed-by: Christian König <christian.koenig@amd.com>
>

Applied.  Thanks!

Alex

> > ---
> >   drivers/gpu/drm/amd/amdgpu/amdgpu_object.c | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
> > index c6c9723d3d8a..fd7a93c32235 100644
> > --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
> > +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
> > @@ -1518,7 +1518,7 @@ uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
> >       } while (0)
> >
> >   /**
> > - * amdgpu_debugfs_print_bo_info - print BO info in debugfs file
> > + * amdgpu_bo_print_info - print BO info in debugfs file
> >    *
> >    * @id: Index or Id of the BO
> >    * @bo: Requested BO for printing info
>
> _______________________________________________
> amd-gfx mailing list
> amd-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx

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

end of thread, other threads:[~2020-12-03  5:02 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-02  8:27 [PATCH 0/2] Fix some kernel-doc markups with wrong identifiers Mauro Carvalho Chehab
2020-12-02  8:27 ` [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup Mauro Carvalho Chehab
2020-12-02 10:07   ` Borislav Petkov
2020-12-02 16:24   ` Jarkko Sakkinen
2020-12-02  8:27 ` [PATCH 2/2] drm: amdgpu: fix " Mauro Carvalho Chehab
2020-12-02  8:45   ` Christian König
2020-12-03  5:01     ` Alex Deucher

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