Add documentation

opencog · Mar 30, 2024 · 08b21ed · 08b21ed
1 parent 1df732d
commit 08b21ed
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/opencog/persist/rocks/RocksDAG.cc b/opencog/persist/rocks/RocksDAG.cc
@@ -213,7 +213,7 @@ HandleSeq RocksStorage::loadFrameDAG(void)
 	return tops;
 }
 
-/// Load the entire collection of AtomSpace frames.
+/// Store the entire collection of AtomSpace frames.
 void RocksStorage::storeFrameDAG(AtomSpace* top)
 {
 	CHECK_OPEN;

diff --git a/opencog/persist/rocks/RocksFrame.cc b/opencog/persist/rocks/RocksFrame.cc
@@ -110,6 +110,10 @@ void RocksStorage::deleteFrame(AtomSpace* frame)
 
 // ======================================================================
 
+// If the existing open database is not in multi-space format, then
+// convert it to the multi-space format. This requires looping over
+// all keys in the database, and changing their format: the key
+// indexes must now include an ID of which AtomSpace they belong to.
 void RocksStorage::convertForFrames(const Handle& top)
 {
 	if (_multi_space) return;