X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Fip_pipeline.rst;h=69af6b8dc4c1f7fe61ffe327930a4149c870cab0;hb=12639dcc05ddf61ad1f2bbad9a5941a75f80ec29;hp=09cbc174d507e830b61acffc072656a43012ea48;hpb=81d084dd2aa831c9c620480f0e42e094d369515e;p=dpdk.git diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst index 09cbc174d5..69af6b8dc4 100644 --- a/doc/guides/sample_app_ug/ip_pipeline.rst +++ b/doc/guides/sample_app_ug/ip_pipeline.rst @@ -1,32 +1,5 @@ -.. BSD LICENSE - Copyright(c) 2015-2016 Intel Corporation. All rights reserved. - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2015-2016 Intel Corporation. Internet Protocol (IP) Pipeline Application =========================================== @@ -233,7 +206,7 @@ The application startup arguments are: * Default: Not present * Argument: Path to the CLI script file to be run by the master pipeline at application startup. - No CLI script file will be run at startup of this argument is not present. + No CLI script file will be run at startup if this argument is not present. ``-p PORT_MASK`` @@ -337,7 +310,7 @@ Generic example of configuration file section: = - ... + ; ... = @@ -876,8 +849,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 +863,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. | +------------+-----------------------+-------------------------------------------------------------------+