Merge #12951: [doc] Fix comment in FindForkInGlobalIndex

laanwj · laanwj · commit 6df0c6cb4169 · 2018-04-16T08:38:28.000+02:00
0ef7b40 [doc] Fix comment in FindForkInGlobalIndex (James O'Beirne) Pull request description: The comment erroneously implies that we're searching `chainActive` for the first block common to `locator`, but we're using the parameter `chain`. Tree-SHA512: 42ba0fb378597820bdf1eaff1e3e284097baa312e7dd8448421c8c71aa91c353ea6c840860afcb7725f392431f3134d4feb271b96ab7058a62f84f48e468e714
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -264,7 +264,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
`@@ -264,7 +264,8 @@ CBlockIndex* FindForkInGlobalIndex(const CChain& chain, const CBlockLocator& loc`
`264`	`264`	`{`
`265`	`265`	`AssertLockHeld(cs_main);`
`266`	`266`
`267`		`- // Find the first block the caller has in the main chain`
	`267`	`+ // Find the latest block common to locator and chain - we expect that`
	`268`	`+ // locator.vHave is sorted descending by height.`
`268`	`269`	`for (const uint256& hash : locator.vHave) {`
`269`	`270`	`CBlockIndex* pindex = LookupBlockIndex(hash);`
`270`	`271`	`if (pindex) {`