From: Joel Rosdahl <joel@rosdahl.net>
Date: Wed, 7 Oct 2020 19:07:59 +0000 (+0200)
Subject: Add comments for Result::FileType values
X-Git-Tag: v4.0~24
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4dc0827d42226e42187e018e1d408e60e8ca2c82;p=thirdparty%2Fccache.git

Add comments for Result::FileType values
---

diff --git a/src/Result.hpp b/src/Result.hpp
index e8e6f97a8..130c32420 100644
--- a/src/Result.hpp
+++ b/src/Result.hpp
@@ -43,12 +43,28 @@ enum class FileType : UnderlyingFileTypeInt {
   // These values are written into the cache result file. This means they must
   // never be changed or removed unless the result file version is incremented.
   // Adding new values is OK.
+
+  // The main output specified with -o or implicitly from the input filename.
   object = 0,
+
+  // Dependency file specified with -MF or implicitly from the output filename.
   dependency = 1,
+
+  // Text sent to standard output.
   stderr_output = 2,
+
+  // Coverage notes file generated by -ftest-coverage.
   coverage = 3,
+
+  // Stack usage file generated by -fstack-usage, i.e. output file but with a
+  // .su extension.
   stackusage = 4,
+
+  // Diagnostics output file specified by --serialize-diagnostics.
   diagnostic = 5,
+
+  // DWARF object file geenrated by -gsplit-dwarf, i.e. output file but with a
+  // .dwo extension.
   dwarf_object = 6,
 };