From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <jmcnam2x@ecsmtp.ir.intel.com> Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 0FF2DC3D2 for <dev@dpdk.org>; Fri, 10 Jul 2015 17:45:33 +0200 (CEST) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga103.fm.intel.com with ESMTP; 10 Jul 2015 08:45:34 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,447,1432623600"; d="scan'208";a="744543214" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga001.fm.intel.com with ESMTP; 10 Jul 2015 08:45:32 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t6AFjVpB031152; Fri, 10 Jul 2015 16:45:31 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t6AFjVRC026283; Fri, 10 Jul 2015 16:45:31 +0100 Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t6AFjVhC026279; Fri, 10 Jul 2015 16:45:31 +0100 From: John McNamara <john.mcnamara@intel.com> To: dev@dpdk.org Date: Fri, 10 Jul 2015 16:45:18 +0100 Message-Id: <1436543121-26240-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com> References: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com> Subject: [dpdk-dev] [PATCH v2 0/3] doc: added guidelines on dpdk documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK <dev.dpdk.org> List-Unsubscribe: <http://dpdk.org/ml/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://dpdk.org/ml/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <http://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> X-List-Received-Date: Fri, 10 Jul 2015 15:45:34 -0000 This patchset: * Adds guidelines on the purpose and structure of the DPDK documentation, how to build it and guidelines for creating it and adding to it. * Moves and refactors the Doxygen guidelines from the Coding Style doc to the Documentation Guidelines doc. As with the other guidelines the main idea is to document the status quo and then modify/add to it over time. V2: * Incorporates mailing list comments. * Removed doc patch contribution guide. Will submit separately as contribution guidelines. V1: * Initial version. John McNamara (3): doc: set the default literal block format doc: added guidelines on dpdk documentation doc: moved doxygen section to the doc guidelines doc/guides/conf.py | 1 + doc/guides/guidelines/coding_style.rst | 134 +----- doc/guides/guidelines/documentation.rst | 745 ++++++++++++++++++++++++++++++++ doc/guides/guidelines/index.rst | 2 + 4 files changed, 754 insertions(+), 128 deletions(-) create mode 100644 doc/guides/guidelines/documentation.rst -- 1.8.1.4