linux-kernel - Re: [PATCH v4 30/31] i2c: tegra: Clean up and improve 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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Sun, 6 Sep 2020 01:53:56 +0300
From:   Dmitry Osipenko <digetx@...il.com>
To:     Michał Mirosław <mirq-linux@...e.qmqm.pl>
Cc:     Thierry Reding <thierry.reding@...il.com>,
        Jonathan Hunter <jonathanh@...dia.com>,
        Laxman Dewangan <ldewangan@...dia.com>,
        Wolfram Sang <wsa@...-dreams.de>,
        Andy Shevchenko <andy.shevchenko@...il.com>,
        linux-i2c@...r.kernel.org, linux-tegra@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 30/31] i2c: tegra: Clean up and improve comments

06.09.2020 01:47, Michał Mirosław пишет:
> On Sat, Sep 05, 2020 at 11:41:50PM +0300, Dmitry Osipenko wrote:
>> Make all comments to be consistent in regards to capitalization and
>> punctuation, correct spelling and grammar errors.
> [...]
>> -	/* Rounds down to not include partial word at the end of buf */
>> +	/* rounds down to not include partial word at the end of buffer */
>>  	words_to_transfer = buf_remaining / BYTES_PER_FIFO_WORD;
>>  
>> -	/* It's very common to have < 4 bytes, so optimize that case. */
>> +	/* it's very common to have < 4 bytes, so optimize that case */
>>  	if (words_to_transfer) {
>>  		if (words_to_transfer > tx_fifo_avail)
>>  			words_to_transfer = tx_fifo_avail;
>>  
>>  		/*
>> -		 * Update state before writing to FIFO.  If this casues us
>> +		 * Update state before writing to FIFO.  If this causes us
>>  		 * to finish writing all bytes (AKA buf_remaining goes to 0) we
>>  		 * have a potential for an interrupt (PACKET_XFER_COMPLETE is
>>  		 * not maskable).  We need to make sure that the isr sees
>> @@ -800,8 +799,8 @@ static int tegra_i2c_fill_tx_fifo(struct tegra_i2c_dev *i2c_dev)
>>  	}
> 
> Those first letters don't look consistently capitalized. :-)

In my experience, the more common kernel style is a lowercase for
single-line comments and the opposite for the multi-line comments.
Hence, should be good. If you're meaning something else, then please
clarify.