[PATCH v2 VKMS 0/2] drm/vkms: Changing some words in 'blend' function documentation

[PATCH v2 VKMS 0/2] drm/vkms: Changing some words in 'blend' function documentation

[Gabriela Bittencourt]

Changes in v2:
- Add fixing typo in word 'destination'
- Add change of the preposition
- In v1 the name of the function was wrong, fix it in this version
- Add the patch changing the word 'TODO'

I've tested the patches using kernel-doc

Gabriela Bittencourt (2):
  drm/vkms: Fix typo and preposion in function documentation
  drm/vkms: Changing a 'Todo' to a 'TODO' in code comment

 drivers/gpu/drm/vkms/vkms_composer.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

-- 
2.20.1

[PATCH v2 VKMS 1/2] drm/vkms: Fix typo and preposion in function documentation

[Gabriela Bittencourt]

Fix typo in word 'blend' and in the word 'destination' and change
preposition 'at' to 'of' in function 'blend' documentation.

Signed-off-by: Gabriela Bittencourt <gabrielabittencourt00@gmail.com>

---

Changes in v2:
- Add fixing typo in word 'destination'
- Add change of the preposition
- In v1 the name of the function was wrong, fix it in this version
---
 drivers/gpu/drm/vkms/vkms_composer.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/gpu/drm/vkms/vkms_composer.c b/drivers/gpu/drm/vkms/vkms_composer.c
index d5585695c64d..88890ddfc4bd 100644
--- a/drivers/gpu/drm/vkms/vkms_composer.c
+++ b/drivers/gpu/drm/vkms/vkms_composer.c
@@ -43,16 +43,16 @@ static uint32_t compute_crc(void *vaddr_out, struct vkms_composer *composer)
 }
 
 /**
- * blend - belnd value at vaddr_src with value at vaddr_dst
+ * blend - blend value at vaddr_src with value at vaddr_dst
  * @vaddr_dst: destination address
  * @vaddr_src: source address
  * @dest_composer: destination framebuffer's metadata
  * @src_composer: source framebuffer's metadata
  *
  * Blend value at vaddr_src with value at vaddr_dst.
- * Currently, this function write value at vaddr_src on value
+ * Currently, this function write value of vaddr_src on value
  * at vaddr_dst using buffer's metadata to locate the new values
- * from vaddr_src and their distenation at vaddr_dst.
+ * from vaddr_src and their destination at vaddr_dst.
  *
  * Todo: Use the alpha value to blend vaddr_src with vaddr_dst
  *	 instead of overwriting it.
-- 
2.20.1

[PATCH v2 VKMS 2/2] drm/vkms: Changing a 'Todo' to a 'TODO' in code comment

[Gabriela Bittencourt]

Changing the task introduction for the word 'TODO'. With the TODO word all
in uppercase, as is the standard, it's easier to find the tasks that have
to be done throughout the code.

Signed-off-by: Gabriela Bittencourt <gabrielabittencourt00@gmail.com>
---
 drivers/gpu/drm/vkms/vkms_composer.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/vkms/vkms_composer.c b/drivers/gpu/drm/vkms/vkms_composer.c
index 88890ddfc4bd..4af2f19480f4 100644
--- a/drivers/gpu/drm/vkms/vkms_composer.c
+++ b/drivers/gpu/drm/vkms/vkms_composer.c
@@ -54,7 +54,7 @@ static uint32_t compute_crc(void *vaddr_out, struct vkms_composer *composer)
  * at vaddr_dst using buffer's metadata to locate the new values
  * from vaddr_src and their destination at vaddr_dst.
  *
- * Todo: Use the alpha value to blend vaddr_src with vaddr_dst
+ * TODO: Use the alpha value to blend vaddr_src with vaddr_dst
  *	 instead of overwriting it.
  */
 static void blend(void *vaddr_dst, void *vaddr_src,
-- 
2.20.1

Re: [PATCH v2 VKMS 0/2] drm/vkms: Changing some words in 'blend' function documentation

[Rodrigo Siqueira]

[-- Attachment #1: Type: text/plain, Size: 1277 bytes --]

Hi Gabriela,

In the case of this series and the patch "drm/vkms: Fix typo in function
documentation", I recommend you to use a single patch. In general, If
your changes produce a lot of deltas, you need to split them into
individual patches that modify things in logical stages. In these
patches, you made changes to some files that belong to the same patch;
thus, a single logical change is contained within a single patch.[1]

Btw, thanks for fix these issues.

Best Regards

1. https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html#separate-your-changes

On 11/01, Gabriela Bittencourt wrote:
> Changes in v2:
> - Add fixing typo in word 'destination'
> - Add change of the preposition
> - In v1 the name of the function was wrong, fix it in this version
> - Add the patch changing the word 'TODO'
> 
> I've tested the patches using kernel-doc
> 
> Gabriela Bittencourt (2):
>   drm/vkms: Fix typo and preposion in function documentation
>   drm/vkms: Changing a 'Todo' to a 'TODO' in code comment
> 
>  drivers/gpu/drm/vkms/vkms_composer.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> -- 
> 2.20.1
> 

-- 
Rodrigo Siqueira
Software Engineer, Advanced Micro Devices (AMD)
https://siqueira.tech

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]