From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH 0/2] docs: add warning note to base dirs readme
Date: Wed, 10 Jun 2015 18:08:45 +0100 [thread overview]
Message-ID: <1433956127-9813-1-git-send-email-john.mcnamara@intel.com> (raw)
This patch updates the "Source Organisation" section of the Programmers Guide
to add an note that the code in the drivers/net/pmd/base directories should
not be modifed by the user apart from the pmd_osdep.[ch] files.
It also adds a note to the README files in the drivers/net/pmd/base dirs to
highlight the same thing.
P.S. When reviewing documentation patches it is sometimes useful to apply them to a temp
branch and view the differences on a word or character level:
git diff --color-words HEAD~1
git diff --color-words=. HEAD~1
John McNamara (2):
doc: add explanation about code in the base dirs
drivers: add warning note to base dirs readme
doc/guides/prog_guide/source_org.rst | 124 +++++++++++++++++++----------------
drivers/net/e1000/base/README | 13 ++--
drivers/net/ixgbe/base/README | 16 ++---
drivers/net/vmxnet3/base/README | 13 ++--
4 files changed, 87 insertions(+), 79 deletions(-)
--
1.8.1.4
next reply other threads:[~2015-06-10 17:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-06-10 17:08 John McNamara [this message]
2015-06-10 17:08 ` [dpdk-dev] [PATCH 1/2] doc: add explanation about code in the base dirs John McNamara
2015-06-10 17:08 ` [dpdk-dev] [PATCH 2/2] drivers: add warning note to base dirs readme John McNamara
2015-08-10 22:27 ` [dpdk-dev] [PATCH 0/2] docs: " 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=1433956127-9813-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).