lib: rename include dir to babeltrace2
[babeltrace.git] / doc / man / babeltrace-sink.utils.dummy.7.txt
CommitLineData
0659f3af
PP
1babeltrace-sink.utils.dummy(7)
2==============================
3:manpagetype: component class
4:revdate: 5 October 2017
5
6
7NAME
8----
9babeltrace-sink.utils.dummy - Babeltrace's dummy sink component class
10
11
12DESCRIPTION
13-----------
14The Babeltrace compcls:sink.utils.dummy component class, provided by the
15man:babeltrace-plugin-utils(7) plugin, once instantiated, receives
16notifications from its input port and discards them (does absolutely
17nothing with them).
18
19A compcls:sink.utils.dummy sink component can be useful to run a trace
20processing graph with no sink side effect, for example to perform
21benchmarks. You should prefer this component class for such tasks
22instead of, for example, using a compcls:sink.text.pretty component and
23sending its output to `/dev/null`, as a compcls:sink.text.pretty
24component still performs pretty-printing operations.
25
26
27INITIALIZATION PARAMETERS
28-------------------------
29This component class has no initialization parameters.
30
31
32PORTS
33-----
34Input
35~~~~~
36`in`::
37 Single input port from which the component receives the
38 notifications to discard.
39
40
41QUERY OBJECTS
42-------------
43This component class has no objects to query.
44
45
46ENVIRONMENT VARIABLES
47---------------------
48include::common-common-compat-env.txt[]
49
50
51include::common-footer.txt[]
52
53
54SEE ALSO
55--------
56man:babeltrace-plugin-utils(7),
57man:babeltrace-intro(7)
This page took 0.028939 seconds and 4 git commands to generate.