From 7f1be7fc3cf51cc7c3b37b88b808c44f2fbf1add Mon Sep 17 00:00:00 2001
From: Pjotr Prins
Date: Thu, 20 Nov 2025 11:05:57 +0100
Subject: Comments

---
 src/checkpoint.h | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/checkpoint.h')

diff --git a/src/checkpoint.h b/src/checkpoint.h
index c2457d9..ae46361 100644
--- a/src/checkpoint.h
+++ b/src/checkpoint.h
@@ -26,6 +26,14 @@ using namespace std;
 
 extern string checkpoint_name;
 
+/*
+    Checkpoint functions display a message in debug mode when
+    reached. If the (unique) msg (tag) is equal to the global
+    checkpoint_name the program will stop. The idea is that we can
+    stop computation at any checkpoint. Later we can write the code to
+    restart at a checkpoint.
+ */
+
 void checkpoint_run(string msg, string filename, string srcfilename, int line, string funcname);
 
 #define checkpoint(msg, fname)						\
-- 
cgit 1.4.1