DPDK patches and discussions
 help / color / mirror / Atom feed
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH 0/3] doc: added guidelines on dpdk documentation
Date: Thu,  2 Jul 2015 14:50:50 +0100	[thread overview]
Message-ID: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com> (raw)

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

             reply	other threads:[~2015-07-02 13:51 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-07-02 13:50 John McNamara [this message]
2015-07-02 13:50 ` [dpdk-dev] [PATCH 1/3] doc: set the default literal block format John McNamara
2015-07-02 13:50 ` [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk documentation John McNamara
2015-07-02 16:20   ` Thomas Monjalon
2015-07-03  9:54     ` Bruce Richardson
2015-07-03 10:05       ` Iremonger, Bernard
2015-07-03 10:30         ` Bruce Richardson
2015-07-10 15:39     ` Mcnamara, John
2015-07-02 17:31   ` Mcnamara, John
2015-07-02 13:50 ` [dpdk-dev] [PATCH 3/3] doc: moved doxygen section to the doc guidelines John McNamara
2015-07-10 15:45 ` [dpdk-dev] [PATCH v2 0/3] doc: added guidelines on dpdk documentation John McNamara
2015-07-10 15:45   ` [dpdk-dev] [PATCH v2 1/3] doc: set the default literal block format John McNamara
2015-08-05 14:15     ` Bruce Richardson
2015-07-10 15:45   ` [dpdk-dev] [PATCH v2 2/3] doc: added guidelines on dpdk documentation John McNamara
2015-08-05 14:26     ` Bruce Richardson
2015-07-10 15:45   ` [dpdk-dev] [PATCH v2 3/3] doc: moved doxygen section to the doc guidelines John McNamara
2015-08-05 14:26     ` Bruce Richardson
2015-08-11 10:36   ` [dpdk-dev] [PATCH v2 0/3] doc: added guidelines on dpdk documentation Thomas Monjalon

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=1435845053-17203-1-git-send-email-john.mcnamara@intel.com \
    --to=john.mcnamara@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).