linux-kernel - Re: [PATCH] drm/panfrost: cleanup comments

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]
Message-ID: <6c598625-ff78-0fd5-3787-e59415751f4f@redhat.com>
Date:   Wed, 2 Mar 2022 04:18:52 -0800
From:   Tom Rix <trix@...hat.com>
To:     Steven Price <steven.price@....com>, robh@...nel.org,
        tomeu.vizoso@...labora.com, alyssa.rosenzweig@...labora.com,
        airlied@...ux.ie, daniel@...ll.ch
Cc:     dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] drm/panfrost: cleanup comments


On 3/2/22 1:09 AM, Steven Price wrote:
> On 01/03/2022 12:43, trix@...hat.com wrote:
>> From: Tom Rix <trix@...hat.com>
>>
>> For spdx
>> change tab to space delimiter
>> Use // for *.c
>>
>> Replacements
>> commited to committed, use multiline comment style
>> regsiters to registers
>> initialze to initialize
>>
>> Signed-off-by: Tom Rix <trix@...hat.com>
> Thanks, most of the changes look reasonable (although I've never
> understood the reason for using // for SPDX comments), but there's one
> below that I think needs rethinking.
>
>> ---
>>   drivers/gpu/drm/panfrost/panfrost_drv.c          | 2 +-
>>   drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c | 2 +-
>>   drivers/gpu/drm/panfrost/panfrost_issues.h       | 6 ++++--
>>   drivers/gpu/drm/panfrost/panfrost_mmu.c          | 2 +-
>>   drivers/gpu/drm/panfrost/panfrost_regs.h         | 2 +-
>>   5 files changed, 8 insertions(+), 6 deletions(-)
>>
>> diff --git a/drivers/gpu/drm/panfrost/panfrost_drv.c b/drivers/gpu/drm/panfrost/panfrost_drv.c
>> index 96bb5a4656278..94b6f0a19c83a 100644
>> --- a/drivers/gpu/drm/panfrost/panfrost_drv.c
>> +++ b/drivers/gpu/drm/panfrost/panfrost_drv.c
>> @@ -562,7 +562,7 @@ static int panfrost_probe(struct platform_device *pdev)
>>   
>>   	pfdev->coherent = device_get_dma_attr(&pdev->dev) == DEV_DMA_COHERENT;
>>   
>> -	/* Allocate and initialze the DRM device. */
>> +	/* Allocate and initialize the DRM device. */
>>   	ddev = drm_dev_alloc(&panfrost_drm_driver, &pdev->dev);
>>   	if (IS_ERR(ddev))
>>   		return PTR_ERR(ddev);
>> diff --git a/drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c b/drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c
>> index b0142341e2235..77e7cb6d1ae3b 100644
>> --- a/drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c
>> +++ b/drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c
>> @@ -1,4 +1,4 @@
>> -/* SPDX-License-Identifier: GPL-2.0 */
>> +// SPDX-License-Identifier: GPL-2.0
>>   /* Copyright (C) 2019 Arm Ltd.
>>    *
>>    * Based on msm_gem_freedreno.c:
>> diff --git a/drivers/gpu/drm/panfrost/panfrost_issues.h b/drivers/gpu/drm/panfrost/panfrost_issues.h
>> index 8e59d765bf19f..4e7cf979ee67a 100644
>> --- a/drivers/gpu/drm/panfrost/panfrost_issues.h
>> +++ b/drivers/gpu/drm/panfrost/panfrost_issues.h
>> @@ -13,8 +13,10 @@
>>    * to care about.
>>    */
>>   enum panfrost_hw_issue {
>> -	/* Need way to guarantee that all previously-translated memory accesses
>> -	 * are commited */
>> +	/*
>> +	 * Need way to guarantee that all previously-translated memory accesses
>> +	 * are committed
>> +	 */
> This file has a whole load of multiline comments that don't technically
> follow the coding style. Fixing just one comment makes the file
> inconsistent. Note we recently had a discussion about this[1] and
> decided to leave the comment style as is. And I have to admit in this
> instance avoiding the extra mostly-blank lines makes the list easier to
> read. The typo fix is obviously welcomed though!

I'll switch this back in a respin.

Thanks

Tom


>
> [1] https://lore.kernel.org/r/c7331489-ad04-0f35-224e-164f144fb819%40arm.com
>
>>   	HW_ISSUE_6367,
>>   
>>   	/* On job complete with non-done the cache is not flushed */
>> diff --git a/drivers/gpu/drm/panfrost/panfrost_mmu.c b/drivers/gpu/drm/panfrost/panfrost_mmu.c
>> index 39562f2d11a47..d3f82b26a631d 100644
>> --- a/drivers/gpu/drm/panfrost/panfrost_mmu.c
>> +++ b/drivers/gpu/drm/panfrost/panfrost_mmu.c
>> @@ -1,4 +1,4 @@
>> -// SPDX-License-Identifier:	GPL-2.0
>> +// SPDX-License-Identifier: GPL-2.0
>>   /* Copyright 2019 Linaro, Ltd, Rob Herring <robh@...nel.org> */
>>   
>>   #include <drm/panfrost_drm.h>
>> diff --git a/drivers/gpu/drm/panfrost/panfrost_regs.h b/drivers/gpu/drm/panfrost/panfrost_regs.h
>> index 6c5a11ef1ee87..efe4b75149d35 100644
>> --- a/drivers/gpu/drm/panfrost/panfrost_regs.h
>> +++ b/drivers/gpu/drm/panfrost/panfrost_regs.h
>> @@ -292,7 +292,7 @@
>>   #define AS_FAULTADDRESS_LO(as)		(MMU_AS(as) + 0x20) /* (RO) Fault Address for address space n, low word */
>>   #define AS_FAULTADDRESS_HI(as)		(MMU_AS(as) + 0x24) /* (RO) Fault Address for address space n, high word */
>>   #define AS_STATUS(as)			(MMU_AS(as) + 0x28) /* (RO) Status flags for address space n */
>> -/* Additional Bifrost AS regsiters */
>> +/* Additional Bifrost AS registers */
>>   #define AS_TRANSCFG_LO(as)		(MMU_AS(as) + 0x30) /* (RW) Translation table configuration for address space n, low word */
>>   #define AS_TRANSCFG_HI(as)		(MMU_AS(as) + 0x34) /* (RW) Translation table configuration for address space n, high word */
>>   #define AS_FAULTEXTRA_LO(as)		(MMU_AS(as) + 0x38) /* (RO) Secondary fault address for address space n, low word */