linux-kernel - Re: [PATCH VKMS v3] drm/vkms: Fix typo and preposion in function documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Mon, 4 Nov 2019 19:29:15 -0500
From:   Rodrigo Siqueira <rodrigosiqueiramelo@...il.com>
To:     Gabriela Bittencourt <gabrielabittencourt00@...il.com>
Cc:     outreachy-kernel@...glegroups.com, manasi.d.navare@...el.com,
        hamohammed.sa@...il.com, daniel@...ll.ch, airlied@...ux.ie,
        dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org,
        lkcamp@...ts.libreplanetbr.org
Subject: Re: [PATCH VKMS v3] drm/vkms: Fix typo and preposion in function
 documentation

Hi Gabriela,

Did you double-check for other typos?

Reviewed-by: Rodrigo Siqueira <rodrigosiqueiramelo@...il.com>

Thanks

On 11/04, Gabriela Bittencourt wrote:
> Fix typo in word 'blend' and in the word 'destination' and change
> preposition 'at' to 'of' in function 'blend' documentation.
> And change the task introduction word 'Todo' for the word all in uppercase
> - 'TODO'. With the TODO word all in uppercase (as it's the standard) it's
> easier to find the tasks that have to be done throughout the code.
> 
> Changes since V3:
>  Rodrigo:
>  - Merge the patch series into a single patch since it contains one single
>  logical change
> 
> Changes since V2:
>  - Add fix typo in  word 'destination'
>  - Add change of the preposition
>  - Fix the name of the function in log message
>  - Add the change in word 'Todo'
> 
> Signed-off-by: Gabriela Bittencourt <gabrielabittencourt00@...il.com>
> 
> ---
> 
> I've tested the patch using kernel-doc
> ---
>  drivers/gpu/drm/vkms/vkms_composer.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/gpu/drm/vkms/vkms_composer.c b/drivers/gpu/drm/vkms/vkms_composer.c
> index d5585695c64d..4af2f19480f4 100644
> --- a/drivers/gpu/drm/vkms/vkms_composer.c
> +++ b/drivers/gpu/drm/vkms/vkms_composer.c
> @@ -43,18 +43,18 @@ 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
> + * 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
> 

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

Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)