[spp] [PATCH 15/30] doc: update descriptions for todo

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


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

- Add why use nc command and how.
- Change the status of json based steps from 'are deprecated' to
  'will be deprecated'.

Signed-off-by: Naoki Takada <takada.naoki at lab.ntt.co.jp>
---
 docs/spp_vf/sample_usage.md | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/docs/spp_vf/sample_usage.md b/docs/spp_vf/sample_usage.md
index 00e1631..ce68867 100644
--- a/docs/spp_vf/sample_usage.md
+++ b/docs/spp_vf/sample_usage.md
@@ -34,10 +34,16 @@ First, launch spp controller and primary process.
   -p 0x03 -n 8 -s 127.0.0.1:5555
   ```
 
-TODO(yasufum) add description for sec.
+After primary process is launched, run nc command for each of
+seconrdary processes and itselves.
+In this sample, commands for secondary are sent from nc because
+`spp.py` does not support commands for spp_vf.
+nc is a network utility and it can open TCP connections, send UDP
+packets, listen on arbitrary TCP and UDP ports, do port scanning,
+and deal with both IPv4 and IPv6.
 
   ```sh
-  # start nc for secondary 1
+  # run nc for secondary 1 with port 11111
   $ while true; do nc -l 11111; done
 
   # start secondary 1
@@ -48,7 +54,7 @@ TODO(yasufum) add description for sec.
   --config /path/to/spp_vf1_without_cmtab.json \
   -s 127.0.0.1:11111
 
-  # start nc for secondary 2
+  # run nc for secondary 2 with port 11112
   $ while true; do nc -l 11112; done
 
   # start secondary 2
@@ -120,7 +126,7 @@ discarding packets.
 
 ## Test Application
 
-TODO(yasufum) json-based steps are deprecated.
+TODO(yasufum) json-based steps will be deprecated.
 
 ### Register MAC address to Classifier
 
-- 
1.9.1



More information about the spp mailing list