From: Martin Taibr <taibr.martin@gmail.com>
Date: Tue, 18 Jul 2017 15:59:37 +0000 (+0200)
Subject: document compilationunits.sh
X-Git-Tag: xonotic-v0.8.5~2561^2
X-Git-Url: https://git.rm.cloudns.org/?a=commitdiff_plain;h=63f34ee151e32cd041437201a6b8fecf8971a928;p=xonotic%2Fxonotic-data.pk3dir.git

document compilationunits.sh
---

diff --git a/qcsrc/tools/compilationunits.sh b/qcsrc/tools/compilationunits.sh
index d8086704e..a43185b16 100755
--- a/qcsrc/tools/compilationunits.sh
+++ b/qcsrc/tools/compilationunits.sh
@@ -2,9 +2,13 @@
 set -eu
 cd ${0%/*}
 
-# if these files exist from previous compilation, `./all compile` will stop
+# This script attempts to build the codebase in every possible header configuration,
+# to check that all files #include what they need, so that we can eventually move away
+# from a unity build and into incremental compilation.
+
+# If these files exist from previous compilation, `./all compile` will stop
 # detecting changes after running this script so delete them to trigger
-# a recompile next time
+# a recompile next time.
 if [ -f ../../csprogs.dat ]; then
     rm ../../csprogs.dat
 fi