[dpdk-dev] doc/ip_pipeline.rst: update f_post_init and correct f_track

Message ID 1517488514-70456-1-git-send-email-longtb5@viettel.com.vn (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

longtb5@viettel.com.vn Feb. 1, 2018, 12:32 p.m. UTC
  Update f_post_init for pipeline frontend.
Move f_track from pipeline backend to pipeline frontend.

Signed-off-by: longtb5 <longtb5@viettel.com.vn>
---
 doc/guides/sample_app_ug/ip_pipeline.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
  

Comments

Kovacevic, Marko Feb. 7, 2018, 1:55 p.m. UTC | #1
> Update f_post_init for pipeline frontend.
> Move f_track from pipeline backend to pipeline frontend.
> 
> Signed-off-by: longtb5 <longtb5@viettel.com.vn>
>
>  doc/guides/sample_app_ug/ip_pipeline.rst | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)

Everything Is ok formatting wise and info the only I see is the 
Subject line:  doc/ip_pipeline.rst: update f_post_init and correct f_track

Command to check:

./devtools/check-git-log.sh  -1

Running git check log on HEAD~1:  34835
======================================
Wrong headline format:
        doc/ip_pipeline.rst: update f_post_init and correct f_track

Once its corrected you can add my ack.

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
  

Patch

diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst
index e0aa148..dd0a23f 100644
--- a/doc/guides/sample_app_ug/ip_pipeline.rst
+++ b/doc/guides/sample_app_ug/ip_pipeline.rst
@@ -876,8 +876,6 @@  The front-end communicates with the back-end through message queues.
    |            |                  | of some requests which are mandatory for all pipelines (e.g.       |
    |            |                  | ping, statistics).                                                 |
    +------------+------------------+--------------------------------------------------------------------+
-   | f_track    | Function pointer | See section Tracking pipeline output port to physical link         |
-   +------------+------------------+--------------------------------------------------------------------+
 
 
 .. _table_ip_pipelines_front_end:
@@ -892,6 +890,10 @@  The front-end communicates with the back-end through message queues.
    | f_init     | Function pointer      | Function to initialize the front-end of the current pipeline      |
    |            |                       | instance.                                                         |
    +------------+-----------------------+-------------------------------------------------------------------+
+   | f_post_init| Function pointer      | Function to run once after f_init.                                |
+   +------------+-----------------------+-------------------------------------------------------------------+
+   | f_track    | Function pointer      | See section Tracking pipeline output port to physical link.       |
+   +------------+-----------------------+-------------------------------------------------------------------+
    | f_free     | Function pointer      | Function to free the resources allocated by the front-end of      |
    |            |                       | the current pipeline instance.                                    |
    +------------+-----------------------+-------------------------------------------------------------------+