From 701eb332bd1a3a4196050aa78ee90521279349cb Mon Sep 17 00:00:00 2001
From: Qyriad <qyriad@qyriad.me>
Date: Thu, 20 Jun 2024 18:00:25 -0600
Subject: [PATCH] doc-comment Fields for Activity and Result types

The ones we were able to figure out, at least.

Change-Id: I697f4f3942e35a7adf1b2a6cc28b3168d1de111c
---
 src/libutil/logging.hh | 48 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/src/libutil/logging.hh b/src/libutil/logging.hh
index 115b979f8..3cead4296 100644
--- a/src/libutil/logging.hh
+++ b/src/libutil/logging.hh
@@ -14,23 +14,71 @@ typedef enum {
     actRealise = 102,
     actCopyPaths = 103,
     actBuilds = 104,
+
+    /** Fields:
+     * 0: string: path to store derivation being built.
+     * 1: string: representing the machine this is being built on. Empty string if local machine.
+     * 2: int: curRound, not used anymore, always 1?
+     * 3: int: nrRounds, not used anymore always 1?
+     */
     actBuild = 105,
     actOptimiseStore = 106,
     actVerifyPaths = 107,
+
+    /** Fields:
+     * 0: string: store path
+     * 1: string: substituter
+     */
     actSubstitute = 108,
+
+    /** Fields:
+     * 0: string: store path
+     * 1: string: substituter
+     */
     actQueryPathInfo = 109,
+
+    /** Fields:
+     * 0: string: store path
+     */
     actPostBuildHook = 110,
     actBuildWaiting = 111,
 } ActivityType;
 
 typedef enum {
+    /** Fields:
+     * 0: int: bytes linked
+     */
     resFileLinked = 100,
+
+    /** Fields:
+     * 0: string: last line
+     */
     resBuildLogLine = 101,
     resUntrustedPath = 102,
     resCorruptedPath = 103,
+
+    /** Fields:
+     * 0: string: phase name
+     */
     resSetPhase = 104,
+
+    /** Fields:
+     * 0: int: done
+     * 1: int: expected
+     * 2: int: running
+     * 3: int: failed
+     */
     resProgress = 105,
+
+    /** Fields:
+     * 0: int: ActivityType
+     * 1: int: expected
+     */
     resSetExpected = 106,
+
+    /** Fields:
+     * 0: string: last line
+     */
     resPostBuildLogLine = 107,
 } ResultType;