DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v2] doc: add coding standards documentation
Date: Thu, 4 Jun 2015 10:33:30 +0100	[thread overview]
Message-ID: <20150604093330.GA4968@bricha3-MOBL3> (raw)
In-Reply-To: <1627508.1SMo23WCxz@xps13>

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@intel.com>
> > Signed-off-by: Bruce Richardson <bruce.richardson@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!

  reply	other threads:[~2015-06-04  9:33 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-13 15:30 [dpdk-dev] [PATCH] Coding standards Bruce Richardson
2015-05-13 15:30 ` [dpdk-dev] [PATCH] doc: add coding standards documentation Bruce Richardson
2015-06-02 12:59   ` Thomas Monjalon
2015-06-03 10:43     ` Bruce Richardson
2015-06-03 13:58   ` [dpdk-dev] [PATCH v2] " Bruce Richardson
2015-06-03 17:35     ` Thomas Monjalon
2015-06-04  9:33       ` Bruce Richardson [this message]
2015-06-04  9:49         ` Thomas Monjalon
2015-06-04 13:36           ` Bruce Richardson
2015-05-19 11:23 ` [dpdk-dev] [PATCH] Coding standards Mcnamara, John

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150604093330.GA4968@bricha3-MOBL3 \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=thomas.monjalon@6wind.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).