DPDK patches and discussions
 help / color / mirror / Atom feed
From: Baruch Siach <baruch@tkos.co.il>
To: dev@dpdk.org
Cc: John McNamara <john.mcnamara@intel.com>,
	Baruch Siach <baruch@tkos.co.il>
Subject: [dpdk-dev] [PATCH v2 3/3] doc: consistently quote directory names
Date: Tue,  6 Dec 2016 14:38:10 +0200	[thread overview]
Message-ID: <87dec97f0194546888b9920d74e8af4d83e21208.1481027890.git.baruch@tkos.co.il> (raw)
In-Reply-To: <04aef536b67faf3c09e0f4603736057f95b5ef66.1481027890.git.baruch@tkos.co.il>

Quote the names of the app and example directories like other directory
names in this chapter.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
v2: New patch
---
 doc/guides/prog_guide/source_org.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index 27e18e8951a0..6167384db4d3 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -125,7 +125,7 @@ Applications
 Applications are source files that contain a ``main()`` function.
 They are located in the ``$(RTE_SDK)/app`` and ``$(RTE_SDK)/examples`` directories.
 
-The app directory contains applications that are used to test DPDK (such as autotests)
+The ``app`` directory contains applications that are used to test DPDK (such as autotests)
 or the Poll Mode Drivers (test-pmd)::
 
     app
@@ -135,7 +135,7 @@ or the Poll Mode Drivers (test-pmd)::
     +-- test-pipeline      # Test the IP Pipeline framework
     +-- test-pmd           # Test and benchmark poll mode drivers
 
-The examples directory contains sample applications that show how libraries can be used::
+The ``examples`` directory contains sample applications that show how libraries can be used::
 
     examples
     +-- cmdline            # Example of using the cmdline library
@@ -162,5 +162,5 @@ The examples directory contains sample applications that show how libraries can
 
 .. note::
 
-    The actual app and examples directories may contain additional applications to those shown above.
+    The actual ``app`` and ``examples`` directories may contain additional applications to those shown above.
     Check the latest DPDK source files for details.
-- 
2.10.2

  parent reply	other threads:[~2016-12-06 12:38 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-06 12:38 [dpdk-dev] [PATCH v2 1/3] doc: note that the app list is incomplete Baruch Siach
2016-12-06 12:38 ` [dpdk-dev] [PATCH v2 2/3] doc: correct the description of the app directory Baruch Siach
2016-12-06 12:48   ` Mcnamara, John
2016-12-06 12:38 ` Baruch Siach [this message]
2016-12-06 12:48   ` [dpdk-dev] [PATCH v2 3/3] doc: consistently quote directory names Mcnamara, John
2016-12-06 12:48 ` [dpdk-dev] [PATCH v2 1/3] doc: note that the app list is incomplete Mcnamara, John
2016-12-06 16:53 ` Thomas Monjalon
2017-02-09 14:49   ` 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=87dec97f0194546888b9920d74e8af4d83e21208.1481027890.git.baruch@tkos.co.il \
    --to=baruch@tkos.co.il \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    /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).