From 7baf7947610e14f7b705ecd85556ed1baa2aedc8 Mon Sep 17 00:00:00 2001
From: Richard Brooksby <rb@ravenbrook.com>
Date: Tue, 25 Sep 2012 23:46:28 +0100
Subject: [PATCH] Converting more "@@@@" markers to notes or action-oriented
 todos.

Copied from Perforce
 Change: 179692
 ServerID: perforce.ravenbrook.com
---
 mps/code/pool.c    | 2 +-
 mps/code/poolamc.c | 8 +++++---
 mps/code/poolmv.c  | 2 +-
 mps/code/pooln.c   | 2 +-
 4 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/mps/code/pool.c b/mps/code/pool.c
index a88cf48e97c..315bbac4fb2 100644
--- a/mps/code/pool.c
+++ b/mps/code/pool.c
@@ -139,7 +139,7 @@ Res PoolInitV(Pool pool, Arena arena, PoolClass class, va_list args)
     /* putting another lock in the code. */
     class->labelled = TRUE;
     classId = EventInternString(class->name);
-    /* @@@@ this breaks <design/type/#addr.use> */
+    /* NOTE: this breaks <design/type/#addr.use> */
     EventLabelAddr((Addr)class, classId);
   }
 
diff --git a/mps/code/poolamc.c b/mps/code/poolamc.c
index 90b33ef8f68..1617c2e4f0a 100644
--- a/mps/code/poolamc.c
+++ b/mps/code/poolamc.c
@@ -1444,7 +1444,7 @@ static Res amcScanNailedOnce(Bool *totalReturn, Bool *moreReturn,
   Bool total = TRUE;
   Size bytesScanned = 0;
 
-  EVENT3(AMCScanBegin, amc, seg, ss); /* @@@@ use own event */
+  EVENT3(AMCScanBegin, amc, seg, ss); /* TODO: consider using own event */
 
   format = pool->format;
   amcSegNailboard(seg)->newMarks = FALSE;
@@ -1499,7 +1499,7 @@ static Res amcScanNailedOnce(Bool *totalReturn, Bool *moreReturn,
   AVER(p == limit);
 
 returnGood:
-  EVENT3(AMCScanEnd, amc, seg, ss); /* @@@@ use own event */
+  EVENT3(AMCScanEnd, amc, seg, ss); /* TODO: consider using own event */
 
   AVER(bytesScanned <= SegSize(seg));
   ss->scannedSize += bytesScanned;
@@ -1707,7 +1707,9 @@ static Res AMCFixEmergency(Pool pool, ScanState ss, Seg seg,
   ShieldCover(arena, seg);
   if(newRef != (Addr)0) {
     /* Object has been forwarded already, so snap-out pointer. */
-    /* Useful weak pointer semantics not implemented. @@@@ */
+    /* TODO: Implement weak pointer semantics in emergency fixing.  This
+       would be a good idea since we really want to reclaim as much as
+       possible in an emergency. */
     *refIO = newRef;
     return ResOK;
   }
diff --git a/mps/code/poolmv.c b/mps/code/poolmv.c
index 91740271dd0..a645eb4d235 100644
--- a/mps/code/poolmv.c
+++ b/mps/code/poolmv.c
@@ -859,7 +859,7 @@ Bool MVCheck(MV mv)
   CHECKL(mv->extendBy > 0);
   CHECKL(mv->avgSize > 0);
   CHECKL(mv->extendBy >= mv->avgSize);
-  /* @@@@ Could do more checks here. */
+  /* TODO: More checks are possible.  Consider what else could be checked. */
   return TRUE;
 }
 
diff --git a/mps/code/pooln.c b/mps/code/pooln.c
index a22d81c23a2..dcd59f65df5 100644
--- a/mps/code/pooln.c
+++ b/mps/code/pooln.c
@@ -141,7 +141,7 @@ static Res NDescribe(Pool pool, mps_lib_FILE *stream)
   poolN = PoolPoolN(pool);
   AVERT(PoolN, poolN);
 
-  UNUSED(stream); /* @@@@ should output something here */
+  UNUSED(stream); /* TODO: should output something here */
 
   return ResOK;
 }