Update siUpdate/ScopeInfo header comments
authorBrian Bohe <brianbohe@gmail.com>
Tue, 26 Feb 2019 19:43:43 +0000 (11:43 -0800)
committerBrian Bohe <brianbohe@gmail.com>
Tue, 26 Feb 2019 19:43:43 +0000 (11:43 -0800)
src/jit/codegen.h
src/jit/scopeinfo.cpp

index b0534c0..30e9785 100644 (file)
@@ -592,7 +592,7 @@ public:
     void siBeginBlock(BasicBlock* block);
 
     void siEndBlock(BasicBlock* block);
-
+    // Closes the "ScopeInfo" of the tracked variables that has become dead.
     virtual void siUpdate();
 
     void siCheckVarScope(unsigned varNum, IL_OFFSET offs);
index 51f231e..19aa542 100644 (file)
@@ -44,7 +44,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  *  Also,
  *  o At every assignment to a variable, siCheckVarScope() adds an open scope
  *    for the variable being assigned to.
- *  o genChangeLife() calls siUpdate() which closes scopes for variables which
+ *  o UpdateLifeVar() calls siUpdate() which closes scopes for variables which
  *    are not live anymore.
  *
  ******************************************************************************
@@ -918,15 +918,15 @@ void CodeGen::siEndBlock(BasicBlock* block)
 #endif
 }
 
-/*****************************************************************************
- *                          siUpdate
- *
- * Called at the start of basic blocks, and during code-gen of a block,
- * for non-debuggable code, whenever the life of any tracked variable changes
- * and the appropriate code has been generated. For debuggable code, variables are
- * live over their entire scope, and so they go live or dead only on
- * block boundaries.
- */
+//------------------------------------------------------------------------
+// siUpdate: Closes the "ScopeInfo" of the tracked variables that has become dead.
+//
+// Notes:
+//    Called at the start of basic blocks, and during code-gen of a block,
+//    for non-debuggable code, whenever the life of any tracked variable changes
+//    and the appropriate code has been generated. For debuggable code, variables are
+//    live over their entire scope, and so they go live or dead only on
+//    block boundaries.
 void CodeGen::siUpdate()
 {
     if (!compiler->opts.compScopeInfo)