linux-kernel - Re: [PATCH for-next v3] selftests/zram: gitignore output file

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: <79c762c6-77fc-4784-a86e-42be7977d86d@fujitsu.com>
Date: Wed, 4 Dec 2024 02:11:07 +0000
From: "Zhijian Li (Fujitsu)" <lizhijian@...itsu.com>
To: Shuah Khan <skhan@...uxfoundation.org>, "linux-kselftest@...r.kernel.org"
	<linux-kselftest@...r.kernel.org>
CC: "shuah@...nel.org" <shuah@...nel.org>, "linux-kernel@...r.kernel.org"
	<linux-kernel@...r.kernel.org>
Subject: Re: [PATCH for-next v3] selftests/zram: gitignore output file



On 04/12/2024 09:21, Shuah Khan wrote:
> On 11/22/24 00:49, Li Zhijian wrote:
>> After `make run_tests`, the git status complains:
>> Untracked files:
>>      (use "git add <file>..." to include in what will be committed)
>>          zram/err.log
>>
>> This file will be cleaned up when execute 'make clean'
>>
>> Cc: Shuah Khan <shuah@...nel.org>
>> Signed-off-by: Li Zhijian <lizhijian@...itsu.com>
>> ---
>> Hello,
>> Cover letter is here.
>>
>> This patch set aims to make 'git status' clear after 'make' and 'make
>> run_tests' for kselftests.
>> ---
>> V3:
>>    Add Copyright description
>> V2:
>>     split as a separate patch from a small one [0]
>>     [0] https://lore.kernel.org/linux-kselftest/20241015010817.453539-1-lizhijian@fujitsu.com/
>>
>> Signed-off-by: Li Zhijian <lizhijian@...itsu.com>
>> ---
>>   tools/testing/selftests/zram/.gitignore | 2 ++
>>   1 file changed, 2 insertions(+)
>>   create mode 100644 tools/testing/selftests/zram/.gitignore
>>
>> diff --git a/tools/testing/selftests/zram/.gitignore b/tools/testing/selftests/zram/.gitignore
>> new file mode 100644
>> index 000000000000..088cd9bad87a
>> --- /dev/null
>> +++ b/tools/testing/selftests/zram/.gitignore
>> @@ -0,0 +1,2 @@
>> +# SPDX-License-Identifier: GPL-2.0-only
>> +err.log
> 
> This doesn't sound right. err.log is a generated file
> when the test runs.


IIUC, generally, there are 2 ways to handle files generated by the tests
- 1. clean/remove it if it's a temporary file before the test exits.
- 2. add it to the gitignore if it's the test result or log that needs to be referred to later.

In this zram case, it seems it intended to log and print the error
only if some commands get something wrong.

And this file have been already tracked in the Makefile
tools/testing/selftests/zram/Makefile:EXTRA_CLEAN := err.log

Given that I also think it's fine to add it to gitignore.


Thanks
Zhijian

> 
> thanks,
> -- Shuah
>