RE: [PATCH 00/45] staging: comedi: fix up some driver comments
From: Hartley Sweeten
Date: Mon Jan 05 2015 - 14:00:22 EST
On Monday, January 05, 2015 10:54 AM, Ian Abbott wrote:
> Most comedi drivers have a special comedi driver comment block,
> information from which can be extracted by some scripts for use in the
> "Comedilib" manual and the list of supported devices on the comedi web
> site. (Currently, the information for those places comes from the
> "out-of-tree" comedi drivers.)
>
> The "Devices:" line (and continuation lines) are supposed to be a
> comma-(and space)-separated list with the first item in this format:
>
> [Manufacturer] BOARD-NAME (comedi-board-name)
>
> The "[Manufacturer]" and "(comedi-board-name)" parts can be omitted from
> subsequent list items to decrease verbosity, in which case they are
> assumed to be the same as the preceding item.
>
> Several comedi drivers have the "Devices:" line formatted incorrectly,
> often with the use of square brackets and parentheses reversed. A few
> comedi modules have driver comments, but are just support modules for
> other drivers, so don't really need a driver comment.
Ian,
There are a number of drivers that still need the comedi comment block
converted to the normal CodingStyle format for multi-line comments.
And, as you mentioned to me before, all of the ADDI-DATA drivers
are missing the comedi comment block:
But, this is a great start to getting them cleaned up.
Reviewed-by: H Hartley Sweeten <hsweeten@xxxxxxxxxxxxxxxxxxx>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/