Re: [PATCH] pwm: vt8500: Rename variable pointing to driver private data

From: Lee Jones
Date: Fri Feb 11 2022 - 02:44:30 EST


On Fri, 11 Feb 2022, 赵晓 wrote:

> Thanks for you suggestion. I modified the patch following your instructions and commit the v2 version. 
>  

Would you be kind enough to turn HTML off in your browser please.

Also, please refrain from top-posting.

Replies should be inline (like this).

> ------------------ Original ------------------
> From: &nbsp;"Uwe&nbsp;Kleine-König"<u.kleine-koenig@xxxxxxxxxxxxxx&gt;;
> Date: &nbsp;Thu, Feb 10, 2022 03:40 PM
> To: &nbsp;"zhaoxiao"<zhaoxiao@xxxxxxxxxxxxx&gt;;
> Cc: &nbsp;"thierry.reding"<thierry.reding@xxxxxxxxx&gt;; "lee.jones"<lee.jones@xxxxxxxxxx&gt;; "linux-arm-kernel"<linux-arm-kernel@xxxxxxxxxxxxxxxxxxx&gt;; "linux-pwm"<linux-pwm@xxxxxxxxxxxxxxx&gt;; "linux-kernel"<linux-kernel@xxxxxxxxxxxxxxx&gt;;
> Subject: &nbsp;Re: [PATCH] pwm: vt8500: Rename variable pointing to driver private data

Please configure your mailer to strip mail headers from the body.

> &nbsp;
>
> On Wed, Feb 09, 2022 at 02:47:55PM +0800, zhaoxiao wrote:
> &gt; Status quo is that variables of type struct vt8500_chip * are named
> &gt; "pwm", "chip" or "pc". The two formers are all not optimal because
>
> There are no variables named "pwm" or "pc".
>
> &gt; usually only struct pwm_device * variables are named "pwm" and "chip" is
> &gt; usually used for variabled of type struct pwm_chip *.
> &gt;
> &gt; So consistently use the same and non-conflicting name "pc".
>
> The intention is fine, but you missed a few instances that are named
> "vt8500". The statistic in mainline looks as follows:
>
> $ git grep -o -h -E 'struct vt8500_chip \*[a-zA-Z0-9_]*' linus/master drivers/pwm/pwm-vt8500.c | sort | uniq -c
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 2 struct vt8500_chip *chip
> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 5 struct vt8500_chip *vt8500
>
> (So there 2 variabled named "chip" (that you renamed to "pc") and 5 that
> are named "vt8500". I prefer to rename the "chip"s to "vt8500".
>
> Best regards
> Uwe
>

--
Lee Jones [李琼斯]
Principal Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog