Update manual pages for 2.0.0-rc1

[babeltrace.git] / doc / man / babeltrace2-sink.utils.dummy.7.txt

diff --git a/doc/man/babeltrace2-sink.utils.dummy.7.txt b/doc/man/babeltrace2-sink.utils.dummy.7.txt
index cb4b52db937ef166f814859f16ce48726425d022..5ecf22a345502851ee46fdc31dc1af39aa0e3132 100644 (file)
--- a/doc/man/babeltrace2-sink.utils.dummy.7.txt
+++ b/doc/man/babeltrace2-sink.utils.dummy.7.txt
@@ -1,57 +1,57 @@
-babeltrace2-sink.utils.dummy(7)
-==============================
+= babeltrace2-sink.utils.dummy(7)
 :manpagetype: component class
-:revdate: 5 October 2017
+:revdate: 14 September 2019
 
 
-NAME
-----
-babeltrace2-sink.utils.dummy - Babeltrace's dummy sink component class
+== NAME
 
+babeltrace2-sink.utils.dummy - Babeltrace 2's dummy sink component class
 
-DESCRIPTION
------------
-The Babeltrace compcls:sink.utils.dummy component class, provided by the
-man:babeltrace2-plugin-utils(7) plugin, once instantiated, receives
-notifications from its input port and discards them (does absolutely
-nothing with them).
 
-A compcls:sink.utils.dummy sink component can be useful to run a trace
-processing graph with no sink side effect, for example to perform
-benchmarks. You should prefer this component class for such tasks
-instead of, for example, using a compcls:sink.text.pretty component and
-sending its output to `/dev/null`, as a compcls:sink.text.pretty
-component still performs pretty-printing operations.
+== DESCRIPTION
 
+A Babeltrace~2 compcls:sink.utils.dummy component consumes messages
+and discards them (does absolutely nothing with them).
 
-INITIALIZATION PARAMETERS
--------------------------
-This component class has no initialization parameters.
+----
+            +------------------+
+            | sink.utils.dummy |
+            |                  |
+Messages -->@ in               |
+            +------------------+
+----
 
+include::common-see-babeltrace2-intro.txt[]
 
-PORTS
------
-Input
-~~~~~
-`in`::
-    Single input port from which the component receives the
-    notifications to discard.
+A compcls:sink.utils.dummy sink component can be useful to run a trace
+processing graph with no sink side effect, for example to perform
+benchmarks. Prefer a compcls:sink.utils.dummy component class for such
+tasks to, for example, a compcls:sink.text.pretty component and sending
+its output to `/dev/null`, as a compcls:sink.text.pretty component still
+performs formatting operations.
 
 
-QUERY OBJECTS
--------------
-This component class has no objects to query.
+== PORTS
 
+----
++------------------+
+| sink.utils.dummy |
+|                  |
+@ in               |
++------------------+
+----
 
-ENVIRONMENT VARIABLES
----------------------
-include::common-common-compat-env.txt[]
+
+=== Input
+
+`in`::
+    Single input port.
 
 
 include::common-footer.txt[]
 
 
-SEE ALSO
---------
-man:babeltrace2-plugin-utils(7),
-man:babeltrace2-intro(7)
+== SEE ALSO
+
+man:babeltrace2-intro(7),
+man:babeltrace2-plugin-utils(7)