baseproc-sys.h: Add explanatory comment.
authorDavin McCall <davmac@davmac.org>
Mon, 15 Jan 2018 21:18:57 +0000 (21:18 +0000)
committerDavin McCall <davmac@davmac.org>
Mon, 15 Jan 2018 21:18:57 +0000 (21:18 +0000)
src/includes/baseproc-sys.h

index e410ebe4436fcac4e2ea6b422b55a8cb61878193..217c8ca9bd5ebe2ac8591b3bb76debd8e33aae84 100644 (file)
@@ -1,3 +1,10 @@
+/*
+ * This header implements a namespace, bp_sys, which wraps various system calls used by baseproc-service.cc.
+ *
+ * When running tests, another header is substituted in place of this one. The substitute provides mocks/stubs
+ * for the functions, to avoid calling the real functions and thus allow for unit-level testing.
+ */
+
 namespace bp_sys {
 
 using dasynq::pipe2;