[doc] GetBestBlock() doesn't do nothing

glozow · glozow · commit 2f8272c2a4b6 · 2021-04-01T08:33:11.000-07:00
This has tripped people up multiple times because it looks like
GetBestBlock is a const function returning the value of hashBlock.
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -690,7 +690,8 @@ bool MemPoolAccept::PreChecks(ATMPArgs& args, Workspace& ws)
         }
     }
 
-    // Bring the best block into scope
+    // This is const, but calls into the back end CoinsViews. The CCoinsViewDB at the bottom of the
+    // hierarchy brings the best block into scope. See CCoinsViewDB::GetBestBlock().
     m_view.GetBestBlock();
 
     // we have all inputs cached now, so switch back to dummy (to protect

Original file line number	Diff line number	Diff line change
`@@ -690,7 +690,8 @@ bool MemPoolAccept::PreChecks(ATMPArgs& args, Workspace& ws)`
`690`	`690`	`}`
`691`	`691`	`}`
`692`	`692`
`693`		`- // Bring the best block into scope`
	`693`	`+ // This is const, but calls into the back end CoinsViews. The CCoinsViewDB at the bottom of the`
	`694`	`+ // hierarchy brings the best block into scope. See CCoinsViewDB::GetBestBlock().`
`694`	`695`	`m_view.GetBestBlock();`
`695`	`696`
`696`	`697`	`// we have all inputs cached now, so switch back to dummy (to protect`