flow classify documentation
cover flow classify documentation
This patch set contains documention files for the Flow Classify library and the Flow Classify sample application.
Both patches update the MAINTAINERS file.
Bernard Iremonger (2):
doc: flow classify library prog guide
doc: flow classify sample app guide
MAINTAINERS | 2 + doc/guides/prog_guide/flow_classify_lib.rst | 427 ++++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + doc/guides/sample_app_ug/flow_classify.rst | 592 ++++++++++++++++++++++++++++ doc/guides/sample_app_ug/index.rst | 1 + 5 files changed, 1023 insertions(+) create mode 100644 doc/guides/prog_guide/flow_classify_lib.rst create mode 100644 doc/guides/sample_app_ug/flow_classify.rst
Signature · 1 line
1.9.1
PATCH 1/2 doc: flow classify library prog guide
This file documents the Flow Classification library, librte_flow_classify.
Updated MAINTAINERS file
--- MAINTAINERS | 1 + doc/guides/prog_guide/flow_classify_lib.rst | 427 ++++++++++++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + 3 files changed, 429 insertions(+) create mode 100644 doc/guides/prog_guide/flow_classify_lib.rst
MAINTAINERS +1 -0
@@ -718,6 +718,7 @@ M: Bernard Iremonger <[email protected]> F: lib/librte_flow_classify/ F: test/test/test_flow_classify* F: examples/flow_classify/ +F: doc/guides/prog_guide/flow_classify_lib.rst Distributor M: Bruce Richardson <[email protected]>
doc/guides/prog_guide/flow_classify_lib.rst new file +427 -0
427 lines not on this page · raw message
doc/guides/prog_guide/index.rst +1 -0
@@ -72,6 +72,7 @@ Programmer's Guide vhost_lib metrics_lib port_hotplug_framework + flow_classify_lib source_org dev_kit_build_system dev_kit_root_make_help
Signature · 1 line
1.9.1
Re: [PATCH 1/2] doc: flow classify library prog guide
Quoted 9 lines
-----Original Message-----
From: Iremonger, Bernard
Sent: Thursday, October 26, 2017 10:09 AM
To: [email protected]; Mcnamara, John <[email protected]>
Cc: Iremonger, Bernard <[email protected]>
Subject: [PATCH 1/2] doc: flow classify library prog guide
Quoted 5 lines
This file documents the Flow Classification library,
librte_flow_classify.Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>
Hi Bernard,
Thanks for the doc.
There is a doc build warning due to a reference to a file that is in the 2/2 patch:
$ make doc-guides-html -j
sphinx processing guides-html...
/work/dpdk_docs/doc/guides/prog_guide/flow_classify_lib.rst:64:
WARNING: unknown document: ../sample_app_ug/flow_classifyThere are also 2 x s/classifer/classifier/ typos in this patch and 1 in 2/2.
John
Re: [PATCH 1/2] doc: flow classify library prog guide
Hi John,
<snip>
Quoted 12 lines
Quoted 7 lines
Subject: [PATCH 1/2] doc: flow classify library prog guide
This file documents the Flow Classification library,
librte_flow_classify.Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>Hi Bernard,
Thanks for the doc.
Quoted 8 lines
There is a doc build warning due to a reference to a file that is in the 2/2 patch:
$ make doc-guides-html -j sphinx processing guides-html... /work/dpdk_docs/doc/guides/prog_guide/flow_classify_lib.rst:64: WARNING: unknown document: ../sample_app_ug/flow_classify
Both docs reference each other.
I could squash the patches into one, or add a third patch with the reference. Which option would you prefer?
Quoted 2 lines
There are also 2 x s/classifer/classifier/ typos in this patch and 1 in 2/2.
I will fix typo's
Quoted 4 lines
John
Thanks for the review.
Regards,
Bernard.
Re: [PATCH 1/2] doc: flow classify library prog guide
Quoted 35 lines
-----Original Message-----
From: Iremonger, Bernard
Sent: Thursday, November 2, 2017 5:29 PM
To: Mcnamara, John <[email protected]>; [email protected]
Cc: Iremonger, Bernard <[email protected]>
Subject: RE: [PATCH 1/2] doc: flow classify library prog guideHi John,
<snip>
Quoted 3 lines
Quoted 3 lines
Subject: [PATCH 1/2] doc: flow classify library prog guide
This file documents the Flow Classification library,
librte_flow_classify.Quoted 10 lines
Quoted 4 lines
Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>Hi Bernard,
Thanks for the doc.
There is a doc build warning due to a reference to a file that is in the
2/2
Quoted 7 lines
patch:
$ make doc-guides-html -j sphinx processing guides-html... /work/dpdk_docs/doc/guides/prog_guide/flow_classify_lib.rst:64: WARNING: unknown document: ../sample_app_ug/flow_classify
Quoted 4 lines
Both docs reference each other.
I could squash the patches into one, or add a third patch with the reference.
Which option would you prefer?
Hi Bernard,
I think squashing them into 1 patch would be okay.
John
Re: [PATCH 1/2] doc: flow classify library prog guide
Hi John,
<snip>
Quoted 29 lines
Quoted 24 lines
Quoted 4 lines
Quoted 4 lines
Subject: [PATCH 1/2] doc: flow classify library prog guide
This file documents the Flow Classification library,
librte_flow_classify.Quoted 11 lines
Quoted 4 lines
Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>Hi Bernard,
Thanks for the doc.
There is a doc build warning due to a reference to a file that is in the
2/2
Quoted 7 lines
patch:
$ make doc-guides-html -j sphinx processing guides-html... /work/dpdk_docs/doc/guides/prog_guide/flow_classify_lib.rst:64: WARNING: unknown document: ../sample_app_ug/flow_classifyQuoted 4 lines
Both docs reference each other.
I could squash the patches into one, or add a third patch with the reference.
Which option would you prefer?
Quoted 5 lines
Hi Bernard,
I think squashing them into 1 patch would be okay.
John
I have sent a v2 patch with both patches squashed into one patch.
Regards,
Bernard.
PATCH 2/2 doc: flow classify sample app guide
In reply to Bernard IremongerThis file documents the flow_classify sample application which is used to demonstate use of the Flow Classify library, librte_flow_classify.
Updated MAINTAINERS file
--- MAINTAINERS | 1 + doc/guides/sample_app_ug/flow_classify.rst | 592 +++++++++++++++++++++++++++++ doc/guides/sample_app_ug/index.rst | 1 + 3 files changed, 594 insertions(+) create mode 100644 doc/guides/sample_app_ug/flow_classify.rst
MAINTAINERS +1 -0
@@ -719,6 +719,7 @@ F: lib/librte_flow_classify/ F: test/test/test_flow_classify* F: examples/flow_classify/ F: doc/guides/prog_guide/flow_classify_lib.rst +F: doc/guides/sample_app_ug/flow_classify.rst Distributor M: Bruce Richardson <[email protected]>
doc/guides/sample_app_ug/flow_classify.rst new file +592 -0
592 lines not on this page · raw message
doc/guides/sample_app_ug/index.rst +1 -0
@@ -78,6 +78,7 @@ Sample Applications User Guides ptpclient performance_thread ipsec_secgw + flow_classify **Figures**
Signature · 1 line
1.9.1
Re: [PATCH 2/2] doc: flow classify sample app guide
Quoted 16 lines
-----Original Message-----
From: Iremonger, Bernard
Sent: Thursday, October 26, 2017 10:09 AM
To: [email protected]; Mcnamara, John <[email protected]>
Cc: Iremonger, Bernard <[email protected]>
Subject: [PATCH 2/2] doc: flow classify sample app guideThis file documents the
flow_classifysample application which is used to demonstate use of the Flow Classify library,librte_flow_classify.Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>
doc/guides/sample_app_ug/flow_classify.rst line 49
Quoted 7 lines
doc/guides/sample_app_ug/flow_classify.rst new file +7
-0+ +Compiling the Application +------------------------- + +To compile the application export the path to the DPDK source tree and +go to the example directory: +
There is now a simple section for compilation that you can reference directly like this:
http://dpdk.org/doc/guides/sample_app_ug/hello_world.html#compiling-the-application
Copy the example from one of the other sample app guides.
John
Re: [PATCH 2/2] doc: flow classify sample app guide
Hi John,
<snip>
Quoted 21 lines
Quoted 9 lines
Subject: [PATCH 2/2] doc: flow classify sample app guide
This file documents the
flow_classifysample application which is used to demonstate use of the Flow Classify library,librte_flow_classify.Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>doc/guides/sample_app_ug/flow_classify.rst line 49
Quoted 7 lines
doc/guides/sample_app_ug/flow_classify.rst new file +7
-0+ +Compiling the Application +------------------------- + +To compile the application export the path to the DPDK source tree +and go to the example directory: +There is now a simple section for compilation that you can reference directly like this:
Quoted 4 lines
http://dpdk.org/doc/guides/sample_app_ug/hello_world.html#compiling-
the-applicationCopy the example from one of the other sample app guides.
Will do.
Quoted 3 lines
John
Regards,
Bernard.
PATCH v2 1/1 flow classify documentation
In reply to Bernard IremongerThis patch set contains documention files for the Flow Classify library and the Flow Classify sample application and updates the MAINTAINERS file.
Changes in v2:
Squashed into 1 patch.
Fixed typos.
Replaced the compiling section in the Flow Classify sample app guide with a reference to the standard compiling document.
Added a reference to the Getting Started guide in the Flow Classify sample app guide.
Bernard Iremonger (1):
doc: flow classify guides
MAINTAINERS | 2 + doc/guides/prog_guide/flow_classify_lib.rst | 427 +++++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + doc/guides/sample_app_ug/flow_classify.rst | 575 ++++++++++++++++++++++++++++ doc/guides/sample_app_ug/index.rst | 1 + 5 files changed, 1006 insertions(+) create mode 100644 doc/guides/prog_guide/flow_classify_lib.rst create mode 100644 doc/guides/sample_app_ug/flow_classify.rst
Signature · 1 line
1.9.1
PATCH v2 1/1 doc: flow classify guides
In reply to Bernard IremongerThe Flow Classify Library Programmers Guide documents librte_flow_classify.
The Flow Classify Sample Application Guide documents the flow_classify sample application which is used to demonstate the use of the Flow Classify Library, librte_flow_classify.
Updated MAINTAINERS file
--- MAINTAINERS | 2 + doc/guides/prog_guide/flow_classify_lib.rst | 427 +++++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + doc/guides/sample_app_ug/flow_classify.rst | 575 ++++++++++++++++++++++++++++ doc/guides/sample_app_ug/index.rst | 1 + 5 files changed, 1006 insertions(+) create mode 100644 doc/guides/prog_guide/flow_classify_lib.rst create mode 100644 doc/guides/sample_app_ug/flow_classify.rst
MAINTAINERS +2 -0
@@ -725,6 +725,8 @@ M: Bernard Iremonger <[email protected]> F: lib/librte_flow_classify/ F: test/test/test_flow_classify* F: examples/flow_classify/ +F: doc/guides/prog_guide/flow_classify_lib.rst +F: doc/guides/sample_app_ug/flow_classify.rst Distributor M: Bruce Richardson <[email protected]>
doc/guides/prog_guide/flow_classify_lib.rst new file +427 -0
427 lines not on this page · raw message
doc/guides/prog_guide/index.rst +1 -0
@@ -72,6 +72,7 @@ Programmer's Guide vhost_lib metrics_lib port_hotplug_framework + flow_classify_lib source_org dev_kit_build_system dev_kit_root_make_help
doc/guides/sample_app_ug/flow_classify.rst new file +575 -0
575 lines not on this page · raw message
doc/guides/sample_app_ug/index.rst +1 -0
@@ -79,6 +79,7 @@ Sample Applications User Guides ptpclient performance_thread ipsec_secgw + flow_classify **Figures**
Signature · 1 line
1.9.1
Re: [PATCH v2] doc: flow classify guides
Quoted 12 lines
-----Original Message-----
From: Iremonger, Bernard
Sent: Friday, November 3, 2017 11:14 AM
To: [email protected]; Mcnamara, John <[email protected]>
Cc: Iremonger, Bernard <[email protected]>
Subject: [PATCH v2] doc: flow classify guidesThe Flow Classify Library Programmers Guide documents
librte_flow_classify.
Quoted 7 lines
The Flow Classify Sample Application Guide documents the
flow_classifysample application which is used to demonstate the use of the Flow Classify Library,librte_flow_classify.Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>
Thomas Monjalon
AppliedRe: [PATCH v2] doc: flow classify guides
Quoted 7 lines
Quoted 7 lines
The Flow Classify Library Programmers Guide documents
librte_flow_classify.The Flow Classify Sample Application Guide documents the
flow_classifysample application which is used to demonstate the use of the Flow Classify Library,librte_flow_classify.
Quoted 5 lines
Quoted 3 lines
Updated
MAINTAINERSfileSigned-off-by Bernard Iremonger <[email protected]>Acked-by John McNamara <[email protected]>
Applied, thanks