Re: [alsa-devel][PATCH v3] ASoC: TSCS42xx: Add support for Tempo Semiconductor's TSCS42xx audio CODEC

[Philippe Ombredanne]

Steven,

On Sat, Dec 9, 2017 at 11:42 PM, Steven Eckhoff
<steven.eckhoff.opensource@xxxxxxxxx> wrote:
> Currently there is no support for the TSCS42xx audio CODEC.
>
> Add support for it.
>
> Below is the link to the v2 patch in case the threading is broken. This
>  patch addressed each issue raised in the last review.
>
> https://patchwork.kernel.org/patch/10058117/
>
> Signed-off-by: Steven Eckhoff <steven.eckhoff.opensource@xxxxxxxxx>
> Cc: Steven Eckhoff <steven.eckhoff.opensource@xxxxxxxxx>
> Cc: Liam Girdwood <lgirdwood@xxxxxxxxx>
> Cc: Mark Brown <broonie@xxxxxxxxxx>
> Cc: Jaroslav Kysela <perex@xxxxxxxx>
> Cc: Takashi Iwai <tiwai@xxxxxxxx>
> Cc: alsa-devel@xxxxxxxxxxxxxxxx
> Cc: linux-kernel@xxxxxxxxxxxxxxx
[...]
> --- /dev/null
> +++ b/sound/soc/codecs/tscs42xx.c
> @@ -0,0 +1,1571 @@
> +/*
> + * tscs42xx.c -- TSCS42xx ALSA SoC Audio driver
> + *
> + * Copyright 2017 Tempo Semiconductor, Inc.
> + *
> + * Author: Steven Eckhoff <steven.eckhoff.opensource@xxxxxxxxx>
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + */

Have you considered using the new SPDX ids? This would come out as:

> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * tscs42xx.c -- TSCS42xx ALSA SoC Audio driver
> + *
> + * Copyright 2017 Tempo Semiconductor, Inc.
> + *
> + * Author: Steven Eckhoff <steven.eckhoff.opensource@xxxxxxxxx>
> + */

... and is shorter and greppable: there is nothing not to like in
this, unless you love legalese of course!

Check also Thomas doc patches and Linus rationale of why he wants this
as the top line using C++-style comments.

And if you agree like me with Linus take on C++ comments, you could
even go with less boilerplate with this:

> +// SPDX-License-Identifier: GPL-2.0
> +// tscs42xx.c -- TSCS42xx ALSA SoC Audio driver
> +// Copyright 2017 Tempo Semiconductor, Inc.
> +// Author: Steven Eckhoff <steven.eckhoff.opensource@xxxxxxxxx>

This would make 12 lines of comment be just 4 .... with the same
effect, but less distraction from your fine code.

Thank you for your kind consideration!
-- 
Cordially
Philippe Ombredanne