stateless: replace xstats example image to text
authorYaroslav Brustinov <[email protected]>
Tue, 1 Nov 2016 09:22:51 +0000 (11:22 +0200)
committerYaroslav Brustinov <[email protected]>
Tue, 1 Nov 2016 09:22:51 +0000 (11:22 +0200)
release notes: add "rpc" for developers section

images/xstats_error.png [deleted file]
release_notes.asciidoc
trex_stateless.asciidoc

diff --git a/images/xstats_error.png b/images/xstats_error.png
deleted file mode 100755 (executable)
index 2564664..0000000
Binary files a/images/xstats_error.png and /dev/null differ
index 0dc9dd1..db3338b 100755 (executable)
@@ -28,9 +28,14 @@ endif::backend-docbook[]
 * Added support for IP based configuration files (As opposed to MAC based used until now), with the ability of TRex to send
 ARP requests for default gateway, and gratitues ARP for its own addresses.
 See link:trex_manual.html#_configuration_yaml_parameter_of_cfg_option[here] and link:trex_config_guide.html[here] for details.
-* Add RPC commands to Stateless:
+* Added commands to Stateless client/console:
 ** Getting extended counters of port for improved debug purposes. See example: link:trex_stateless.html#_stats[stats]
 ** Changing of port attributes and getting async feedback on the changed status. See example: link:trex_stateless.html#_portattr[portattr]
+* For developers - added/updated RPC commands (which can be used for GUI etc.):
+** Getting system info added new options, for example description of interface: link:trex_rpc_server_spec.html#_get_system_info[get_system_info]
+** Setting port attributes added new options: link:trex_rpc_server_spec.html#_setting_port_attributes[set_port_attr]
+** Getting xstats names (can be polled once and then combined with updated values): link:trex_rpc_server_spec.html#_get_xstat_names[get_port_xstats_names]
+** Getting xstats values: link:trex_rpc_server_spec.html#_get_xstat_values[get_port_xstats_values]
 
 === fix issues: ===
 
index 1148bc5..419df9b 100755 (executable)
@@ -3892,7 +3892,30 @@ $stats --port 0 -p
 $stats -s
 ----
 
-image::images/xstats_error.png[title="Xstats error example"]
+*Xstats error example*::
+
+[source,bash]
+----
+
+trex>stats -x --port 0 2
+Xstats:
+
+            Name:              |     Port 0:     |     Port 2:
+\------------------------------------------------------------------
+rx_good_packets                |       154612905 |       153744994
+tx_good_packets                |       154612819 |       153745136
+rx_good_bytes                  |      9895225920 |      9839679168
+tx_good_bytes                  |      9276768500 |      9224707392
+rx_unicast_packets             |       154611873 |       153743952
+rx_unknown_protocol_packets    |       154611896 |       153743991
+tx_unicast_packets             |       154612229 |       153744562
+mac_remote_errors              |               1 |               0 #<1>
+rx_size_64_packets             |       154612170 |       153744295
+tx_size_64_packets             |       154612595 |       153744902
+
+----
+
+<1> Error that can be seen only with this command
 
 // IGNORE - this line helps rendering