Soft Patch Panel
 help / color / Atom feed
From: Yasufumi Ogawa <yasufum.o@gmail.com>
To: x-fn-spp-ml@ntt-tx.co.jp
Cc: ferruh.yigit@intel.com, spp@dpdk.org
Subject: Re: [spp] [PATCH 00/11] Add Hardware offload document
Date: Fri, 13 Mar 2020 09:46:40 +0900
Message-ID: <48f6bf12-e6d2-14ce-4e0c-8fbb527dc3ca@gmail.com> (raw)
In-Reply-To: <815523d8-19be-ebc9-0498-51d82514b832@gmail.com>

On 2020/03/05 18:04, Yasufumi Ogawa wrote:
> Hi Hideyuki,
> 
> Although I replied to this patch set with applied, but found an warning 
> in docs compilation. It might be happened in some environment.
> 
> The reason is because you do not separate code block after ".. 
> code-block:: none" instruction. You should follow the coding convention 
> even though docs.
> 
> Could you add a blank line to avoid the warning in "docs: add usecase 
> for hardware offload"?
> 
> Here is a result of docs compilation.
Hi,

Could you make update?
> 
> Thanks
> 
> $ make doc-html
> make -C docs/guides html
> Running Sphinx v1.8.4
> making output directory...
> building [mo]: targets for 0 po files that are out of date
> building [html]: targets for 52 source files that are out of date
> updating environment: 52 added, 0 changed, 0 removed
> reading sources... [100%] usecases/spp_vf
> /home/ogawa/spp-patches/mailed/spp/docs/guides/usecases/hardware-offload.rst:259: 
> WARNING: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 167 supplied.
> 
> .. code-block:: none
>      spp > pri; flow create phy:0 ingress group 1 pattern eth dst is \
>      10:22:33:44:55:66 / vlan vid is 100 / end actions queue index 1 \
>      / of_pop_vlan / end
>      spp > pri; flow create phy:0 ingress group 1 pattern eth dst is \
>      10:22:33:44:55:67 / vlan vid is 200 / end actions queue index 2 \
>      / of_pop_vlan / end
>      spp > pri; flow create phy:0 ingress group 0 pattern eth / end \
>      actions jump group 1 / end
>      spp > pri; flow create phy:0 egress group 1 pattern eth src is \
>      10:22:33:44:55:66 / end actions of_push_vlan ethertype 0x8100 \
>      / of_set_vlan_vid vlan_vid 100 / of_set_vlan_pcp vlan_pcp 3 / end
>      spp > pri; flow create phy:0 egress group 1 pattern eth src is \
>      10:22:33:44:55:67 / end actions of_push_vlan ethertype 0x8100 \
>      / of_set_vlan_vid vlan_vid 200 / of_set_vlan_pcp vlan_pcp 3 / end
>      spp > pri; flow create phy:0 egress group 0 pattern eth / end \
>      actions jump group 1 / end
> looking for now-outdated files... none found
> pickling environment... done
> checking consistency... done
> preparing documents... done
> writing output... [100%] usecases/spp_vf
> generating indices... genindex
> writing additional pages... search
> copying images... [100%] images/usecases/vf_ssh_nwconfig.svg
> copying static files... done
> copying extra files... done
> dumping search index in English (code: en) ... done
> dumping object inventory... done
> build succeeded, 1 warning.
> 
> 
> On 2020/03/05 15:04, Yasufumi Ogawa wrote:
>>> From: Hideyuki Yamashita <yamashita.hideyuki@ntt-tx.co.jp>
>>>
>>> This patch set provides doccuments of hardware offload
>>> capability for spp.
>> Applied, thanks.
>>
>>>
>>> tx-spp (11):
>>>    docs: add support for rte_flow
>>>    docs: add support of MLX5 PMD support in DPDK
>>>    docs: change primary process startup parameter
>>>    docs: add description of REST-APIs for flow rules
>>>    docs: support flow syntax in primary command
>>>    docs: support multi-queue in spp_vf command
>>>    docs: add svg for classify case of hardware offload
>>>    docs: add svg for vlan case of hardware offload
>>>    docs: add svg for vm case of hardware offload
>>>    docs: add usecase for hardware offload
>>>    docs: add install drivers for Mellanox NIC
>>>
>>>   docs/guides/api_ref/spp_primary.rst           |  208 ++++
>>>   docs/guides/commands/primary.rst              |   99 +-
>>>   docs/guides/commands/secondary/spp_vf.rst     |   54 +-
>>>   docs/guides/design/spp_primary.rst            |    3 +
>>>   docs/guides/gsg/howto_use.rst                 |   20 +
>>>   docs/guides/gsg/install.rst                   |   25 +-
>>>   docs/guides/gsg/setup.rst                     |   12 +
>>>   .../spp_hardware_offload_classify.svg         |  680 +++++++++++
>>>   .../use_cases/spp_hardware_offload_vlan.svg   |  805 +++++++++++++
>>>   .../use_cases/spp_hardware_offload_vm.svg     | 1063 +++++++++++++++++
>>>   docs/guides/usecases/hardware-offload.rst     |  327 +++++
>>>   docs/guides/usecases/index.rst                |    1 +
>>>   12 files changed, 3254 insertions(+), 43 deletions(-)
>>>   create mode 100644 
>>> docs/guides/images/setup/use_cases/spp_hardware_offload_classify.svg
>>>   create mode 100644 
>>> docs/guides/images/setup/use_cases/spp_hardware_offload_vlan.svg
>>>   create mode 100644 
>>> docs/guides/images/setup/use_cases/spp_hardware_offload_vm.svg
>>>   create mode 100644 docs/guides/usecases/hardware-offload.rst
>>>

      reply index

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-26 11:43 x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 01/11] docs: add support for rte_flow x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 02/11] docs: add support of MLX5 PMD support in DPDK x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 03/11] docs: change primary process startup parameter x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 04/11] docs: add description of REST-APIs for flow rules x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 05/11] docs: support flow syntax in primary command x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 06/11] docs: support multi-queue in spp_vf command x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 07/11] docs: add svg for classify case of hardware offload x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 08/11] docs: add svg for vlan " x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 09/11] docs: add svg for vm " x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 10/11] docs: add usecase for " x-fn-spp-ml
2020-02-26 11:43 ` [spp] [PATCH 11/11] docs: add install drivers for Mellanox NIC x-fn-spp-ml
2020-03-05  6:04 ` [spp] [PATCH 00/11] Add Hardware offload document Yasufumi Ogawa
2020-03-05  9:04   ` Yasufumi Ogawa
2020-03-13  0:46     ` Yasufumi Ogawa [this message]

Reply instructions:

You may reply publically 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=48f6bf12-e6d2-14ce-4e0c-8fbb527dc3ca@gmail.com \
    --to=yasufum.o@gmail.com \
    --cc=ferruh.yigit@intel.com \
    --cc=spp@dpdk.org \
    --cc=x-fn-spp-ml@ntt-tx.co.jp \
    /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

Soft Patch Panel

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/spp/0 spp/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 spp spp/ http://inbox.dpdk.org/spp \
		spp@dpdk.org
	public-inbox-index spp


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.spp


AGPL code for this site: git clone https://public-inbox.org/ public-inbox