Re: [proposition of drivers documentation]

Greg KH (greg@kroah.com)
Fri, 25 Apr 2003 11:58:32 -0700


On Fri, Apr 25, 2003 at 07:23:51PM +0200, xosé vázquez pérez wrote:
> =CHANGELOG
>
> [Changelog]: (latest at top)
>
> [date] [version] or [modification #] [<e-mail@server.com>]
> - bug fixes at makemelove()
> ...

This starts to get very long over time, and quite messy, and pretty much
is pointless. I used to do it for my drivers, but have given up due to
no one ever reading it, and the advent of bitkeeper (you can get
individual revision history for every file now quite easily.)

> =HARDWARE
>
> [Supported hardware]:
>
> [manufacturer_1]
> [product name]
>
> [manufacturer_2]
> [product name]
>
> =END

This is already listed in the MODULE_DEVICE_TABLE and can be parsed
later by userspace tools quite easily.

thanks,

greg k-h
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/