linux-kernel - Re: [PATCH 02/11] gpio: davinci: coding style correction

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20130522144042.GG18614@n2100.arm.linux.org.uk>
Date:	Wed, 22 May 2013 15:40:42 +0100
From:	Russell King - ARM Linux <linux@....linux.org.uk>
To:	Philip Avinash <avinashphilip@...com>
Cc:	nsekhar@...com, khilman@...prootsystems.com,
	grant.likely@...retlab.ca, linus.walleij@...aro.org,
	linux-arm-kernel@...ts.infradead.org,
	davinci-linux-open-source@...ux.davincidsp.com,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH 02/11] gpio: davinci: coding style correction

On Wed, May 22, 2013 at 12:40:25PM +0530, Philip Avinash wrote:
>  /*
>   * Assuming the pin is muxed as a gpio output, set its output value.
>   */
> -static void
> -davinci_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
> +static void davinci_gpio_set(struct gpio_chip *chip, unsigned offset,
> +		int value)

This kind of stuff is just churn.  If you read Documentation/CodingStyle:

Statements longer than 80 columns will be broken into sensible chunks, unless
exceeding 80 columns significantly increases readability and does not hide
information. Descendants are always substantially shorter than the parent and
are placed substantially to the right. The same applies to function headers
with a long argument list. However, never break user-visible strings such as
printk messages, because that breaks the ability to grep for them.

"broken into sensible chunks".  Here's the question: is the former a
sensible format?  Arguably it is because it results in all the arguments
fitting on one line at the expense of missing the return value.

The latter is also a sensible format - but breaks the arguments instead
of the return value.

Both formats can be found in their entirety by grep by function name alone:

	grep -1 davinci_gpio_set

or if you prefer to type some more then you end up with more specific

	grep -A1 davinci_gpio_set
or
	grep -B1 davinci_gpio_set

depending on the version.

Where there's no clear advantage one way or the other, let the authors
preference stand.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/