From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 478975694 for ; Wed, 13 May 2015 17:30:39 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga102.jf.intel.com with ESMTP; 13 May 2015 08:30:39 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,421,1427785200"; d="scan'208";a="570801748" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 13 May 2015 08:30:37 -0700 Received: from sivswdev01.ir.intel.com (sivswdev01.ir.intel.com [10.237.217.45]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t4DFUake023581; Wed, 13 May 2015 16:30:36 +0100 Received: from sivswdev01.ir.intel.com (localhost [127.0.0.1]) by sivswdev01.ir.intel.com with ESMTP id t4DFUUug030113; Wed, 13 May 2015 16:30:30 +0100 Received: (from bricha3@localhost) by sivswdev01.ir.intel.com with id t4DFUNLA029868; Wed, 13 May 2015 16:30:23 +0100 From: Bruce Richardson To: dev@dpdk.org Date: Wed, 13 May 2015 16:30:21 +0100 Message-Id: <1431531022-29697-1-git-send-email-bruce.richardson@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH] Coding standards X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 13 May 2015 15:30:39 -0000 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