From 7451cccf6dd3bc854c7756208a3e9e55b6deb311 Mon Sep 17 00:00:00 2001
From: Hans-Peter Deifel <hans-peter.deifel@fau.de>
Date: Thu, 23 Mar 2017 11:18:49 +0100
Subject: [PATCH] Add comment on purpose of glpk_stub to various files

---
 _oasis              | 3 ++-
 src/lib/glpk.ml     | 5 ++++-
 src/lib/glpk.mli    | 5 ++++-
 src/lib/glpk_stub.c | 6 ++++++
 4 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/_oasis b/_oasis
index 7e6f9aa..ff624cd 100644
--- a/_oasis
+++ b/_oasis
@@ -24,7 +24,8 @@ Library libcool
   NativeOpt:        -cc g++
   ByteOpt:        -cc g++
   CCOpt: -std=c++98 -x c++
-  # TODO: activate glpk_stub.c again
+  # glpk_stub is not included here, because it's not being used by
+  # any code right now. Add it back if you need it.
   CSources:         minisat_stub.c
   InternalModules:  ALCFormula, ALCGraph, ALCMisc, CoAlgLogicUtils,
                     CoAlgLogics, HashConsing, MiscSolver, AltGenlex,
diff --git a/src/lib/glpk.ml b/src/lib/glpk.ml
index c12fa05..5782c36 100644
--- a/src/lib/glpk.ml
+++ b/src/lib/glpk.ml
@@ -18,7 +18,10 @@
  * Boston, MA 02111-1307, USA.
  *)
 
-(* $Id$ *)
+(******************************************************************************)
+(* This is currently not used by COOL, but left here in case someone needs it *)
+(* in the future.                                                             *)
+(******************************************************************************)
 
 type lp
 
diff --git a/src/lib/glpk.mli b/src/lib/glpk.mli
index 7cb4392..76f4a82 100644
--- a/src/lib/glpk.mli
+++ b/src/lib/glpk.mli
@@ -8,7 +8,10 @@
   *)
 
 
-(* $Id$ *)
+(******************************************************************************)
+(* This is currently not used by COOL, but left here in case someone needs it *)
+(* in the future.                                                             *)
+(******************************************************************************)
 
 
 (** {1 Types} *) (* TODO: better comment! *)
diff --git a/src/lib/glpk_stub.c b/src/lib/glpk_stub.c
index 82075ad..d4514af 100644
--- a/src/lib/glpk_stub.c
+++ b/src/lib/glpk_stub.c
@@ -18,6 +18,12 @@
  * Boston, MA 02111-1307, USA.
  */
 
+
+/******************************************************************************
+ * This is currently not used by COOL, but left here in case someone needs it *
+ * in the future.                                                             *
+ ******************************************************************************/
+
 #include <caml/alloc.h>
 #include <caml/callback.h>
 #include <caml/custom.h>
-- 
GitLab