[spp] [PATCH 00/11] Add Hardware offload document

[Yasufumi Ogawa]

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 at 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
>>>