[dpdk-dev] [PATCH v2] doc: add coding standards documentation

Bruce Richardson bruce.richardson at intel.com
Thu Jun 4 11:33:30 CEST 2015


On Wed, Jun 03, 2015 at 07:35:32PM +0200, Thomas Monjalon wrote:
> 2015-06-03 14:58, Bruce Richardson:
> > Add coding standards document to guides directory. This document
> > codifies the current DPDK C coding conventions, to make it easier for
> > contributors to see the format their code should be in.
> > 
> > Signed-off-by: Siobhan Butler <siobhan.a.butler at intel.com>
> > Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> > 
> > ---
> > 
> > Updates in V2:
> > * Fixed file creation mode
> > * Removed blank line at end of file
> > * Adjusted coding blocks to be C language, rather than console, so as to
> >   have correct syntax highlighting.
> > * Shortened longer lines by breaking lines at sentence - and
> >   occasionally comma - boundaries.
> > ---
> >  doc/guides/coding_standards/index.rst | 861 ++++++++++++++++++++++++++++++++++
> >  doc/guides/index.rst                  |   1 +
> 
> This version seems very good.
> However, I have the feeling that coding_standards/ is not a good name:
> 	- "standards" word is a bit strong ;
> 	- "coding" seems too restrictive, maybe we would like to put
> more guidelines in this directory (thinking about file tree, compat and tests).
> Do you agree I rename it to guidelines/coding_style.rst?

No problem, go with it!


More information about the dev mailing list