* [spp] [PATCH 1/1] docs: add core sharing usage in spp_vf command ref
@ 2019-02-08 4:51 x-fn-spp
2019-02-13 7:23 ` Yasufumi Ogawa
0 siblings, 1 reply; 2+ messages in thread
From: x-fn-spp @ 2019-02-08 4:51 UTC (permalink / raw)
To: ferruh.yigit, ogawa.yasufumi; +Cc: spp
From: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
This patch adds how to assign more than one component on the same core
in component command of spp_vf into command reference.
This patch also fixes typos.
Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
docs/guides/commands/secondary/spp_vf.rst | 23 +++++++++++++++++------
1 file changed, 17 insertions(+), 6 deletions(-)
diff --git a/docs/guides/commands/secondary/spp_vf.rst b/docs/guides/commands/secondary/spp_vf.rst
index 3cf1cca..6f1824b 100644
--- a/docs/guides/commands/secondary/spp_vf.rst
+++ b/docs/guides/commands/secondary/spp_vf.rst
@@ -6,7 +6,7 @@
spp_vf
======
-``spp_vf`` is a kind of SPP secondary process. It it introduced for
+``spp_vf`` is a kind of SPP secondary process. It is introduced for
providing SR-IOV like features.
Each of ``spp_vf`` processes is managed with ``vf`` command. It is for
@@ -136,7 +136,7 @@ assigned to this thread.
``Components`` is a list of all of worker threads. Each of workers has a
core ID running on, type of the worker and a list of resources.
Entry of no name with ``unuse`` type means that no worker thread assigned to
-the core. In other words, it is ready to be assinged.
+the core. In other words, it is ready to be assigned.
.. _commands_spp_vf_component:
@@ -144,7 +144,7 @@ the core. In other words, it is ready to be assinged.
component
---------
-Assing or release a role of forwarding to worker threads running on each of
+Assign or release a role of forwarding to worker threads running on each of
cores which are reserved with ``-c`` or ``-l`` option while launching
``spp_vf``. The role of the worker is chosen from ``forward``, ``merge`` or
``classifier_mac``.
@@ -165,7 +165,7 @@ This name is also used while releasing the role.
# release worker 'NAME' from the role
spp > vf SEC_ID; component stop NAME
-Here is some examples of assigning roles with ``component`` command.
+Here are some examples of assigning roles with ``component`` command.
.. code-block:: console
@@ -178,7 +178,18 @@ Here is some examples of assigning roles with ``component`` command.
# assign 'classifier_mac' role with name 'cls1' on core 4
spp > vf 2; component start cls1 4 classifier_mac
-Or examples of releasing roles.
+In the above examples, each different ``CORE-ID`` is specified to each role.
+You can assign several components on the same core, but performance might be
+decreased. This is an example for assigning two roles of ``forward`` and
+``merge`` on the same ``core 2``.
+
+.. code-block:: console
+
+ # assign two roles on the same 'core 2'.
+ spp > vf 2; component start fw1 2 forward
+ spp > vf 2; component start mgr1 2 merge
+
+Examples of releasing roles.
.. code-block:: console
@@ -340,7 +351,7 @@ Here is an example for adding entries.
# add entry of default with VLAN tag
spp > vf 1; classifier_table add vlan 101 default ring:1
-Delete an entryThis is an example to delete an entry for port ``ring:0``.
+Delete an entry. This is an example to delete an entry with VLAN tag 101.
.. code-block:: console
--
2.17.1
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [spp] [PATCH 1/1] docs: add core sharing usage in spp_vf command ref
2019-02-08 4:51 [spp] [PATCH 1/1] docs: add core sharing usage in spp_vf command ref x-fn-spp
@ 2019-02-13 7:23 ` Yasufumi Ogawa
0 siblings, 0 replies; 2+ messages in thread
From: Yasufumi Ogawa @ 2019-02-13 7:23 UTC (permalink / raw)
To: x-fn-spp; +Cc: ferruh.yigit, spp
On 2019/02/08 13:51, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
>
> This patch adds how to assign more than one component on the same core
> in component command of spp_vf into command reference.
>
> This patch also fixes typos.
Applied, thanks.
>
> Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
> Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
> ---
> docs/guides/commands/secondary/spp_vf.rst | 23 +++++++++++++++++------
> 1 file changed, 17 insertions(+), 6 deletions(-)
>
> diff --git a/docs/guides/commands/secondary/spp_vf.rst b/docs/guides/commands/secondary/spp_vf.rst
> index 3cf1cca..6f1824b 100644
> --- a/docs/guides/commands/secondary/spp_vf.rst
> +++ b/docs/guides/commands/secondary/spp_vf.rst
> @@ -6,7 +6,7 @@
> spp_vf
> ======
>
> -``spp_vf`` is a kind of SPP secondary process. It it introduced for
> +``spp_vf`` is a kind of SPP secondary process. It is introduced for
> providing SR-IOV like features.
>
> Each of ``spp_vf`` processes is managed with ``vf`` command. It is for
> @@ -136,7 +136,7 @@ assigned to this thread.
> ``Components`` is a list of all of worker threads. Each of workers has a
> core ID running on, type of the worker and a list of resources.
> Entry of no name with ``unuse`` type means that no worker thread assigned to
> -the core. In other words, it is ready to be assinged.
> +the core. In other words, it is ready to be assigned.
>
>
> .. _commands_spp_vf_component:
> @@ -144,7 +144,7 @@ the core. In other words, it is ready to be assinged.
> component
> ---------
>
> -Assing or release a role of forwarding to worker threads running on each of
> +Assign or release a role of forwarding to worker threads running on each of
> cores which are reserved with ``-c`` or ``-l`` option while launching
> ``spp_vf``. The role of the worker is chosen from ``forward``, ``merge`` or
> ``classifier_mac``.
> @@ -165,7 +165,7 @@ This name is also used while releasing the role.
> # release worker 'NAME' from the role
> spp > vf SEC_ID; component stop NAME
>
> -Here is some examples of assigning roles with ``component`` command.
> +Here are some examples of assigning roles with ``component`` command.
>
> .. code-block:: console
>
> @@ -178,7 +178,18 @@ Here is some examples of assigning roles with ``component`` command.
> # assign 'classifier_mac' role with name 'cls1' on core 4
> spp > vf 2; component start cls1 4 classifier_mac
>
> -Or examples of releasing roles.
> +In the above examples, each different ``CORE-ID`` is specified to each role.
> +You can assign several components on the same core, but performance might be
> +decreased. This is an example for assigning two roles of ``forward`` and
> +``merge`` on the same ``core 2``.
> +
> +.. code-block:: console
> +
> + # assign two roles on the same 'core 2'.
> + spp > vf 2; component start fw1 2 forward
> + spp > vf 2; component start mgr1 2 merge
> +
> +Examples of releasing roles.
>
> .. code-block:: console
>
> @@ -340,7 +351,7 @@ Here is an example for adding entries.
> # add entry of default with VLAN tag
> spp > vf 1; classifier_table add vlan 101 default ring:1
>
> -Delete an entryThis is an example to delete an entry for port ``ring:0``.
> +Delete an entry. This is an example to delete an entry with VLAN tag 101.
>
> .. code-block:: console
>
>
--
Yasufumi Ogawa
NTT Network Service Systems Labs
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-02-13 7:26 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-02-08 4:51 [spp] [PATCH 1/1] docs: add core sharing usage in spp_vf command ref x-fn-spp
2019-02-13 7:23 ` Yasufumi Ogawa
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).