[doc] Fix comment in FindForkInGlobalIndex

jamesob · jamesob · commit 0ef7b403d0a2 · 2018-04-11T15:56:37.000-04:00
The comment erroneously implies that we're searching `chainActive` for the
first block common to `locator`, but we're using the parameter `chain`.
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -263,7 +263,8 @@ CBlockIndex* FindForkInGlobalIndex(const CChain& chain, const CBlockLocator& loc
 {
     AssertLockHeld(cs_main);
 
-    // Find the first block the caller has in the main chain
+    // Find the latest block common to locator and chain - we expect that
+    // locator.vHave is sorted descending by height.
     for (const uint256& hash : locator.vHave) {
         CBlockIndex* pindex = LookupBlockIndex(hash);
         if (pindex) {

Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,8 @@ CBlockIndex* FindForkInGlobalIndex(const CChain& chain, const CBlockLocator& loc`
`263`	`263`	`{`
`264`	`264`	`AssertLockHeld(cs_main);`
`265`	`265`
`266`		`- // Find the first block the caller has in the main chain`
	`266`	`+ // Find the latest block common to locator and chain - we expect that`
	`267`	`+ // locator.vHave is sorted descending by height.`
`267`	`268`	`for (const uint256& hash : locator.vHave) {`
`268`	`269`	`CBlockIndex* pindex = LookupBlockIndex(hash);`
`269`	`270`	`if (pindex) {`