Skip to contentSkip to conversation

Fix some kernel-doc markups with wrong identifiers

PATCH Applied Mauro Carvalho Chehab 5 participants 7 messages Dec 2, 2020 – Dec 3, 2020

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

cover Fix some kernel-doc markups with wrong identifiers

After applying this patch over next-20201201:

https://lore.kernel.org/linux-doc/[email protected]/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(-)
Signature · 7 lines
2.28.0


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

PATCH 1/2 asm: sgx.h: fix a typo on a kernel-doc markup

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
---
 arch/x86/include/uapi/asm/sgx.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/include/uapi/asm/sgx.h +1 -1
index 791e45334a4a..9034f3007c4e 100644
@@ -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.
  */
Signature · 1 line
2.28.0
maintainer Acked-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup

Quoted 18 lines · Mauro Carvalho Chehab

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
---
 arch/x86/include/uapi/asm/sgx.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/include/uapi/asm/sgx.h +0 -0
index 791e45334a4a..9034f3007c4e 100644

arch/x86/include/uapi/asm/sgx.h line 15

Quoted 8 lines
arch/x86/include/uapi/asm/sgx.h +1 -1
@@ -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.
  */
Signature · 4 lines
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette
maintainer Acked-by on v1 1/2
#3 lore raw

Re: [PATCH 1/2] asm: sgx.h: fix a typo on a kernel-doc markup

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

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

Thank you.

/Jarkko

#4 lore raw

PATCH 2/2 drm: amdgpu: fix a kernel-doc markup

In reply to 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.

---
 drivers/gpu/drm/amd/amdgpu/amdgpu_object.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_object.c +1 -1
index c6c9723d3d8a..fd7a93c32235 100644
@@ -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
Signature · 6 lines
2.28.0

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx
maintainer Reviewed-by on v1 2/2
#5 lore raw

Re: [PATCH 2/2] drm: amdgpu: fix a kernel-doc markup

Am 02.12.20 um 09:27 schrieb Mauro Carvalho Chehab:

Quoted 8 lines

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.

Quoted 9 lines
---
  drivers/gpu/drm/amd/amdgpu/amdgpu_object.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_object.c +0 -0
index c6c9723d3d8a..fd7a93c32235 100644

drivers/gpu/drm/amd/amdgpu/amdgpu_object.c uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev, · line 1524

Quoted 8 lines
drivers/gpu/drm/amd/amdgpu/amdgpu_object.c +1 -1
@@ -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
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

Applied
#6 lore raw

Re: [PATCH 2/2] drm: amdgpu: fix a kernel-doc markup

Quoted 5 lines · Christian König

Am 02.12.20 um 09:27 schrieb Mauro Carvalho Chehab:

Quoted 3 lines

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

Quoted 8 lines
Quoted 5 lines

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.

Applied. Thanks!

Alex

Quoted 11 lines
Quoted 11 lines
---
  drivers/gpu/drm/amd/amdgpu/amdgpu_object.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_object.c +0 -0
index c6c9723d3d8a..fd7a93c32235 100644
@@ -1518,7 +1518,7 @@ uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
      } while (0)
 
Quoted 11 lines

drivers/gpu/drm/amd/amdgpu/amdgpu_object.c uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev, · line 1524

Quoted 6 lines
drivers/gpu/drm/amd/amdgpu/amdgpu_object.c +1 -1
  /**
- * 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
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

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