From: Davin McCall <davmac@davmac.org>
Date: Mon, 15 Jan 2018 21:18:57 +0000 (+0000)
Subject: baseproc-sys.h: Add explanatory comment.
X-Git-Tag: v0.08~33
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=b41d4ac7932576bab95637a4948d795234f7d8b8;p=oweals%2Fdinit.git

baseproc-sys.h: Add explanatory comment.
---

diff --git a/src/includes/baseproc-sys.h b/src/includes/baseproc-sys.h
index e410ebe..217c8ca 100644
--- a/src/includes/baseproc-sys.h
+++ b/src/includes/baseproc-sys.h
@@ -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;