Misleading comments of SplitBlockAndInsertIfThenElse in BasicBlockUtils.h

[• jery]

Summary

The comments of SplitBlockAndInsertIfThenElse say the SplitBefore instruction will stay in the old block.
But according to the implementation(split the block at SplitBefore by using splitBasicBlock), the SplitBefore will be moved to the new block.

This patch fixes the comments.

[• jery]

Ping.

[eugenis]

LGTM

[• jery]

Thanks for help.
Since I'm new in llvm community, I don't have write access to svn.
Could you help me commit this patch ?

Thanks again.

[eugenis]

r281939
I've also removed the ALL CAPS before committing.

include/llvm/Transforms/Utils/BasicBlockUtils.h

 
 /// This method duplicates the specified return instruction into a predecessor
 /// which ends in an unconditional branch. If the return instruction returns a
 /// value defined by a PHI, propagate the right value into the return. It
 /// returns the new return instruction in the predecessor.
 ReturnInst *FoldReturnIntoUncondBranch(ReturnInst *RI, BasicBlock *BB,
                                        BasicBlock *Pred);
 
-/// Split the containing block at the specified instruction - everything before
-/// and including SplitBefore stays in the old basic block, and everything after
-/// SplitBefore is moved to a new block. The two blocks are connected by a
+/// Split the containing block at the specified instruction - everything BEFORE
+/// SplitBefore stays in the old basic block, and the rest of the instructions
+/// in the BB are moved to a new block. The two blocks are connected by a
 /// conditional branch (with value of Cmp being the condition).
 /// Before:
 ///   Head
 ///   SplitBefore
 ///   Tail
 /// After:
 ///   Head
 ///   if (Cond)