sink.ctf.fs: add more comments in code where it's not straightforward

[babeltrace.git] / plugins / ctf / fs-sink / fs-sink.h

diff --git a/plugins/ctf/fs-sink/fs-sink.h b/plugins/ctf/fs-sink/fs-sink.h
index a41052c2e6c04d39a00fe679166d2d08678fb7a2..c9b94ae3814485ea08f4f0e40e4f609e8583b733 100644 (file)
--- a/plugins/ctf/fs-sink/fs-sink.h
+++ b/plugins/ctf/fs-sink/fs-sink.h
@@ -37,9 +37,24 @@ struct fs_sink_comp {
        /* Base output directory path */
        GString *output_dir_path;
 
+       /*
+        * True if the component assumes that it will only write a
+        * single CTF trace (which can contain one or more data
+        * streams). This makes the component write the stream files
+        * directly in the output directory (`output_dir_path` above).
+        */
        bool assume_single_trace;
+
+       /* True to completely ignore discarded events messages */
        bool ignore_discarded_events;
+
+       /* True to completely ignore discarded packets messages */
        bool ignore_discarded_packets;
+
+       /*
+        * True to make the component quiet (nothing printed to the
+        * standard output).
+        */
        bool quiet;
 
        /*