DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] Coding standards
Date: Wed, 13 May 2015 16:30:21 +0100	[thread overview]
Message-ID: <1431531022-29697-1-git-send-email-bruce.richardson@intel.com> (raw)

This patch adds a coding standards doc to DPDK, and is based off the original
version Siobhan posted earlier in the tools discussion. It's been cleaned up
a bit, and converted to the rst format to match the rest of the docs.

I've pulled in a lot of the feedback that people gave on the original version,
but I'm sure the discussion is going to continue on this.

When reviewing please remember: This document is designed to put in writing the
*existing* code guidelines for DPDK that are implied by the existing code. It is
*not* intended that we should have to make any across-the-board code changes as
the basis of this document until after it has been merged in - so if you are
suggesting something that is not already prevalent in DPDK code, please hold that
thought until after we get the existing style locked down! :-)

Also note that there are a few areas where the DPDK is itself not consistent*. This
is why there is the general overriding rule that code in each file must be
consistent to the rest of the file above all else.

* by "not consistent", I'm meaning where there is are more than just a few outliers
from the original style.

Bruce Richardson (1):
  doc: add coding standards documentation

 doc/guides/coding_standards/index.rst | 806 ++++++++++++++++++++++++++++++++++
 doc/guides/index.rst                  |   2 +
 2 files changed, 808 insertions(+)
 create mode 100755 doc/guides/coding_standards/index.rst

-- 
2.1.0

             reply	other threads:[~2015-05-13 15:30 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-13 15:30 Bruce Richardson [this message]
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
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=1431531022-29697-1-git-send-email-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    /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).