Re: [PATCH] Trivial numbering change in comments.

[Randy Dunlap]

On 08/28/2018 03:03 PM, Nathan Chancellor wrote:
> On Tue, Aug 28, 2018 at 04:08:18PM -0400, Ray Clinton wrote:
>> I'm trying to get my feet wet in kernel dev and while working on a patch
>> I noticed in a lengthy comment block that the number "2" was skipped
>> in a description of the steps of a protocol. This patch is simply correcting
>> this. This is for 4.18.0.
>>
>> It is a very trivial patch, but this is my first actual try at one and
>> thought I
>> might start out small (and I don't think you can get smaller than a single
>>  character change). Any and all advice (about this patch, email, or
>> anything else) is very welcome.
>>
>> Thanks so much!
>> Ray
>>
>> Signed-off-by: Ray Clinton <mr.ray.clinton@xxxxxxxxx>
>> ---
>>  drivers/staging/android/uapi/vsoc_shm.h | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/staging/android/uapi/vsoc_shm.h
>> b/drivers/staging/android/uapi/vsoc_shm.h
>> index 6291fb2..0301172 100644
>> --- a/drivers/staging/android/uapi/vsoc_shm.h
>> +++ b/drivers/staging/android/uapi/vsoc_shm.h
>> @@ -92,7 +92,7 @@ struct fd_scoped_permission_arg {
>>   *    The transmitter can choose any appropriate hashing algorithm, including
>>   *    hash = futex_offset & ((1 << num_nodes_lg2) - 1)
>>   *
>> - * 3. The transmitter should atomically compare and swap futex_offset with 0
>> + * 2. The transmitter should atomically compare and swap futex_offset with 0
>>   *    at hash. There are 3 possible outcomes
>>   *      a. The swap fails because the futex_offset is already in the table.
>>   *         The transmitter should stop.
>> -- 
>> 2.7.4
> 
> Hi Ray,
> 
> Welcome to Linux kernel development and good first patch. Just a few
> words of advice for any future patches that you submit!
> 
> Make sure to include what subsystem you are modifying in the commit
> title. You can see examples by using 'git log --online <path>'; for

s/online/oneline/  :)

> this subsystem, it's usually "staging: android: vsoc:", making this
> patch's title "staging: android: vsoc: Trivial numbering change in comments".
> 
> I'd recommend keeping author details (such as your experience and other
> info) in-between the '---' and the file names modified in the patch so
> that they can be read by the maintainers/reviewers but not added to the
> commit message by 'git am'. This is also helpful for adding comments
> like what changed between versions of the patch or maybe something like
> "I'm not sure this change is correct, it could also be done via <method>,
> I'd like some review".
> 
> Small nits in the grand scheme of things but they'll come in handy as
> you develop more and more complex patches and series.
> 
> Reviewed-by: Nathan Chancellor <natechancellor@xxxxxxxxx>
> 
> Cheers!
> Nathan
> 


-- 
~Randy