1 files changed, 27 insertions, 0 deletions
diff --git a/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst b/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst
new file mode 100755
index 00000000..8d5ad5be
--- /dev/null
+++ b/scripts/automation/trex_control_plane/doc/packet_generator/stream_export.rst
@@ -0,0 +1,27 @@
+
+Stream Export YAML syntax
+=========================
+
+In order to provide a fluent work-flow that utilize the best TRex user's time, an export-import mini language has been created.
+
+This enables a work-flow that supports saving and sharing a built packets and its scenarios, so that other tools
+(such as TRex Console) could use them.
+
+The TRex Packet Builder module supports (using ___ method) the export of built stream according to the format described below.
+
+Guidelines
+----------
+
+1. One
+2. Two
+3. Three
+
+Export Format
+-------------
+
+.. literalinclude:: export_format.yaml
+
+Example
+-------
+
+Whenever TRex is publishing live data, it uses JSON notation to describe the data-object.