From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH v2] doc: add coding standards documentation Date: Wed, 03 Jun 2015 19:35:32 +0200 Message-ID: <1627508.1SMo23WCxz@xps13> References: <1431531022-29697-2-git-send-email-bruce.richardson@intel.com> <1433339893-19603-1-git-send-email-bruce.richardson@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: dev@dpdk.org To: Bruce Richardson Return-path: Received: from mail-wi0-f181.google.com (mail-wi0-f181.google.com [209.85.212.181]) by dpdk.org (Postfix) with ESMTP id 1BE73376C for ; Wed, 3 Jun 2015 19:36:26 +0200 (CEST) Received: by wibdt2 with SMTP id dt2so21752563wib.1 for ; Wed, 03 Jun 2015 10:36:26 -0700 (PDT) In-Reply-To: <1433339893-19603-1-git-send-email-bruce.richardson@intel.com> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 > Signed-off-by: Bruce Richardson > > --- > > 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?