Chapter 4. Branching and Integration
In the course of software development, we branch files to do concurrent, parallel work on them, and we integrate files to combine the results of such work. In this chapter, we’ll look at how to do branching and integration with Perforce.
This chapter won’t dwell on reasons to branch, what to branch, or how to work with different kinds of branches, Not that those things aren’t important—they are, and they’ll be given due consideration in Part II. But for now, we’ll limit our discussion to the mechanics of branching and integrating.
The Classic Case for A Branch
Of all the uses for branching , the one best understood is that of branching recently developed software for a product release. For example, assume that we are Ace Engineering and that we’ve been working on a software product called Ace. We’re gearing up to make the first release of Ace available. Our plan is to release Ace Version 1.0 while simultaneously developing new features for a future release. For this, we’re going to have to make a branch.
So far, there’s one tree of files that constitutes the Ace product. It’s in the //Ace/MAIN directory path of our depot. Until now, we’ve all worked together on the files in the //Ace/MAIN tree, shown in Figure 4-1.
With Perforce, we can simply clone the //Ace/MAIN file tree into a new //Ace/V1 file tree. This allows us to continue working on new features in the //Ace/MAIN tree. Meanwhile, those of us testing and stabilizing the 1.0 release can work in the //Ace/V1 tree. The two file trees are shown in Figure 4-2.
At the outset, every file in the //Ace/MAIN tree has an identical counterpart in the //Ace/V1 tree. Over time, content diverges between the two trees as new development proceeds. The //Ace/V1 tree holds the stable, 1.0 version of the product, and the //Ace/MAIN tree holds the bleeding-edge, unreleased version.
This notion of cloning a tree of files from another is the essence of branching in Perforce. We clone a tree of files so that we can make changes to either tree—or branch—without affecting the other. The two file trees are peers in the depot hierarchy. Moreover, every file is a full-fledged file in its own right. Files in either branch can be edited, added, deleted, renamed, or moved. And changes made in one branch can be merged or otherwise integrated to the other.
Behind the scenes, Perforce keeps track of branching. Although every branched file is a file in its own right, its lineage is stored in the Perforce database. Perforce keeps track of a file’s integration history as well. As we successively integrate changes between a pair of branches, Perforce uses file history to keep us from having to re-merge changes we’ve already merged.
Even more important is that Perforce can tell us the integration history of a branch. Given a pair of branches, Perforce can tell us which changes have already been integrated from one into the other, and which have yet to be integrated.
If all this were as simple it sounds, you wouldn’t need this book. Many branch and integration operations in Perforce are quite simple, of course, but some of the simplest ones are a bit unintuitive and one or two of the essential ones just aren’t that simple. The goal of this chapter is to front-load you with knowledge to keep you from making the common mistakes the first time out. And if it’s too late for that, this chapter will at least help you understand your prior missteps.
We’ll use the classic branch-for-release use case throughout this chapter to demonstrate Perforce commands and their consequences. However, the classic case is certainly not the only use to which Perforce branching can be applied. Later in this book, you’ll see how Perforce branching can be used to configure products, distribute software, trace object origins, and shepherd web content, among other things.
Creating Branches
As with all operations that affect depot files, creating a branch is a two-step process in Perforce. First you use integrate to open files for branching , then you use submit to make them appear in the depot.[*]
Opening files for branching
So, back to our Ace example. We can think of the evolution of //Ace/MAIN as a single timeline, punctuated by submitted changelists. (see Figure 4-3.)
Now it’s time to branch //Ace/MAIN into //Ace/V1. (We’ll call these branches MAIN and V1, for short. See Figure 4-4.)
Making the branch is simply a matter of using integrate to clone one directory from another:
p4 integ //Ace/MAIN/... //Ace/V1/...
//Ace/V1/db/Jamfile#1 - branch/sync from //Ace/MAIN/db/Jamfile#1,#32
//Ace/V1/db/dbAcc.cpp#1 - branch/sync from //Ace/MAIN/db/dbAcc.cpp#1,#3
//Ace/V1/db/dbDefN.cpp#1 - branch/sync from //Ace/MAIN/db/dbDefN.cpp#1,#7
...(What’s integ? An alias of integrate.) The integrate command takes two filespecs as arguments.[*] The first identifies the donor files and the second identifies like-named target files—the files that will be created, in this case.
Tip
Whether it’s used to branch, rename, or integrate files, the higher calling of integrate is to propagate change. Change comes from “donor files” and flows to “target files.” Thus the integrate command always involves a pair of filespecs, one being the donor and the other the target.
As you can see, every file in MAIN is branched to a corresponding file in V1. For example, donor file //Ace/MAIN/db/Jamfile#32 is branched to target //Ace/V1/db/Jamfile#1. From integrate’s output, we can infer that #32 is the head revision of the donor. The message branch/sync ... Jamfile#1,#32 lets us know that revisions #1 through #32 of the donor are going on record as having been integrated into revision #1 of the target.
Perforce bootstraps the new branch by copying donor files from the depot into target files in your workspace. (That’s what the branch/sync messages in the output of integrate mean.)
Tip
The target files, even though they don’t exist yet in your workspace or in the depot, must be mapped in your workspace client view. The donor files need not be. This is commonly misunderstood.[*]
For example, to run:
p4 integ //Ace/MAIN/... //Ace/V1/...you must have a client view that encompasses the //Ace/V1 files. But it doesn’t matter whether your view encompasses the //Ace/MAIN files.
Chapter 2 showed how to configure client views. We’ll see many more examples in this chapter and in the chapters that follow.
Branching from a point in time
The integrate command normally branches each donor file from its head revision. In other words, it branches from the current point in time. (Figure 4-5.)
You can make integrate branch from a previous point in time by providing a revision in the donor filespec. For example, to branch MAIN from its 12 October 2004 state, you could use:
p4 integ //Ace/MAIN/...@2004/10/12 //Ace/V1/...As far as depot evolution is concerned, changelist numbers are points in time. So you could just as well use a changelist number as a branch point. For example:
p4 integ //Ace/MAIN/...@3109 //Ace/V1/...Figure 4-6 illustrates the result in either case.
Perforce is usually quite happy to let you run any integrate command you want. Before running an actual integrate, you can run it with -n to see a preview of what it will do. For example:
p4 integ -n //Ace/MAIN/... //Ace/V1/...The preview output, which is almost identical to the actual output, will help you assure that:
You aren’t branching more or fewer files than you expected.
You’re branching files into the correct paths. (And that you’ve spelled the new pathname correctly!)
All of the target files are in your client view.
You have permission for the operation.
Oops, I branched the wrong files!
Even if you’ve already run the integrate command, you always have the option of reverting files instead of submitting them. For example:
p4 revert //Ace/V1/...removes the newly branched //Ace/V1 files from your workspace and takes them off your pending changelist.
It’s not a branch until the files are submitted
Like other Perforce commands that work on files, integrate doesn’t actually affect the depot. Instead, it simply opens files to be branched. The new branch doesn’t appear in the depot until you’ve submitted the files:
p4 submit //Ace/V1/...
...
Change 3372 submitted.In the timeline of the new branch, the changelist you submitted is the first event, as shown in Figure 4-7.
Can you undo and redo a branch?
Once you’ve submitted branched files, they’re a permanent part of depot history. In other words, you can’t undo a branch. However, you can effectively redo a branch, in a way that satisfies most of the reasons you’d want to:
- Wrong files branched
For example, you branched files from //Ace/MAIN/... into //Ace/V1-R1.0/... when you meant to branch from //Ace/V1/.... To fix the problem, delete the branched files, then branch the correct files:
p4 delete //Ace/V1-R1.0/... p4 submit p4 integ -d //Ace/V1/... //Ace/V1-R1.0/... p4 submit(The -d option tells Perforce to go ahead and branch new files on top of deleted ones.)
- Files branched to wrong place
If you’ve branched files into the wrong place, delete the branched files and rebranch the files to the right place.
- Branch not needed
If it turns out the branch wasn’t need, after all, delete the branched files.
Creating really huge branches
You may think it heavy-handed that Perforce copies files into your workspace when all you’re trying to do is create a new branch in the depot. Perforce does this as a convenience to you. It assumes that if you are creating a new branch, you’re going to want to work on the newly branched files.
However, if you’re branching a really huge tree of files, a copy of the whole thing in your workspace may be the last thing you want. You can, at your optionally skip the workspace copying. The -v flag on integ does that:
p4 integ -v //Ace/MAIN/... //Ace/V1/...
//Ace/V1/db/Jamfile#1 - branch from //Ace/MAIN/db/Jamfile#1,#32
//Ace/V1/db/dbAcc.cpp#1 - branch from //Ace/MAIN/db/dbAcc.cpp#1,#3
//Ace/V1/db/dbDefN.cpp#1 - branch from //Ace/MAIN/db/dbDefN.cpp#1,#7
etc.(The -v is for virtual as opposed to real files in your workspace.) When you use integ -v, you’ll still need the target path in your client view, you’ll still have files open for branching, and you’ll still have to submit a changelist. But the branched files themselves won’t appear in your workspace. If you do want them in your workspace, you’ll have to synchronize with them after submitting them.
Working in a New Branch
People can begin working in a new branch as soon as you submit the branched files. Working in a new branch is the same as working with files in any depot path. All that’s needed is a workspace with a client view that includes the new branch.
For example, if Bill wants to configure his Bill-V1 workspace for working in the new V1 branch, he can set up this client view:
p4 client Bill-V1
Client Bill-V1
Root c:\ws-v1
View //Ace/V1/... //Bill-V1/...The P4V screenshot in Figure 4-8 shows the scope of the Bill-V1 workspace.
You don’t have to have the whole branch in your client view, of course. In fact, you can even mix and match branch subdirectories in your workspace. Ann, for example, is doing some analysis that requires her to have the db subdirectories from both branches, MAIN and V1, in her workspace. She has her client view set up like this:
p4 client Ann-DBwork
Client Ann-DBwork
Root /usr/team/ann/dbtests
View //Ace/MAIN/db/... //Ann-DBwork/MAIN/db/...
//Ace/V1/db/... //Ann-DBwork/V1/db/...The Ann-DBwork workspace’s client view is shown in Figure 4-9.
Browsing branch history
You can use the changes command to display the history of a branch. For example:
p4 changes //Ace/V1/...
Change 3459 on 2004/10/05 by pete 'Fix titles of...'
Change 3456 on 2004/10/04 by rob 'Delete junk files...'
Change 3372 on 2004/10/04 by bill 'Branch V1...'P4V can show you the history of a branch with its Folder History command.
Comparing branches
You can use diff2 to compare branches. It lists and diffs the files that are no longer identical:
p4 diff2 -q //Ace/MAIN/... //Ace/V1/...
= == = //Ace/MAIN/doc/Jamfile/#7 - //Ace/V1/doc/Jamfile#4 = == = (content)
= == = //Ace/MAIN/doc/index.html#1 - <none> = == =
= == = //Ace/MAIN/utils/readme#8 - <none> = == =
(The -q option suppresses the actual diffs.)
In P4V you can use Tools → Diff files to bring up an expanding, side-by-side comparison of the two branches. Figure 4-10 shows an example.
Integrating Changes from Branch to Branch
So, Ace Engineering now has two branches, V1 and MAIN. New development continues in MAIN as bugs are fixed and last-minute changes are submitted in V1. When and why to integrate are topics we’ll discuss later in the book. For now, we’ll focus on how it’s done. In this case, let’s assume we’re interested in integrating V1’s changes into MAIN.
Which Changes Need Integrating?
The changes command tells us how the V1 branch has evolved:
p4 changes //Ace/V1/...
Change 3470 on 2004/10/05 by rob 'New threshold for...'
Change 3459 on 2004/10/05 by pete 'Fix titles of...'
Change 3456 on 2004/10/04 by rob 'Delete junk files...'
Change 3372 on 2004/10/04 by bill 'Branch V1...'Not all of these changes need integrating to MAIN. Changelist 3372, as you recall, was the change that created the branch. To find out which changes do need integrating, we can use interchanges:[*]
p4 interchanges //Ace/V1/... //Ace/MAIN/...
Change 3456 on 2004/10/04 by rob 'Delete junk files...'
Change 3459 on 2004/10/05 by pete 'Fix titles of...'
Change 3470 on 2004/10/05 by rob 'New threshold for...'Whereas changes shows all changes to a branch, interchanges shows only the changes that are not accounted for in a target branch. (See "What interchanges really tells us" later in the chapter.) In this example we see that of the three changes made to V1 since it was created, none have been integrated to MAIN. Figure 4-11 shows these changes.
Integrating Changes incrementally
A very practical way to integrate changes between branches is incrementally—changelist by changelist, in order. This method preserves logical changes as they’re propagated from branch to branch. It also keeps the problems of reconciling, resolving, and merging files to a minimum. It’s a good technique to start off with, if you’re not sure how to go about integating changes between branches.
Incremental integration is similar to branching from a point in time, using a changelist number instead of a date. Each time we integrate, we use interchanges to find out which changelist number to use.
Returning to the scenario in the previous example, here are the V1 changes as yet unaccounted for in MAIN:
p4 interchanges //Ace/V1/... //Ace/MAIN/...
Change 3456 on 2004/10/04 by rob 'Delete junk files...'
Change 3459 on 2004/10/05 by pete 'Fix titles of...'
Change 3470 on 2004/10/05 by rob 'New threshold for...'From this we see that changelist 3456 marks the next increment to integrate, as shown in Figure 4-12.
Before doing the actual integration, let’s run integ -n to get a preview of what’s involved:
p4 integ -n //Ace/V1/...@3456 //Ace/MAIN/...
//Ace/MAIN/doc/issues#7 - delete from //Ace/V1/doc/issues#2
//Ace/MAIN/doc/readme#10 - integrate from //Ace/V1/doc/readme#2
//Ace/MAIN/doc/setup.gif#1 - branch/sync from //Ace/V1/doc/setup.gif#1
//Ace/MAIN/qa/t102.pl#4 - integrate from //Ace/V1/qa/t102.pl#2
//Ace/MAIN/src/Jamfile#32 - integrate from //Ace/V1/src/Jamfile#2Here we see that integrating change 3456 from V1 to MAIN will involve merging three files, branching one, and deleting another. (Remember that integrate’s target files must be in your client view. In other words, you’ll need //Ace/MAIN/... in your view for this integ command to work.)
Note that Perforce isn’t actually operating on a changelist. It’s operating on file revisions. However, when you put a changelist number on the donor filespec, Perforce considers only the file revisions that existed as of the changelist’s point in time. What we’re really doing here is asking Perforce to treat the donor branch as if it had not yet evolved past the point in time represented by @3456.
Tip
Perforce assumes that if you added files in the donor branch, you’ll want to add them in the target branch when you integrate. Trying to be helpful, it branches new target files from new donors. Ditto for deleted files—if you deleted files in the donor, Perforce assumes you’ll want to delete them in the target as well. If Perforce has assumed correctly, you’re all set. But if you don’t want these changes propagated to the target branch, you’ll have a bit of reconciling to do before you submit your changelist. See "Reconciling Structural Changes.” later in this chapter.
Once you’ve familiarized yourself with what integrate’s going to do, run it for real (that is, without -n):
p4 integ //Ace/V1/...@3456 //Ace/MAIN/...We’re not listing integrate’s output here because it’s nearly identical to that of the preview we just saw. It shows us that Perforce has:
Found files in V1 that have been modified since they were branched, and opened corresponding MAIN files for integrating.
Found files that are new in V1 and branched them into corresponding MAIN files. (Strictly speaking, it opened new MAIN files for branching.)
Found files in V1 that have been deleted and opened corresponding MAIN files for deleting.
To complete the integration, you’ll now have to resolve the files that are open for integrating and submit your pending changelist:
p4 resolve
p4 submit(In upcoming sections we’ll take a look at the finer points of resolving files opened for integrating.)
Integrations won’t be repeated
So now you’ve integrated change @3456 from V1 into MAIN. Look what happens when you try to integrate the same change again:
p4 integ //Ace/V1/...@3456 //Ace/MAIN/...
... - all revision(s) already integrated.You’ll get this message from the integrate command when Perforce detects that relevant revisions in the donor branch have already been accounted for in the target branch. This behavior is dictated by integration history. (See "The mechanics of integration" later in the chapter for the gory details.)
And notice that interchanges no longer reports that change 3456 needs integrating:
p4 interchanges //Ace/V1/... //Ace/MAIN/...
Change 3459 on 2004/10/05 by pete 'Fix titles of...'
Change 3470 on 2004/10/05 by rob 'New threshold for...'If you proceed to integrate each of the remaining V1 changelists into MAIN, you’ll eventually reach a point where all V1 changes are accounted for, as shown in Figure 4-13.
Now here’s something even more interesting. What if we now try integrating in the other direction? Which changelists does Perforce think need integrating? Not the ones created by integrating V1 to MAIN, it turns out. When we flip the V1 and MAIN arguments, interchanges omits the integration changes. It lists only the MAIN changes that didn’t come from V1:
p4 interchanges //Ace/MAIN/... //Ace/V1/...
Change 3381 on 2004/11/05 by sue 'New attributes...'
Change 3461 on 2004/11/05 by jan 'Optional flag for...'
Change 3465 on 2004/11/05 by jan 'Fix precedence...'The output of interchanges is illustrated in Figure 4-14.
When Perforce detects that a change was integrated from a target, it keeps you from integrating it back into the target. Again, for the gory details, see "The mechanics of integration.”
The integrate command can open target files for branching , deleting, or integrating.[*] Files opened for integrating have to be resolved before you can submit them. Why?
Because, for each target file opened for integrating , Perforce needs to know whether you want to:
Merge the donor file into the target file
Copy the donor file to the target file
Ignore changes that were made in the donor file
You can use resolve to see which files need resolving. For example:
p4 resolve -n -o
C:\ws\MAIN\readme - merging //Ace/V1/doc/readme#2
using base //Ace/V1/doc/readme#1
C:\ws\MAIN\qa\t102.pl - merging //Ace/V1/qa/t102.pl#2
using base //Ace/V1/qa/t102.pl#1
C:\ws\MAIN\src\Jamfile - merging //Ace/V1/src/Jamfile#2
using base //Ace/V1/src/Jamfile#1(The -n flag makes resolve give you a preview. -o makes it display the base files.)
“Yours”, “theirs”, and “base”, revisited
Resolving, as you know, is how you tell Perforce what you want done with parallel changes to files. In Chapter 3, you read about how the files you have opened for editing can be resolved with newer revisions submitted by other people.
Resolving files during integration is almost exactly the same, only in this case files in a target branch are resolved with newer revisions in a donor branch. And, as with files you’re editing, Perforce uses the same “yours”, “theirs”, and “base” terminology to identify three variants of each file. This terminology can be a little confusing when you’re integrating, however:
“Yours” is the target file, the file being integrated into. This is the file integrate opens in your workspace, and it is the file you will submit.
“Theirs” is the donor file, the file you are integrating from. (Even when the donor file contains changes you’ve made, Perforce still calls it theirs!)
The “base” is a file that will be used to compute the merged result, if you choose to merge the donor into the target.
Although the integrate command allows you to operate on entire branches, Perforce is actually processing files individually. Each file opened for integration has its own yours-theirs-base triplet of files to resolve.
For example, readme is a file open for integration from V1 into MAIN. V1’s readme#1 was originally branched from MAIN. Its revision as of changelist 3456 is #2. In MAIN, readme#10 is the head revision. Resolving will involve a triplet of files—MAIN’s #10 as yours, V1’s #2 as theirs, and V1’s #1 as the base. (Figure 4-15.)
When you resolve readme, you’ll choose whether you want to ignore theirs, copy theirs into yours, or merge theirs into yours. All this happens in your workspace, of course. Once your workspace file is resolved you can submit it. That creates readme#11 in the MAIN branch.
Perforce normally selects the head revision of the target file as “yours” so that you’ll be merging changes into the most up-to-date file. If your workspace copy is not
already synchronized with the head revision, the integrate command resynchronizes for you. The revisions Perforce selects as theirs and the base depend on revisions you supply to the integrate command and on recorded integration history, as you’ll see in "The mechanics of integration.” later in this chapter.
Merging the donor file into the target
Text files can be resolved by merging . In fact, resolve’s default behavior is to merge text files when necessary. For example, let’s say the readme file has been edited in both branches since it was branched from MAIN into V1, as illustrated in Figure 4-15. Integrating from V1 into MAIN opens the MAIN/readme file:
p4 integ -o //Ace/V1/...@3456 //Ace/MAIN/...
...
//Ace/MAIN/readme#10 - integrate from //Ace/V1/readme#2
using base //Ace/V1/readme#1
...(The -o flag on integrate causes the base revision to be listed.) As in the previous example, MAIN/readme#10 is yours, V1/readme#2 is theirs, and V1/readme#1 is the base. Let’s assume auto-resolving merges the file without conflict:
p4 resolve -am
...
C:\ws\MAIN\readme - merging //Ace/V1/readme#2
Diff chunks: 2 yours + 3 theirs + 0 both + 0 conflicting
- merge from //Ace/V1/readme
...(Recall that the -am flag tells resolve to accept merges.) Your workspace file now contains the merged result. When you submit your changelist, the file is sent to the depot and MAIN/readme#11 is created:
p4 submit
...
//Ace/MAIN/readme#11 - integrate
...P4V’s Revision Graph illustrates this, as Figure 4-16 shows.
The filelog command shows the integration history:
p4 filelog -m1 //Ace/MAIN/readme
//Ace/MAIN/readme
... #11 change 5420 integrate 2004/10/15 rob 'Pull in V1...'
... ... merge from //Ace/V1/readme#2
...Had there been conflicts, you would have had to resolve the file interactively and edit it. And, because you’d edited it, the submitted file would have had a slightly different integration history:
p4 filelog -m1 //Ace/MAIN/readme
//Ace/MAIN/readme
... #11 change 5420 integrate 2004/10/15 rob 'Pull in V1...'
... ... edit from //Ace/V1/readme#2
...Copying the donor file into the target
You can resolve files by copying donors to targets. Auto-resolving will do this for you, in cases where the donor file has changed and the target file has not. When Perforce encounters these conditions during interactive resolving, you’ll be prompted you to resolve by copying.
For example, assume MAIN/readme#8 was branched into V1/readme#1. Since then, someone has submitted V1/readme#2. MAIN/readme hasn’t changed.
As you submit files, Perforce records a history of file revisions that were integrated and how they were resolved. You’ll see integration history as you examine file history. For example, the //Ace/MAIN/readme file was branched to //Ace/DEV/readme. Here’s its history:
p4 filelog //Ace/MAIN/readme
//Ace/MAIN/readme
... #8 change 3712 integrate ...
... ... copy from //Ace/DEV/readme#3
... #7 change 3710 edit ...
... #6 change 3709 integrate ...
... ... ignored //Ace/DEV/readme#2
... #5 change 3708 edit ...
... #4 change 3707 edit ...
... #3 change 3703 edit ...
... ... branch into //Ace/DEV/readme#1
... #2 change 3702 edit ...
... #1 change 3701 add ...The reciprocal details show up in the history of //Ace/DEV/readme:
p4 filelog //Ace/DEV/readme
//Ace/DEV/readme
... #3 change 3711 edit ...
... ... copy into //Ace/MAIN/readme#8
... #2 change 3705 edit ...
... ... ignored by //Ace/MAIN/readme#6
... #1 change 3704 branch ...
... ... branch from //Ace/MAIN/readme#1,#3Another way to dig up integration history is with the integrated command. For example:
p4 integrated //Ace/DEV/readme
//Ace/DEV/readme#1 - branch from //Ace/MAIN/readme#1,#3
//Ace/DEV/readme#2 - ignored by //Ace/MAIN/readme#6
//Ace/DEV/readme#3 - copy into //Ace/MAIN/readme#8P4V’s Revision Graph produces a great bird’s-eye view of a file’s integration history, with succinct symbols that show how file revisions were created and integrated. Figure 4-17 shows the legend of Revision Graph symbols.
Here are the commands that integrate from V1 into MAIN:
p4 integ //Ace/MAIN/...@3456 //Ace/V1/...... //Ace/MAIN/readme#8 - integrate from //Ace/V1/readme#2 ...p4 resolve -am... C:\ws\MAIN\readme - merging //Ace/V1/readme#2 Diff chunks: 0 yours + 1 theirs + 0 both + 0 conflicting - copy from //Ace/V1/readme ...p4 submit... integrate //Ace/MAIN/readme#9 ...
Integrating from V1 into MAIN opens MAIN/readme#8 in your workspace, resolving copies V1/readme#2 to the MAIN/readme file in your workspace, and submitting creates a MAIN/readme#9 in the depot whose content is the same as V1/readme#2.[*]
The Revision Graph for the preceding example is shown in Figure 4-17. Compare this figure with Figure 4-17 to see the subtle difference in the symbol for MAIN/readme#11.
The history of MAIN/readme shows how V1/readme was integrated:
p4 filelog -m1 //Ace/MAIN/readme
//Ace/MAIN/readme
... #9 change 5420 integrate 2004/11/17 rob 'Pulling in V1... '
... ... copy from //Ace/V1/readme#2You can also make resolve copy the donor file to the target regardless of whether the target file has been changed. (This is called copy-integrating.) Use the -at flag for this. For example:
p4 resolve -at
...
C:\ws\MAIN\readme - vs //Ace/V1/readme#2
Diff chunks: 1 yours + 1 theirs + 0 both + 0 conflicting
- copy from //Ace/V1/readme
...Ignoring the donor file’s changes
Perforce normally resolves by ignoring when it detects that nothing has changed in the donor file—that is, when the base and theirs have the same content.
Tip
If the donor still has the same content that it had when it was branched, isn’t the donor accounted for in the target? Not necessarily. For example, the donor file may have been edited simply to change its file type. Or it may have been changed twice—the second time to back out the first change.
You have the option of resolving by ignoring even when the donor file has changed. You’d do this when integrating a change that, for one reason or another, isn’t applicable to the target branch.
For example, assume V1’s change 3456 is not accounted for in MAIN:
p4 interchanges //Ace/V1/... //Ace/MAIN/...
...
Change 3456 on 2004/10/05 by pete 'Promo for release...'
...And let’s say you plan to ignore change 3456 because it’s not applicable to the MAIN branch. Still, you integrate it, so that you have a record of the fact that it’s not applicable. One of the files opened for integrating is readme:
p4 integ //Ace/V1/...@3456 //Ace/MAIN/...
...
//Ace/MAIN/readme#10 - integrate from //Ace/V1/readme#2
...Now you auto-resolve, using the “accept yours” option:
p4 resolve -ay
c:\ws\MAIN\readme - vs //Ace/V1/readme#2
- ignored //Ace/V1/readme(“Accept yours” is the same as “ignore theirs.”) When you resolve this way, your workspace file is left unchanged. Even so, you must submit it in order to record the integration:
p4 submit
...
integrate //Ace/MAIN/readme#11
...The Revision Graph is shown in Figure 4-18.
History now shows that V1/readme#2’s change has is been ignored, yet accounted for, in MAIN/readme:
p4 filelog //Ace/MAIN/readme
.. #11 change 5420 integrate 2004/11/17 rob 'Ignoring promo...'
... ... ignored //Ace/V1/readme#2As you would expect, there’s no content difference between MAIN’s readme#10 and readme#11:
p4 diff2 //Ace/MAIN/readme#10 //Ace/MAIN/readme#11
= == = //Ace/MAIN/readme#10 - //Ace/MAIN/readme#11 = == = identicalAs you know, you can edit files in the course of resolving them. But what if you need to edit files after you resolve them? You can do this; you simply need to reopen the files for editing first, to make them writable.
For example, src/Jamfile is one of the files in changelist 3456. Integrating changelist 3456 will open MAIN’s src/Jamfile. There’s nothing to keep you from reopening it for editing before you submit it:
p4 integ //Ace/V1/...@3456 //Ace/MAIN/...
p4 resolve
p4 edit //Ace/MAIN/src/JamfileIn fact, you can run edit and integrate in any order. A file that is already opened for editing can be opened for integrating, and a file that is already opened for integrating can be opened for editing.
Integrating by subdirectory
When feasible, you can limit the scope of the integrate command to a particular subdirectory. For example, let’s say we’re interested in integrating changes to the db subdirectory. To find out which db changes in V1 need to be integrated to MAIN, we use:
p4 interchanges //Ace/V1/db/... //Ace/MAIN/db/...
Change 3470 on 2004/10/05 by rob 'New threshold for...'This lists all the changes in V1 that involved as-yet unintegrated file revisions in the db subdirectory. It shows us that the next change to integrate is 3470. Now we double-check to make sure change 3470 affects no files outside of the db subdirectory:
p4 describe -s 3470
Change 3470 by rob on 2004/10/05
New threshold for db page allocation ...
...
... //Ace/V1/db/dbLng.cpp#2 edit
... //Ace/V1/db/Jamfile#2 editThis is good; we see that changelist 3470 references db files only. (To find out why this is so important, see the upcoming section "Don’t break up changelists.”) To integrate the change, we use:
p4 integ //Ace/V1/db/...@3470 //Ace/MAIN/db/...
p4 resolve
p4 submitCherry-picking changes to integrate
“Cherry-picking” integration is where you integrate a single change, or sequence of changes, out of order, from one branch into another. For example, assume these are the changes that currently need integration from V1 into MAIN:
p4 interchanges //Ace/V1/... //Ace/MAIN/...
Change 3456 on 2004/10/04 by rob 'Delete junk files...'
Change 3459 on 2004/10/05 by pete 'Fix titles of...'
Change 3470 on 2004/10/05 by rob 'New threshold for...'Let’s say you want to integrate Pete’s change before integrating the other two changes. (Figure 4-19.)
You can cherry-pick a change to integrate by using its changelist number in a revision range, like this:
p4 integ //Ace/V1/...@3459,@3459 //Ace/MAIN/...
//Ace/MAIN/gui/opRList.cpp#12 - integrate from //Ace/V1/gui/opRList.cpp#3,#3
//Ace/MAIN/gui/opRList.h#9 - integrate from //Ace/V1/gui/opRList.h#3,#3The @n,@n revision syntax[*] restricts the operation to the files that were involved in changelist 3459. Two files were involved; their MAIN counterparts are now open for integrating. All you have to do now is resolve the files, submit them, and voila, change 3459 is integrated into MAIN.
That’s the good news. The bad news is that interchanges is not always able to detect cherry-picked changes. Thus, even after you’ve submitted integrated change 3459 from V1 to MAIN, the change may still show up as unintegrated because it’s nested between two changes that really do need integrating:
p4 interchanges //Ace/V1/... //Ace/MAIN/...
Change 3456 on 2004/10/04 by rob 'Delete junk files...'
Change 3459 on 2004/10/05 by pete 'Fix titles of...'
Change 3470 on 2004/10/05 by rob 'New threshold for...'This is an idiosyncracy of the interchanges command, not of integration history. (See "What interchanges really tells us.”) If you were to try to cherry-pick the same change again, you would see that it is already accounted for:
p4 integ //Ace/V1/...@3459,@3459 //Ace/MAIN/...
... - all revision(s) already integrated.Tip
There are often good reasons to integrate a single change out of sequence. But unless the change is small and self-contained, cherry-picking may create more problems than it solves. What if the change builds on a previous change? If you’re not careful, you could end up integrating half of the previous change along with all of the current one. What if the change involves a renamed file? If you’ve skipped past the change in which the rename occured, should you propagate the new name or not?
It’s hard enough to keep collaboration going smoothly when changes are integrated in order. Integrating changes out of order adds complexity. Complexity, in turn, makes it more likely that something will go wrong.
Integrating all changes at once
You have the option of integrating all changes, all at once, from one branch into another. (Figure 4-20.)
Be aware, though, that integrating everything at once can be a challenge. For one thing, it puts you in a position of having to merge several changes at the same time. The more you’re merging at once, the bigger your diffs, and the bigger your diffs, the more likely it is that merge errors will slip in unnoticed. For another, structural changes that are easy to reconcile piecemeal can be impossible to reconcile when combined with other changes. You’ll understand why after reading "Reconciling Structural Changes" later in this chapter.
For all-at-once integration you don’t need to specify a donor revision. To integrate all of V1’s changes into MAIN, for example, you’d use:
p4 integ //Ace/V1/... //Ace/MAIN/...
p4 resolve
p4 submitBecause you didn’t give a revision on the integ command’s donor argument, Perforce assumes you want changes up to and including the most recent V1 change to be considered for integration. (Of course, as it considers changes, Perforce opens only the files that need integrating. So if you run this sequence of commands frequently, it’s pretty much the same as integrating incrementally.) The single change submitted to the target will effectively account for all the corresponding changes in the donor.
Which Changes Were Integrated?
If you have comm and sort programs available[*] you can use them with changes to show changes that have been integrated to a branch. For example, to list the V1 changes that have been integrated into MAIN:
p4 changes //Ace/V1/... | sort > tempfile1
p4 changes -i //Ace/MAIN/... | sort > tempfile2
comm -1 -2 tempfile1 tempfile2
Change 3456 on 2004/10/04 by rob 'Delete junk files...'
Change 3459 on 2004/10/05 by pete 'Fix titles of...'(The changes command reports changelists that refer to files in a given filespec. tempfile1, therefore, is a list of every change submitted to V1. The -i option makes changes include the changelists that have been integrated to the files in question. tempfile2 is therefore a list of changes that were either submitted or integrated into MAIN. The comm command compares tempfile1 and tempfile2 and shows only the lines common to both.)
Don’t break up changelists
You may recognize that if all of the files in changelist 3471 are within the src subdirectory, these two commands are the same:
p4 integ //Ace/V1/...@3471 //Ace/MAIN/...
p4 integ //Ace/V1/src/...@3471 //Ace/MAIN/src/...But if changelist 3471 involves files outside of src, the commands are not the same. The first of the two integrates the entire change; the second breaks up the changelist.
There’s nothing to stop you from breaking up a changelist—you can resolve and submit the src files whether or not other files were involved in changelist 3471. But you will have integrated only part of the change, not the entire change. The same thing can happen if you’re using a workspace with a client view limited to the src subdirectory. The scope of your integrate commands is limited accordingly and you won’t be able to integrate the entire change.
The unintegrated part of a change can always be integrated later, of course. But there are two problems with partially integrated changes. The first is the obvious one: you’re breaking up a logical change. Whatever it may be, the reason files were changed together in the V1 branch argues for integrating the entire change to the MAIN branch.
The second problem is that partially integrated changes can lead to false positives from some Perforce commands. If a change is only partially integrated, changes -i will report that it’s been integrated, for example. Likewise, interchanges reports partially integrated changes as unintegrated. The jobs and fixes commands, which you’ll read about in later chapters, can also yield false positives on partially integrated changes.
Reconciling Structural Changes
Earlier we said that files can evolve independently in their own branches. This is completely true. Files can be added, deleted, moved, renamed, split, or combined in one branch without affecting any other branch. However, structural changes like these can’t be resolved during integration. In fact, when you use the integrate command, Perforce simply matches donor and target files by name. The state of each donor file, whatever it is, is imposed upon the like-named target file. If the donor file was deleted, integrate deletes the target file. If the target file doesn’t exist, it branches the donor file into it.
Matching donor and target files by name is normally quite effective for propagating structural changes. For example, say MAIN/readme#8 was branched into V1/readme#1 when you created the V1 branch . Since then, the V1/readme file has been renamed to V1/readme.txt and edited a couple of times.
Now, as you integrate from V1 to MAIN, here’s what happens:
p4 integ //Ace/V1/... //Ace/MAIN/...
//Ace/MAIN/readme.txt#1 - branch/sync from //Ace/V1/readme.txt#3
//Ace/MAIN/readme#11 - delete from //Ace/V1/readme#3So far, so good. Although Perforce gave you no choice in the matter, and nothing is left for you to resolve, the outcome is exactly what you wanted. When you submit your changelist, Perforce will delete MAIN/readme and branch V1/readme.txt into MAIN, effectively propagating both the content change and the structural change from V1 to MAIN.
But what if you wanted to merge the content change and ignore the structural change? What if the structural change had occured in MAIN instead of V1? Neither integrate nor resolve offers a way for you to handle these cases. However, as with files you’re editing, there are several ways to reconcile structural changes. One way is to provide Perforce with some guidance as to how branches correspond structurally. This is where branch views come in.
Using branch views
To save you from having to jot down your frequently used donor and target filespecs on a cocktail napkin, Perforce lets you save them in named, reusable branch views. Branch views are similar to client views in that they map one set of files to another. In branch views, depot files are mapped to other depot files instead of to workspace files. A branch view named V1toMAIN, that stores a mapping between V1 and MAIN, for example, looks like this:
Branch
V1toMAIN
View
//Ace/V1/... //Ace/MAIN/...
To create or change a branch view, use the branch command. This is the command that created the branch view called V1toMAIN:
p4 branch V1toMAINNote that the branch command doesn’t branch files—in fact, it has no effect at all on files.
A branch view is a spec, like client specs. When you run the branch command, you’re given a form to fill out. Once you save the form, you can use your new branch view with the integrate command. Given the branch view definition shown earlier, these two commands will now do exactly the same thing:
p4 integ -b V1toMAIN
p4 integ //Ace/V1/... //Ace/MAIN/...Branch views change the way you use revisions with integrate. For example, these commands are equivalent:
p4 integ -b V1toMAIN @3456
p4 integ //Ace/V1/...@3456 //Ace/MAIN/...as are these commands:
p4 integ -b V1toMAIN @3459,3459
p4 integ //Ace/V1/...@3459,3459 //Ace/MAIN/...What’s happening here is that when you’re using a branch view, the integrate command already knows which donor and target path to use. The revision you supply is applied to the donor path. (You can’t put revisions in the branch view specs themselves, by the way.)
You can also use branch views with interchanges and diff2. The following commands are equivalent, for example:
p4 interchanges -b V1toMAIN
p4 interchanges //Ace/V1/... //Ace/MAIN/...as are these:
p4 diff2 -q -b V1toMAIN
p4 diff2 -q //Ace/V1/... //Ace/MAIN/...In a moment we’ll show how to augment branch views to reconcile structural differences between branches.
Looking for a branch view
To list the branch views that have already been defined, use:
p4 branches
Branch V1toMAIN 2004/10/15 'Created by laura'You can inspect a branch view’s definition with branch -o. For example:
p4 branch -o V1toMAIN
Branch: V1toMAIN
View:
//Ace/V1/... //Ace/MAIN/...Branch views are reversible
You can use the same branch view to integrate changes in either direction. To apply a branch view in reverse, use integrate -r. For example, when the V1toMAIN branch view is defined as previously, these commands are equivalent:
p4 integ -r -b V1toMAIN
p4 integ //Ace/MAIN/... //Ace/V1/...Mapping one directory structure to another
So, why all the fuss about branch views? They give us a way to coerce integrate into mapping the old directory structure in one branch to the new directory structure in another. For example, say that in changelist 3461, V1’s readme was renamed to readme.txt. As you just saw, simply integrating from V1 to MAIN will replicate the structural change:
p4 integ -n //Ace/V1/...@3461 //Ace/MAIN/...
...
//Ace/MAIN/readme.txt#1 - branch/sync from //Ace/V1/readme.txt#1
//Ace/MAIN/readme#11 - delete from //Ace/V1/readme#4
...But what if you don’t want to replicate the structural change? What if, from here on, changes to V1’s readme.txt are to be integrated into MAIN’s readme? You can effect this behavior through a branch view. We’ll use the V1toMAIN branch view in this example. We update the view to map V1’s new structure to MAIN’s old structure:
p4 branch V1toMAINBranch
V1toMAIN
View
//Ace/V1/... //Ace/MAIN/... //Ace/V1/readme.txt //Ace/MAIN/readme
Now, when we use the V1toMAIN branch view with integrate, look what happens:
p4 integ -b V1toMAIN @3461
... - all revision(s) already integratedPerforce makes no attempt to integrate V1’s readme change to MAIN. Why not? Because it’s now matching V1’s readme.txt to MAIN’s readme. V1’s readme.txt@3461 has integration history that shows that it has not been edited since it was branched from its ancestor, readme#10 in MAIN. Therefore, there is nothing to integrate.
Once V1’s readme.txt is edited, however, Perforce will find reason to open MAIN’s readme for integration. For example, say V1’s readme.txt was edited in change 3466.
Now, let’s integrate V1 to MAIN, again using the branch view:
p4 integ -o -b V1toMAIN @3466
...
//Ace/V1/readme#10 - integrate from //Ace/V1/readme.txt#2
- using base //Ace/V1/readme#3
...As you can see, Perforce is matching V1/readme.txt to MAIN/readme. And, having found a revision of the former that is not accounted for in the latter, it opens the latter for integrating. You can resolve and submit the opened file as you would any other file opened for integrating.
Keeping added files from being propagated
You can also use branch views to prevent replication of added files. Normally, when integrate finds a new file in the donor branch, it branches it into the target branch. But you may have a situation where a file added in one branch is not appropriate for another.
For example, say the v1promo.html file that was added in V1 is not appropriate for MAIN. Unless you do something about it, v1promo.html is going to be branched when you integrate from V1 into MAIN. You can prevent this from happening by adding a line to the V1toMAIN branch view that excludes v1promo.html. For example:
p4 branch V1toMAINBranch
V1toMAIN
View
//Ace/V1/... //Ace/MAIN/... //Ace/V1/readme.txt //Ace/MAIN/readme -//Ace/V1/v1promo.html //Ace/MAIN/v1promo.html
(A line that begins with “-” excludes files from the view.) Now the V1toMAIN branch view will effectively hide v1promo.html from commands that use it. That is, commands like interchanges and integrate will pay no attention to the file when you use them with the V1toMAIN branch view. If you’re working in V1, of course, you’ll still be able to see and work on v1promo.html.
Keeping target files from being deleted
Normally, when integrate sees that files in the donor branch were deleted, it assumes you want the corresponding targeted files deleted as well. You can use branch views to keep integrate from deleting target files.
You can do the same thing for files that have been deleted. Normally, when integrate sees that files in the donor branch were deleted, it assumes that you want the corresponding targeted files deleted as well.
For example, say V1’s doc/issues file has been deleted. When you integrate from V1 to MAIN, Perforce either tells you that MAIN’s doc/issues will be deleted:
p4 integ -b V1toMAIN @3456
...
//Ace/MAIN/doc/issues#7 - delete from //Ace/V1/doc/issues#2
...or it tells you that it wants to delete it:
p4 integ -b V1toMAIN @3456
...
//Ace/MAIN/doc/issues#8 - can't delete from
//Ace/V1/doc/issues#2 with -d or -Dt flag
...(The second behavior is what you’d see if MAIN’s doc/issues file had been changed recently.) In any case, let’s assume you don’t want the MAIN file deleted. To keep Perforce from attempting to delete it, you can exclude it from the branch view:
p4 branch V1toMAINBranch
V1toMAIN
View
//Ace/V1/... //Ace/MAIN/... //Ace/V1/readme.txt //Ace/MAIN/readme -//Ace/V1/v1promo.html //Ace/MAIN/v1promo.html -//Ace/V1/doc/issues //Ace/MAIN/doc/issues
Now when you run integrate using the branch view, Perforce will skip over the doc/issues file.
Deleted target files are usually of no concern to Perforce when you run integrate. Perforce cares only about propagating change from donor to target; the change that deleted the files is already accounted for in the target. But if the corresponding donor files have as-yet unintegrated changes, Perforce warns you that something is amiss.
For example, say new development in MAIN has involved deleting the entire db directory. (Granted, this is an extreme example.) And say a recent bug fix in V1 involved a change to files in db. Now, every time you integrate from V1 to MAIN, Perforce will give you warnings about the deleted target files:
p4 integ -b V1toMAIN @3467
...
//Ace/MAIN/db/dbPgLoad.cpp—can't branch from
//Ace/V1/db/dbPgLoad.cpp#2 without -d or -Dt flag
...What Perforce is telling you is that it found a change to V1’s db files that isn’t accounted for in MAIN. But when it looked for db files in MAIN, all it found was deleted files. It tells you that if you really want to propagate the change, it can oblige you by branching V1’s db files into MAIN. But you’ll have to run integrate using the -d flag to get it to do that.
Chances are good, however, that new development in MAIN has made changes to V1’s db files irrelevant. Perforce emits warnings because it has no way of knowing that this is the case. If the warnings annoy you, you can exclude the db files from the branch view:
p4 branch V1toMAINBranch
V1toMAIN
View
//Ace/V1/... //Ace/MAIN/... //Ace/V1/readme.txt //Ace/MAIN/readme -//Ace/V1/v1promo.html //Ace/MAIN/v1promo.html -//Ace/V1/doc/issues //Ace/MAIN/doc/issues -//Ace/V1/db/... //Ace/MAIN/db/...
Henceforth your integrate commands will ignore the db files, as long as you use them with the V1toMAIN branch view.
The Arcana of Integration
(Heavens, it’s all rather arcane, isn’t it?)
Reconciling Split and Combined Files
It’s worth noting that there are ways to reconcile branches so that changes can be integrated between them even when files have been split or combined in one of them. Reconciling split and combined files is a bit of a parlor trick, but that it can be done at all is a distinguishing feature of Perforce.
Consider this case: after V1 was branched from MAIN, MAIN’s parse.cpp was split into two files, parse.cpp and eval.cpp. Meanwhile, change 3472 has been submitted in V1 which affects parse.cpp.
As is your custom, you integrate change 3472 from V1 to MAIN thus:
p4 integ -b V1toMAIN @3472
...
//Ace/MAIN/parse.cpp#5 - integrate from //Ace/V1/parse.cpp#2
...MAIN’s parse.cpp is opened for integrating, which is good. Maybe the change in V1’s parse.cpp should be merged into it. But what if the change should be merged into MAIN’s eval.cpp? What if part of the V1 change should be merged into MAIN’s parse.cpp and part of it should be merged into eval.cpp?
Unfortunately, since nothing maps V1’s parse.cpp to MAIN’s eval.cpp, integrate has no way of knowing it should open the latter. Even if there were such a mapping in the V1toMAIN branch view, it would eclipse the mapping between the two parse.cpp files, because there can be only one mapping per file in a branch view. (When there is more than one, the last takes precedence.)
However, there’s nothing to keep you from running more than one integrate command. If you know that part of MAIN’s parse.cpp has been spun off into eval.cpp, you can integrate change 3472 using a pair of integrate commands:
p4 integ -o -b V1toMAIN @3472... //Ace/MAIN/parse.cpp#6 - integrate from //Ace/V1/parse.cpp#2 using base //Ace/V1/parse.cpp#1 ...p4 integ -o //Ace/V1/parse.cpp@3472 //Ace/MAIN/eval.cpp//Ace/MAIN/eval.cpp#1 - integrate from //Ace/V1/parse.cpp#2 using base //Ace/MAIN/parse.cpp#5
This sequence of commands opens two target files for integrating from the same donor file. When you resolve them—which you should do interactively—you’ll have a chance to pick the correct merged result for each. Whether it’s easy or hard to pick a merged result, and whether conflicts are involved, will depend on how the MAIN file was split and how the V1 file was changed.
Integration involving split and combined files is definitely in the category of things not to make a habit of. Nevertheless, software development being what it is, refactoring happens, and branches diverge. In Chapter 7 we’ll look at ways to organize and use branches so that most change flows between fairly similar branches and changes that increase divergence don’t have to traverse too many branches.
Integration history can’t be undone
Integration history is permanent. Once integrated, changes won’t come up for integration again. So what can you do if you’ve botched an integration?
For example, say you’ve been incrementally integrating changes from V1 into MAIN. You’ve just integrated 3461 from V1 to MAIN, creating change 3484 in MAIN. Now you find out that change 3461 wasn’t applicable to MAIN.
You always have the option of undoing an integration by simply backing out the change. (You read about how to do this in Chapter 2) For example, you can back out change 3484. This will restore the MAIN branch to what it was before you submitted the bad integration.
Backing out a change doesn’t change integration history. When you next look for changes to integrate, 3461 won’t show up. As far as Perforce knows, V1’s 3461 is accounted for in MAIN. Hopefully this is what you wanted, because there’s nothing you can do to change it.
Forcing Perforce to Redo an Integration
But what if you do want to redo an integration? For example, let’s say change 3461 was meant for MAIN. One file, db/Jamfile, was merged during the integration. Now you discover that in editing conflicts in the merged result, you managed to delete entire chunks of the file. And, in your haste, you submitted your integration before realizing what you’d done.
There are two ways to fix this. One way, of course, is to simply open MAIN/Jamfile for editing and put the missing chunks back in by cutting and pasting.
The other way to fix a bad merge is to coerce Perforce into redoing the integration. This gives you another chance at merging the orginal files.
Here’s what you’ll need to do:
Synchronize with the last good revision of the target file:
p4 sync //Ace/MAIN/db/Jamfile@3483Use this form of integrate to open the file for integrating:
p4 integ -h -f //Ace/MAIN/db/Jamfile@3484,3484(-h makes Perforce use the revision you have as the target. -f forces Perforce to ignore previous integration history. The revision range, @3484,3484, makes Perforce use @3483 as the merge base.)
Take another crack at resolving the file:
p4 resolveResynchronize the file and resolve it by ignoring the depot version:
p4 sync //Ace/MAIN/db/Jamfile p4 resolve -ay(The depot version, as you recall, is currently the mangled one.)
If you’re happy with the result, submit the file:
p4 submit
Note that you can redo only the parts of an integration that involve resolving files. With the procedure shown here, for example, you can redo a merge. But for integrations that involve branching or deleting files, you’ll have to resort to backing out changes.
The mechanics of integration
Thanks to filespecs and changelist numbers, you can use integrate to operate on entire branches, complete changes, points in time, and various combinations thereof. But underneath it all, Perforce operates on individual file revisions. In this section we take a look at what happens to the files involved in integration operations.
When you run integrate, you provide filespecs that describe sets of donor and target files. You provide them as command arguments, in a branch view, or through a combination of both. Once integrate has analyzed donor and target files, it opens a subset of the target files. In other words, integrate operates on target files, not donor files.
Your workspace’s client view limits the scope of the integrate command. No matter how you invoke it, integrate won’t operate on files that aren’t in your client view. The target files don’t necessarily have to be synchronized in your workspace, but they do have to be in your client view. The donor files, although they will be analyzed, will not be opened by integrate. So it doesn’t matter whether the donor files are in your client view.
You can always use integrate -n to find out exactly which target files will be opened. For example:
p4 integ -n //Ace/MAIN/...@3456 //Ace/V1/...The Perforce Server does quite a bit of analysis to figure out which files to open. It begins the analysis by:
Making a list of the donor files that currently exist. (Note that a file exists even if its current revision is marked deleted.)
Computing a target filename for each donor filename. This is done strictly by pattern-matching, using filespecs you provide in a branch view or as command arguments. File history has no bearing on matching target filenames to donor filenames.
Now Perforce has a list of donor-target file pairs to analyze. From here on, it analyzes each donor-target pair individually. So when we say donor and target in the explanation that follows, we mean the individual files, not the entire sets.
Perforce’s next step is to assess the history of the donor—at least, as much of its history as is relevant to the current integrate command. The relevant history is tempered by:
Whether the donor was ever deleted and re-added. For integration, Perforce usually treats the donor as if it had begun life when it was was most recently re-added. (Rebranched revisions have the same effect as re-added revisions.)
Whether you supplied a revision on the integrate command. When you integrate one changelist at a time, or cherry-pick changes to integrate, you’re narrowing the relevant history of the donor.
In the context of its relevant history, the donor file is either a deleted file or not. Perforce can tell whether it needs to do anything, in some cases, without any further analysis:
If the donor is deleted and the target does not exist, nothing happens. There is nothing to integrate.
If the donor and target file are both deleted, nothing happens. There is nothing to integrate.
If the donor is not deleted, and the target does not exist, the donor needs to be branched to the target. (This is the familiar “cloning” a file case.) The target file will be opened for branching.
These are the simple cases; even more analysis is needed for the rest. Perforce now takes stock of all the revisions in the donor’s relevant history and inspects them to see which are already accounted for in the target.
A donor revision is accounted for if it was branched or integrated into the target, or if it was branched or integrated from the target without editing. (See "Why does editing matter?" a bit latex in the chapter) A donor revision may also be considered accounted for if it’s related to the target indirectly by a trail of integration history. If all revisions of the donor have been accounted for in the target, nothing happens to the target—there is nothing to integrate.
If there are donor revisions not yet accounted for in the target, Perforce tests a number of factors to decide what to do with the target:
If the donor is deleted and the target is not, Perforce assumes that you want to delete the target. But before doing anything, it asks itself, “Is the target evolving, too?” If the answer is yes, it warns you that if you really want it to delete a file that’s been modified, you’ll have to run integrate -d. If the answer is no, it opens the target for deleting.
If the target is deleted but the donor is not, Perforce gives you a warning. It tells you that it can re-branch the donor file on top of the target, but you’ll have to run integrate -d to force it to do so.
And, finally, in the case where both donor and target exist, and neither is deleted, Perforce synchronizes the target in the workspace, opens it for integrating, and leaves it for you to resolve.
As you know, resolving a file involves three files, “yours”, “theirs”, and the “base”. The donor’s highest, unnaccounted-for revision will be used as “theirs”. The target file in your workspace will be used as “yours”.
Perforce picks the base using a formula that takes into account previous integration history.[*] As you can imagine, it’s a complicated formula; explaining it doesn’t make anything clearer. Let’s just say that:
Usually the base is the revision of the donor you last integrated. This is excellent for three-way merging, because it keeps changes you’ve already merged from showing up as diffs.
When you cherry-pick, the base is the the donor revision that precedes the lowest revision in the range you specified. For three-way merging, this has the effect of making changes within a revision range look like “their” diffs.
Sometimes the base is a revision of the donor that is lower than the revision you last integrated. This happens when you’re integrating changes that were skipped by previous cherry-picking.
Sometimes the base is a revision of the file the donor was branched from. This makes it possible to merge changes to and from renamed files.
Sometimes the base is a file only indirectly related to both donor and target. Perforce picks a base like this when the donor has never been integrated into the target. This makes it possible to merge changes that have occured since a distant branch point.
When Perforce can’t find anything better, it uses the donor’s revision #1 as the base.
Finally, new integration history is recorded when you submit the target file. The lowest and highest of the donor revisions as yet unnaccounted for are associated with the new revision of the target. The next time you integrate between donor and target, these revisions will be taken into account.
What interchanges really tells us
As you read in "Cherry-picking changes to integrate,” earlier in this chapter, interchanges can imply that a change needs integrating when in fact the change has already been cherry-picked. Once you’ve fathomed the mechanics of integration, you’ll see why the interchanges command behaves this way.
Perforce isn’t keeping track of changelists as they are integrated from donor to target files. Instead, it’s keeping track of individual file revisions. When you run the integ command, it operates on the individual revisions that haven’t been integrated. (As you’ve seen in this chapter, you can run integ -n to get a list of these revisions.)
The problem with integ -n is that it yields too much information. When you’re trying to figure out what to integrate next, an itemized list of file revisions isn’t that helpful. What is helpful is a list of changelists—logical units of work submitted by developers—that need integrating.
The interchanges command meets this need by analyzing the donor-target integration history that would be recorded if its operands were used by integ. As you just read in “The mechanics of integration,” each donor file has a lowest and highest revision that will be associated by integration with the new revision of its target. Each low-to-high range involves one or more files revisions, and each file revision has one changelist associated with it. The interchanges command aggregates all of the revisions in all of the low-to-high ranges and reports the sorted list of unique changelists associated with them. If a low-to-high range includes revisions previously integrated by cherry-picking, previously integrated changelists can show up in the output of interchanges.
However, as long as you’re careful about integrating changelists in order and in their entirety, interchanges will give you useful output. And as it turns out, there are other good reasons to integrate changelists in order and in their entirety. We’ll get to that in Chapter 8.
Decoding integration history
In the output of various Perforce commands, you may have noticed integration history described in terms like add from and edit into. This looks like English, but what it really is is a very terse vocabulary of integration events. The actual output depends on the commands emitting them, but once you recognize the keywords, it’s easy to interpret. Table 4-1 explains the keywords.
|
Keywords |
Explanation |
|
branch |
You branched a file. Content-wise, the file is identical to its donor. |
|
branch+add |
You branched a file and modified it before submitting it. The branched file may or may not be identical to its donor. |
|
integrate+merge |
You integrated a file and resolved it by merging. You submitted the file Perforce constructed; you didn’t edit the merged result. |
|
integrate+edit |
You integrated a file and modified it before submitting it. You may have edited it to resolve merge conflicts, or you may have reopened it for editing before or after resolving it. |
|
integrate+copy |
You integrated a file and resolved it by copying the donor to it. The file is identical to its donor. |
|
integrate+ignore |
You integrated a file and resolved it by ignoring the donor. |
|
delete from/into |
You integrated a deleted file. (That is, you used integrate to delete a file.) |
|
branch+import |
You branched a file from a remote depot. The file is identical to its donor. |
Why does editing matter?
During integration, content can be merged into a file with or without your intervention. Likewise, content can be copied to a file during branching with or without your intervention. In either case, you have the option of editing the file before submitting it. (And you may not have a choice, as when editing a file to resolve merge conflicts.)
When you edit a file—that is, if you change any of its actual content—you’re doing something to it that can’t be derived by copying or merging another file.[*] So, as Perforce records integration history, it notes whether you’ve edited files. It uses this distinction later, to determine which donor revisions can be considered accounted for in targets.
For example, look at this integration history:
p4 integrated apples
...
apples#9 - merge from fruit#4
...
apples#1 - branch from fruit#1,#3Here, apples#1 was branched from fruit#3. Nothing in its content was introduced by the user. And apples#9 was created by integrating from fruit into apples and resolving by merging. Because no editing was involved in creating either apples#1 or apples#9, both revisions of apples are considered accounted for in the history of fruit.
Now look at this history:
p4 integrated oranges
...
oranges#9 - edit from fruit#4
...
oranges#1 - add from fruit#1,#3Here, oranges#1 was branched from fruit#3. Add from tells us it was edited before it was submitted. And, although oranges#9 was created by integrating from fruit, edit from tells us it was edited before it was submitted. In any case, neither oranges#1 nor oranges#9 is considered accounted for in the history of fruit, because both contain content edited by a user.
Finally, the last bit of arcana is for command-line users. It’s about using branch views, filespecs, and revisions together on the integrate command.
When you use a branch view with integrate, the branch view dictates the donor files. You can pass filespecs as command arguments, and when you do, the filespecs are assumed to be target files.
For example, let’s say that you want to integrate the src directory’s changes from V1 into MAIN. You can use the V1toMAIN branch view and supply MAIN’s src directory as a command argument:
p4 integ -b V1toMAIN //Ace/MAIN/src/...The donor files, in this case, are the files in //Ace/V1/src, as dictated by the V1toMAIN branch view.
Now, what if you wanted to cherry-pick and integrate V1’s change 3488 while limiting the scope to the src directory? Surprisingly, the syntax is:
p4 integ -b V1toMAIN //Ace/MAIN/src/...@3488,3488This is a surprise because the filespec //Ace/MAIN/src/...@3488,3488 is an empty set. The revision range @3488,3488 refers to files in V1, not MAIN. No files in MAIN were involved in changelist 3488.
The integrate command is special in that when you use a branch view, target filepecs, and donor revisions together, you must combine the donor revision with the target filespec. This quirky syntax overloading applies only when you use a branch view. Without a branch view, you must supply both a donor and a target filespec; the donor revision is attached to the donor filespec, as you would expect:
p4 integ //Ace/V1/src/...@3488,3488 //Ace/MAIN/src/...[*] "Open,” as you recall, is Perforce’s term describing files you plan to submit.
[*] The root of this misunderstanding may be that the integrate command always cites donor files rather than target files in error messages about views. For example, say you’re integrating a/foo.c into b/foo.c. You’ll get the message a/foo.c - no target file(s) in both client and branch view if the b/... path is not in your view.
[*] interchanges is a new Perforce command; it’s still nominally undocumented. (It’s actually documented in p4 help undoc, but it’s not guaranteed to behave the same way, or even be available, in future releases.)
[*] In fact, integrate can even open files for importing from another Perforce domain, if the donor path is in a remote depot. See Chapter 6.
[*] When you submit files that have been resolved by copying, Perforce doesn’t actually send your workspace files to the depot. It simply makes lazy copies, as described in Chapter 4.
[*] @3459, @3459 is syntactically equivalent to @=3459. However, because the former syntax can be used to select a sequence of revisions, it’s often more useful than the latter for cherry-picking.
[*] comm is a program that compares lists. It comes with Unix; several Windows toolkits offer it as well. The comm command requires alphabetically sorted input; hence the need for sort. Both Windows and Unix have sort commands that can be used to filter the output of P4 commands.
[*] There is a big difference between Release 2004.2 and previous releases of Perforce when it comes to picking the revision to use as the base for merging. As of Release 2004.2, the Perforce Server uses the common ancestor as the merge base. In previous releases, it used either the closest revision of the donor that had already been integrated or—if nothing had ever been integrated from it—the first revision of the donor.
[*] Editing a file simply to remove conflict markers is not considered a change to the content of a merged file.
Get Practical Perforce now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
