Comments HEAD master

1 files changed, 8 insertions, 0 deletions

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)						\