doc: use code snippets in sample app guides
authorConor Fogarty <conor.fogarty@intel.com>
Fri, 16 Jul 2021 13:57:52 +0000 (13:57 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Sat, 31 Jul 2021 13:42:43 +0000 (15:42 +0200)
commit9a212dc06c7aaf09b146d9c3dcfd584d741634c1
treee349ce037d409524b2465f8dc96057ff859ddd5e
parentb5886e64fc3a597771d4b6cfd0c9326b895bb22b
doc: use code snippets in sample app guides

Currently the sample app user guides use hard coded code snippets,
this patch changes these to use literalinclude which will dynamically
update the snippets as changes are made to the code.
This was introduced in commit 413c75c33c40 ("doc: show how to include
code in guides"). Comments within the sample apps were updated to
accommodate this as part of this patch. This will help to ensure that
the code within the sample app user guides is up to date and not out
of sync with the actual code.

Signed-off-by: Conor Fogarty <conor.fogarty@intel.com>
Signed-off-by: Conor Walsh <conor.walsh@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
70 files changed:
doc/guides/sample_app_ug/cmd_line.rst
doc/guides/sample_app_ug/flow_classify.rst
doc/guides/sample_app_ug/flow_filtering.rst
doc/guides/sample_app_ug/hello_world.rst
doc/guides/sample_app_ug/ioat.rst
doc/guides/sample_app_ug/ip_frag.rst
doc/guides/sample_app_ug/ip_reassembly.rst
doc/guides/sample_app_ug/ipv4_multicast.rst
doc/guides/sample_app_ug/keep_alive.rst
doc/guides/sample_app_ug/l2_forward_cat.rst
doc/guides/sample_app_ug/l2_forward_crypto.rst
doc/guides/sample_app_ug/l2_forward_event.rst
doc/guides/sample_app_ug/l2_forward_job_stats.rst
doc/guides/sample_app_ug/l2_forward_real_virtual.rst
doc/guides/sample_app_ug/l3_forward.rst
doc/guides/sample_app_ug/l3_forward_graph.rst
doc/guides/sample_app_ug/l3_forward_power_man.rst
doc/guides/sample_app_ug/link_status_intr.rst
doc/guides/sample_app_ug/multi_process.rst
doc/guides/sample_app_ug/ptpclient.rst
doc/guides/sample_app_ug/qos_metering.rst
doc/guides/sample_app_ug/qos_scheduler.rst
doc/guides/sample_app_ug/rxtx_callbacks.rst
doc/guides/sample_app_ug/server_node_efd.rst
doc/guides/sample_app_ug/service_cores.rst
doc/guides/sample_app_ug/skeleton.rst
doc/guides/sample_app_ug/timer.rst
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
doc/guides/sample_app_ug/vmdq_forwarding.rst
examples/cmdline/commands.c
examples/cmdline/main.c
examples/flow_classify/flow_classify.c
examples/flow_filtering/flow_blocks.c
examples/flow_filtering/main.c
examples/helloworld/main.c
examples/ioat/ioatfwd.c
examples/ip_fragmentation/main.c
examples/ip_reassembly/main.c
examples/ipv4_multicast/main.c
examples/l2fwd-cat/l2fwd-cat.c
examples/l2fwd-crypto/main.c
examples/l2fwd-event/l2fwd_common.c
examples/l2fwd-event/l2fwd_event.c
examples/l2fwd-event/l2fwd_event_generic.c
examples/l2fwd-event/l2fwd_event_internal_port.c
examples/l2fwd-event/l2fwd_poll.c
examples/l2fwd-event/main.c
examples/l2fwd-jobstats/main.c
examples/l2fwd-keepalive/main.c
examples/l2fwd/main.c
examples/l3fwd-graph/main.c
examples/l3fwd-power/main.c
examples/l3fwd/l3fwd_em.c
examples/l3fwd/l3fwd_fib.c
examples/l3fwd/l3fwd_lpm.c
examples/link_status_interrupt/main.c
examples/multi_process/simple_mp/main.c
examples/multi_process/symmetric_mp/main.c
examples/ptpclient/ptpclient.c
examples/qos_meter/main.c
examples/qos_meter/main.h
examples/rxtx_callbacks/main.c
examples/server_node_efd/node/node.c
examples/server_node_efd/server/init.c
examples/server_node_efd/server/main.c
examples/service_cores/main.c
examples/skeleton/basicfwd.c
examples/timer/main.c
examples/vmdq/main.c
examples/vmdq_dcb/main.c