Re: [RFC PATCH v3 5/8] CAIF Protocol Stack

[Randy Dunlap <randy.dunlap@oracle.com>]

On Thu, 10 Dec 2009 14:05:13 +0100 Sjur Brændeland wrote:

> Randy Dunlap wrote:
> > sjur.brandeland@stericsson.com wrote:
> >> From: Sjur Braendeland <sjur.brandeland@stericsson.com>
> > 
> > what Patrick said:
> > patch description should be here and each email subject should be
> > different and describe what that patch does. Please read
> > Documentation/SubmittingPatches. 
> OK I'll read carefully through Submitting Patches. Do you recon this will be ok?
> Subject: [PATCH X/Y] net-caif: Add CAIF Protocol Stack in net/caif/generic

One big point is that the subject line shouldn't be the same
for all of the patches (disregarding PATCH X/Y).
They should be like (e.g.):

[PATCH 1/5] net-caif: add header files
[PATCH 2/5] net-caif: add caif protocol
[PATCH 3/5] net-caif: add caif devices
[PATCH 4/5] net-caif: documentation
[PATCH 5/5] net-caif: Kconfig and Makefile




> >> +menuconfig CAIF
> >> +	tristate "Enable CAIF support"
> >> +	default n
> >> +	---help---
> > 
> > Tell us what CAIF means, probably in the help text.
> 
> I have rephrased this a bit, what do you think about this:
> [snip]
> menuconfig CAIF
> 	tristate "Enable CAIF support"
> 	default n
> 	---help---
> 	The "Communication CPU to Application CPU Interface" (CAIF) is a packet based
> 	connection-oriented MUX protocol developed by ST-Ericsson for use with its modems.
> 
> 	Say Y (or M) here if you build for a phone product (e.g. Android) that uses
> 	CAIF as transport, if unsure say N. 
> 
> 	If you select to build it as module then CAIF_SOCK and CAIF_NETDEV also needs to 
> 	be built as modules. You will also need to say yes to any CAIF physical devices that
> 	your platform requires.
> 
> 	See Documentation/net/CAIF for a further explanation on how to use and configure CAIF.


That looks good, thanks.

---
~Randy