[spp] [PATCH 28/30] doc: fix typos and erros in texts

x-fn-spp at sl.ntt-tx.co.jp x-fn-spp at sl.ntt-tx.co.jp
Tue Jan 16 06:16:39 CET 2018


From: Hiroyuki Nakamura <nakamura.hioryuki at po.ntt-tx.co.jp>

* config_manual.md: correct explanation of 'name' attribute.
* how_to_use.md: correct default config file path.
* how_to_use.md: correct titles.
* correct typos.

Signed-off-by: Daiki Yamashita <yamashita.daiki.z01 at as.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki at lab.ntt.co.jp>
---
 docs/spp_vf/config_manual.md | 2 +-
 docs/spp_vf/how_to_use.md    | 8 ++++----
 docs/spp_vf/setup_guide.md   | 2 +-
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/spp_vf/config_manual.md b/docs/spp_vf/config_manual.md
index 05a342c..cdf10b5 100644
--- a/docs/spp_vf/config_manual.md
+++ b/docs/spp_vf/config_manual.md
@@ -32,7 +32,7 @@ Config file consists of `vfs` and defines the spp_vf attribute.
 ### Attributes in Config
 
   * vfs
-    * name: Name of spp_vf component.
+    * name: Name of the configuration. Please set user as desired.
     * num_vhost: Number of vhosts spp_vf use.
     * num_ring: Number of rings spp_vf use.
     * functions: List of forwarders and its attributes (function means a forwarder).
diff --git a/docs/spp_vf/how_to_use.md b/docs/spp_vf/how_to_use.md
index 32c1774..a0da2e8 100644
--- a/docs/spp_vf/how_to_use.md
+++ b/docs/spp_vf/how_to_use.md
@@ -64,7 +64,7 @@ Options of `spp_vf` are
 Core assingment and network configuration are defined
 in JSON formatted config file.
 If you run `spp_vf` without giving config file, it refers default
-config file (test/spp_config/spp_config/vf.json).
+config file (/usr/local/etc/spp/spp.json).
 
 ```sh
 $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
@@ -97,7 +97,7 @@ $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
 -s 127.0.0.1:6666 --vhost-client
 ```
 
-### SPP VM
+### VM
 
 Launch VMs with `virsh` command.
 
@@ -108,9 +108,9 @@ $ virsh start [VM]
 ### Additional Network Configurations
 
 To enable processes running on the VM to communicate through spp,
-it is required additional network configurations on host and guest VMss.
+it is required additional network configurations on host and guest VMs.
 
-#### Host1
+#### Guest VMs 
 
 ```sh
 # Interface for vhost
diff --git a/docs/spp_vf/setup_guide.md b/docs/spp_vf/setup_guide.md
index af2e9bf..a20ae90 100644
--- a/docs/spp_vf/setup_guide.md
+++ b/docs/spp_vf/setup_guide.md
@@ -73,7 +73,7 @@ Finally, you unmount default hugepage.
 $ sudo unmount /dev/hugepages
 ```
 
-#### Install jasson
+#### Install jansson
 
 Network configuration is defined in JSON and `spp_vf` reads config from
 the file while launching.
-- 
1.9.1



More information about the spp mailing list