diff mbox

[dpdk-dev,v2,3/3] doc: consistently quote directory names

Message ID 87dec97f0194546888b9920d74e8af4d83e21208.1481027890.git.baruch@tkos.co.il (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
checkpatch/checkpatch success coding style OK

Commit Message

Baruch Siach Dec. 6, 2016, 12:38 p.m. UTC 
  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(-)

Comments

John McNamara Dec. 6, 2016, 12:48 p.m. UTC | #1 
> -----Original Message-----
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> Sent: Tuesday, December 6, 2016 12:38 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Baruch Siach
> <baruch@tkos.co.il>
> Subject: [PATCH v2 3/3] doc: consistently quote directory names
> 
> 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>

Acked-by: John McNamara <john.mcnamara@intel.com>
diff mbox

Patch

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.