[PATCH v2 0/2] new: Improvements to new script

[PATCH v2 0/2] new: Improvements to new script

[Nirjhar Roy (IBM)]

This series adds a couple of improvements to the "new" script.
Patch-1/3 - Adds an optional name/email id parameter prompt to the new script while creating
 a new test file using the "new" file.
Patch 2/3 - Replace "status=0;exit 0" with _exit 0 in the skeleton file in "new".

[v1] -> v2
 - Added RB of Zorro in patch 2 of [v1]
 - Modified the prompt message for entering the author name (patch 1 of [v1])

[v1] https://lore.kernel.org/all/cover.1747123422.git.nirjhar.roy.lists@gmail.com/

Nirjhar Roy (IBM) (2):
  new: Add a new parameter (name/emailid) in the "new" script
  new: Replace "status=0; exit 0" with _exit 0

 new | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

--
2.34.1

[PATCH v2 1/2] new: Add a new parameter (name/emailid) in the "new" script

[Nirjhar Roy (IBM)]

This patch another optional interactive prompt to enter the
author name and email id for each new test file that is
created using the "new" file.

The sample output looks like something like the following:

./new selftest
Next test id is 007
Append a name to the ID? Test name will be 007-$name. y,[n]:
Creating test file '007'
Add to group(s) [auto] (separate by space, ? for list): selftest quick
Enter <author_name> <email-id>: Nirjhar Roy <nirjhar.roy.lists@gmail.com>
Creating skeletal script for you to edit ...
 done.

...
...

Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
---
 new | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/new b/new
index 6b50ffed..636648e2 100755
--- a/new
+++ b/new
@@ -136,6 +136,9 @@ else
 	check_groups "${new_groups[@]}" || exit 1
 fi
 
+read -p "Enter <author_name>: " -r
+author_name="${REPLY:=YOUR NAME HERE}"
+
 echo -n "Creating skeletal script for you to edit ..."
 
 year=`date +%Y`
@@ -143,7 +146,7 @@ year=`date +%Y`
 cat <<End-of-File >$tdir/$id
 #! /bin/bash
 # SPDX-License-Identifier: GPL-2.0
-# Copyright (c) $year YOUR NAME HERE.  All Rights Reserved.
+# Copyright (c) $year $author_name.  All Rights Reserved.
 #
 # FS QA Test $id
 #
-- 
2.34.1

Re: [PATCH v2 1/2] new: Add a new parameter (name/emailid) in the "new" script

[Ritesh Harjani]

"Nirjhar Roy (IBM)" <nirjhar.roy.lists@gmail.com> writes:

> This patch another optional interactive prompt to enter the
> author name and email id for each new test file that is
> created using the "new" file.
>
> The sample output looks like something like the following:
>
> ./new selftest
> Next test id is 007
> Append a name to the ID? Test name will be 007-$name. y,[n]:
> Creating test file '007'
> Add to group(s) [auto] (separate by space, ? for list): selftest quick
> Enter <author_name> <email-id>: Nirjhar Roy <nirjhar.roy.lists@gmail.com>

I don't see much of a value add in this change here, as folks or
atleast I prefer to quickly get into writing my test first and later
worry about these details :). But I guess I understand where you are
coming from, a lot of times people miss to update this and end up
sending a test with "YOUR NAME HERE" placeholder.

So, sure if we are doing this - then please fix the commit message too,
as it still shows <email-id> above.

-ritesh

> Creating skeletal script for you to edit ...
>  done.
>
> ...
> ...
>
> Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
> ---
>  new | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/new b/new
> index 6b50ffed..636648e2 100755
> --- a/new
> +++ b/new
> @@ -136,6 +136,9 @@ else
>  	check_groups "${new_groups[@]}" || exit 1
>  fi
>  
> +read -p "Enter <author_name>: " -r
> +author_name="${REPLY:=YOUR NAME HERE}"
> +
>  echo -n "Creating skeletal script for you to edit ..."
>  
>  year=`date +%Y`
> @@ -143,7 +146,7 @@ year=`date +%Y`
>  cat <<End-of-File >$tdir/$id
>  #! /bin/bash
>  # SPDX-License-Identifier: GPL-2.0
> -# Copyright (c) $year YOUR NAME HERE.  All Rights Reserved.
> +# Copyright (c) $year $author_name.  All Rights Reserved.
>  #
>  # FS QA Test $id
>  #
> -- 
> 2.34.1

Re: [PATCH v2 1/2] new: Add a new parameter (name/emailid) in the "new" script

[Nirjhar Roy (IBM)]

On 5/17/25 08:18, Ritesh Harjani (IBM) wrote:
> "Nirjhar Roy (IBM)" <nirjhar.roy.lists@gmail.com> writes:
>
>> This patch another optional interactive prompt to enter the
>> author name and email id for each new test file that is
>> created using the "new" file.
>>
>> The sample output looks like something like the following:
>>
>> ./new selftest
>> Next test id is 007
>> Append a name to the ID? Test name will be 007-$name. y,[n]:
>> Creating test file '007'
>> Add to group(s) [auto] (separate by space, ? for list): selftest quick
>> Enter <author_name> <email-id>: Nirjhar Roy <nirjhar.roy.lists@gmail.com>
> I don't see much of a value add in this change here, as folks or
> atleast I prefer to quickly get into writing my test first and later
> worry about these details :). But I guess I understand where you are
> coming from, a lot of times people miss to update this and end up
> sending a test with "YOUR NAME HERE" placeholder.
>
> So, sure if we are doing this - then please fix the commit message too,
> as it still shows <email-id> above.

Sure. I will update the commit message in the next revision.

--NR

>
> -ritesh
>
>> Creating skeletal script for you to edit ...
>>   done.
>>
>> ...
>> ...
>>
>> Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
>> ---
>>   new | 5 ++++-
>>   1 file changed, 4 insertions(+), 1 deletion(-)
>>
>> diff --git a/new b/new
>> index 6b50ffed..636648e2 100755
>> --- a/new
>> +++ b/new
>> @@ -136,6 +136,9 @@ else
>>   	check_groups "${new_groups[@]}" || exit 1
>>   fi
>>   
>> +read -p "Enter <author_name>: " -r
>> +author_name="${REPLY:=YOUR NAME HERE}"
>> +
>>   echo -n "Creating skeletal script for you to edit ..."
>>   
>>   year=`date +%Y`
>> @@ -143,7 +146,7 @@ year=`date +%Y`
>>   cat <<End-of-File >$tdir/$id
>>   #! /bin/bash
>>   # SPDX-License-Identifier: GPL-2.0
>> -# Copyright (c) $year YOUR NAME HERE.  All Rights Reserved.
>> +# Copyright (c) $year $author_name.  All Rights Reserved.
>>   #
>>   # FS QA Test $id
>>   #
>> -- 
>> 2.34.1

-- 
Nirjhar Roy
Linux Kernel Developer
IBM, Bangalore

Re: [PATCH v2 1/2] new: Add a new parameter (name/emailid) in the "new" script

[Dave Chinner]

On Thu, May 15, 2025 at 11:00:16AM +0000, Nirjhar Roy (IBM) wrote:
> This patch another optional interactive prompt to enter the
> author name and email id for each new test file that is
> created using the "new" file.
> 
> The sample output looks like something like the following:
> 
> ./new selftest
> Next test id is 007
> Append a name to the ID? Test name will be 007-$name. y,[n]:
> Creating test file '007'
> Add to group(s) [auto] (separate by space, ? for list): selftest quick
> Enter <author_name> <email-id>: Nirjhar Roy <nirjhar.roy.lists@gmail.com>
> Creating skeletal script for you to edit ...
>  done.
> 
> ...
> ...
> 
> Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
> ---
>  new | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/new b/new
> index 6b50ffed..636648e2 100755
> --- a/new
> +++ b/new
> @@ -136,6 +136,9 @@ else
>  	check_groups "${new_groups[@]}" || exit 1
>  fi
>  
> +read -p "Enter <author_name>: " -r
> +author_name="${REPLY:=YOUR NAME HERE}"
> +
>  echo -n "Creating skeletal script for you to edit ..."
>  
>  year=`date +%Y`
> @@ -143,7 +146,7 @@ year=`date +%Y`
>  cat <<End-of-File >$tdir/$id
>  #! /bin/bash
>  # SPDX-License-Identifier: GPL-2.0
> -# Copyright (c) $year YOUR NAME HERE.  All Rights Reserved.
> +# Copyright (c) $year $author_name.  All Rights Reserved.

In many cases, this is incorrect.

For people who are corporate employees, copyright for the code they
write is typically owned by their employer, not the employee who
wrote the code. i.e. this field generally contains something like
"Red Hat, Inc", "Oracle, Inc", "IBM Corporation", etc in these
cases, not the employee's name.

-Dave.
-- 
Dave Chinner
david@fromorbit.com

Re: [PATCH v2 1/2] new: Add a new parameter (name/emailid) in the "new" script

[Nirjhar Roy (IBM)]

On 5/21/25 05:01, Dave Chinner wrote:
> On Thu, May 15, 2025 at 11:00:16AM +0000, Nirjhar Roy (IBM) wrote:
>> This patch another optional interactive prompt to enter the
>> author name and email id for each new test file that is
>> created using the "new" file.
>>
>> The sample output looks like something like the following:
>>
>> ./new selftest
>> Next test id is 007
>> Append a name to the ID? Test name will be 007-$name. y,[n]:
>> Creating test file '007'
>> Add to group(s) [auto] (separate by space, ? for list): selftest quick
>> Enter <author_name> <email-id>: Nirjhar Roy <nirjhar.roy.lists@gmail.com>
>> Creating skeletal script for you to edit ...
>>   done.
>>
>> ...
>> ...
>>
>> Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
>> ---
>>   new | 5 ++++-
>>   1 file changed, 4 insertions(+), 1 deletion(-)
>>
>> diff --git a/new b/new
>> index 6b50ffed..636648e2 100755
>> --- a/new
>> +++ b/new
>> @@ -136,6 +136,9 @@ else
>>   	check_groups "${new_groups[@]}" || exit 1
>>   fi
>>   
>> +read -p "Enter <author_name>: " -r
>> +author_name="${REPLY:=YOUR NAME HERE}"
>> +
>>   echo -n "Creating skeletal script for you to edit ..."
>>   
>>   year=`date +%Y`
>> @@ -143,7 +146,7 @@ year=`date +%Y`
>>   cat <<End-of-File >$tdir/$id
>>   #! /bin/bash
>>   # SPDX-License-Identifier: GPL-2.0
>> -# Copyright (c) $year YOUR NAME HERE.  All Rights Reserved.
>> +# Copyright (c) $year $author_name.  All Rights Reserved.
> In many cases, this is incorrect.
>
> For people who are corporate employees, copyright for the code they
> write is typically owned by their employer, not the employee who
> wrote the code. i.e. this field generally contains something like
> "Red Hat, Inc", "Oracle, Inc", "IBM Corporation", etc in these
> cases, not the employee's name.

Yes. The existing placeholder is already "YOUR NAME HERE" (which I have 
kept unchanged). The author can always use the company's name from read 
-p prompt or simply chose to fill it up later, right? Or are you saying 
that the existing placeholder "YOUR NAME HERE" is incorrect?

--NR

>
> -Dave.

-- 
Nirjhar Roy
Linux Kernel Developer
IBM, Bangalore

Re: [PATCH v2 1/2] new: Add a new parameter (name/emailid) in the "new" script

[Dave Chinner]

On Wed, May 21, 2025 at 10:52:22AM +0530, Nirjhar Roy (IBM) wrote:
> 
> On 5/21/25 05:01, Dave Chinner wrote:
> > On Thu, May 15, 2025 at 11:00:16AM +0000, Nirjhar Roy (IBM) wrote:
> > > This patch another optional interactive prompt to enter the
> > > author name and email id for each new test file that is
> > > created using the "new" file.
> > > 
> > > The sample output looks like something like the following:
> > > 
> > > ./new selftest
> > > Next test id is 007
> > > Append a name to the ID? Test name will be 007-$name. y,[n]:
> > > Creating test file '007'
> > > Add to group(s) [auto] (separate by space, ? for list): selftest quick
> > > Enter <author_name> <email-id>: Nirjhar Roy <nirjhar.roy.lists@gmail.com>
> > > Creating skeletal script for you to edit ...
> > >   done.
> > > 
> > > ...
> > > ...
> > > 
> > > Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
> > > ---
> > >   new | 5 ++++-
> > >   1 file changed, 4 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/new b/new
> > > index 6b50ffed..636648e2 100755
> > > --- a/new
> > > +++ b/new
> > > @@ -136,6 +136,9 @@ else
> > >   	check_groups "${new_groups[@]}" || exit 1
> > >   fi
> > > +read -p "Enter <author_name>: " -r
> > > +author_name="${REPLY:=YOUR NAME HERE}"
> > > +
> > >   echo -n "Creating skeletal script for you to edit ..."
> > >   year=`date +%Y`
> > > @@ -143,7 +146,7 @@ year=`date +%Y`
> > >   cat <<End-of-File >$tdir/$id
> > >   #! /bin/bash
> > >   # SPDX-License-Identifier: GPL-2.0
> > > -# Copyright (c) $year YOUR NAME HERE.  All Rights Reserved.
> > > +# Copyright (c) $year $author_name.  All Rights Reserved.
> > In many cases, this is incorrect.
> > 
> > For people who are corporate employees, copyright for the code they
> > write is typically owned by their employer, not the employee who
> > wrote the code. i.e. this field generally contains something like
> > "Red Hat, Inc", "Oracle, Inc", "IBM Corporation", etc in these
> > cases, not the employee's name.
> 
> Yes. The existing placeholder is already "YOUR NAME HERE" (which I have kept
> unchanged). The author can always use the company's name from read -p prompt
> or simply chose to fill it up later, right? Or are you saying that the
> existing placeholder "YOUR NAME HERE" is incorrect?

I'm noting that your prompt - <author_name> - is incorrect
for this "YOUR NAME HERE" field. That field is supposed to contain
the -copyright owner-, not the author of the patch. Sometimes they
are the same, but in many cases they are not.

-Dave.
-- 
Dave Chinner
david@fromorbit.com

Re: [PATCH v2 1/2] new: Add a new parameter (name/emailid) in the "new" script

[Nirjhar Roy (IBM)]

On 5/22/25 06:21, Dave Chinner wrote:
> On Wed, May 21, 2025 at 10:52:22AM +0530, Nirjhar Roy (IBM) wrote:
>> On 5/21/25 05:01, Dave Chinner wrote:
>>> On Thu, May 15, 2025 at 11:00:16AM +0000, Nirjhar Roy (IBM) wrote:
>>>> This patch another optional interactive prompt to enter the
>>>> author name and email id for each new test file that is
>>>> created using the "new" file.
>>>>
>>>> The sample output looks like something like the following:
>>>>
>>>> ./new selftest
>>>> Next test id is 007
>>>> Append a name to the ID? Test name will be 007-$name. y,[n]:
>>>> Creating test file '007'
>>>> Add to group(s) [auto] (separate by space, ? for list): selftest quick
>>>> Enter <author_name> <email-id>: Nirjhar Roy <nirjhar.roy.lists@gmail.com>
>>>> Creating skeletal script for you to edit ...
>>>>    done.
>>>>
>>>> ...
>>>> ...
>>>>
>>>> Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
>>>> ---
>>>>    new | 5 ++++-
>>>>    1 file changed, 4 insertions(+), 1 deletion(-)
>>>>
>>>> diff --git a/new b/new
>>>> index 6b50ffed..636648e2 100755
>>>> --- a/new
>>>> +++ b/new
>>>> @@ -136,6 +136,9 @@ else
>>>>    	check_groups "${new_groups[@]}" || exit 1
>>>>    fi
>>>> +read -p "Enter <author_name>: " -r
>>>> +author_name="${REPLY:=YOUR NAME HERE}"
>>>> +
>>>>    echo -n "Creating skeletal script for you to edit ..."
>>>>    year=`date +%Y`
>>>> @@ -143,7 +146,7 @@ year=`date +%Y`
>>>>    cat <<End-of-File >$tdir/$id
>>>>    #! /bin/bash
>>>>    # SPDX-License-Identifier: GPL-2.0
>>>> -# Copyright (c) $year YOUR NAME HERE.  All Rights Reserved.
>>>> +# Copyright (c) $year $author_name.  All Rights Reserved.
>>> In many cases, this is incorrect.
>>>
>>> For people who are corporate employees, copyright for the code they
>>> write is typically owned by their employer, not the employee who
>>> wrote the code. i.e. this field generally contains something like
>>> "Red Hat, Inc", "Oracle, Inc", "IBM Corporation", etc in these
>>> cases, not the employee's name.
>> Yes. The existing placeholder is already "YOUR NAME HERE" (which I have kept
>> unchanged). The author can always use the company's name from read -p prompt
>> or simply chose to fill it up later, right? Or are you saying that the
>> existing placeholder "YOUR NAME HERE" is incorrect?
> I'm noting that your prompt - <author_name> - is incorrect
> for this "YOUR NAME HERE" field. That field is supposed to contain
> the -copyright owner-, not the author of the patch. Sometimes they
> are the same, but in many cases they are not.

Oh, okay. I can change the prompt to "Enter <copyright-owner>: ".

--NR

>
> -Dave.

-- 
Nirjhar Roy
Linux Kernel Developer
IBM, Bangalore

[PATCH v2 2/2] new: Replace "status=0; exit 0" with _exit 0

[Nirjhar Roy (IBM)]

We should now start using _exit 0 for every new test
that we add.

Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
Reviewed-by: Zorro Lang <zlang@redhat.com>
---
 new | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/new b/new
index 636648e2..dff69265 100755
--- a/new
+++ b/new
@@ -176,8 +176,7 @@ exit
 #echo "If failure, check \$seqres.full (this) and \$seqres.full.ok (reference)"
 
 # success, all done
-status=0
-exit
+_exit 0
 End-of-File
 
 sleep 2		# latency to read messages to this point
-- 
2.34.1

Re: [PATCH v2 2/2] new: Replace "status=0; exit 0" with _exit 0

[Ritesh Harjani]

"Nirjhar Roy (IBM)" <nirjhar.roy.lists@gmail.com> writes:

> We should now start using _exit 0 for every new test
> that we add.
>

Right every test now sources common/exit in _begin_test() preamble.
So we may as well start using _exit for new tests.

Looks good to me. Please feel free to add:
Reviewed-by: Ritesh Harjani (IBM) <ritesh.list@gmail.com>


> Signed-off-by: Nirjhar Roy (IBM) <nirjhar.roy.lists@gmail.com>
> Reviewed-by: Zorro Lang <zlang@redhat.com>
> ---
>  new | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/new b/new
> index 636648e2..dff69265 100755
> --- a/new
> +++ b/new
> @@ -176,8 +176,7 @@ exit
>  #echo "If failure, check \$seqres.full (this) and \$seqres.full.ok (reference)"
>  
>  # success, all done
> -status=0
> -exit
> +_exit 0
>  End-of-File
>  
>  sleep 2		# latency to read messages to this point
> -- 
> 2.34.1