lkml.org 
[lkml]   [2017]   [Dec]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH v3 03/11] ASoC: fsl_ssi: Refine all comments
From
Date
On 12/16/17 11:30 AM, Caleb Crome wrote:
> Having come to work on this driver with very little knowledge about
> kernel programming, and i.MX, I have to agree with Timur. It's an
> amazingly complex driver (with support of so many variants). By
> eliminating verbose commentary, it's also wiping away a lot of
> knowledge. The more sparse commentary makes things harder to
> understand for newcomers, or really anybody who isn't already steeped
> in knowledge about the SSI port and linux, and it's interaction with
> DMA.

This is exactly why I wrote the comments the way I did. As I was
learning about the hardware and ASoC drivers, whenever I was confused
about something and then figured it out, I would add a comment about
that. I figured if it wasn't obvious to me, it wouldn't be obvious to
anyone else. And since this was one of the first ASoC drivers, and the
first to use device tree, it would become a reference driver for years
to come. That made it even more important that I document everything I
learned.

I am pleased that other developers kept up that commenting style. This
patch destroys all of that.

\
 
 \ /
  Last update: 2017-12-16 18:48    [W:0.047 / U:0.812 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site