From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 8F83237AF for ; Thu, 2 Jul 2015 15:51:14 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP; 02 Jul 2015 06:50:59 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,393,1432623600"; d="scan'208";a="598928502" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 02 Jul 2015 06:50:58 -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 t62DovOK018963; Thu, 2 Jul 2015 14:50:57 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t62Dovqp017538; Thu, 2 Jul 2015 14:50:57 +0100 Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t62DovCX017534; Thu, 2 Jul 2015 14:50:57 +0100 From: John McNamara To: dev@dpdk.org Date: Thu, 2 Jul 2015 14:50:50 +0100 Message-Id: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 02 Jul 2015 13:51:15 -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. * Also adds guidelines on how to format and submit a documentation patch. * Moves and refactores 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. 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 | 126 +--- doc/guides/guidelines/documentation.rst | 1005 +++++++++++++++++++++++++++++++ doc/guides/guidelines/index.rst | 2 + 4 files changed, 1015 insertions(+), 119 deletions(-) create mode 100644 doc/guides/guidelines/documentation.rst -- 1.8.1.4