Difference between revisions of "Guide to FS Open and git"

From FreeSpace Wiki
Jump to: navigation, search
(Getting the source: Tortoise Git)
(Getting the source: Tortoise Git)
Line 12: Line 12:
** You'll need a fair bit of space for the code + the intermediate files when building it.
** You'll need a fair bit of space for the code + the intermediate files when building it.
* Press right mouse and choose Git Clone from the list.
* Press right mouse and choose Git Clone from the list.
| cmdlinetxt=N/A; see next step
Line 18: Line 19:
** (https://github.com/scp-fs2open/fs2open.github.com.git)
** (https://github.com/scp-fs2open/fs2open.github.com.git)
* Press OK to begin downloading from the repository (this may take a few minutes, depending on the speed of your internet connection)
* Press OK to begin downloading from the repository (this may take a few minutes, depending on the speed of your internet connection)
| cmdlinetxt=git clone https://github.com/scp-fs2open/fs2open.github.com.git
<div style="clear: both"></div>
<div style="clear: both"></div>

Revision as of 22:45, 26 August 2015

Getting the source: Tortoise Git

(based on a previous revision of Getting_the_FreeSpace2:_SCP_Source_Code)

Note: this is intended for people who want to get the code and compile executables. If you want to write code & submit patches, see the next section
  • Download and install Git For Windows (this is a dependency for TortoiseGit)
  • Download and install TortoiseGit (you probably need to reboot after installing)
  • Make a new folder on your HDD where you'd like to install the code.
    • You'll need a fair bit of space for the code + the intermediate files when building it.
  • Press right mouse and choose Git Clone from the list.


Git Command Line Equivalent: N/A; see next step

  • A new window will open up. Cut and paste the URL of the FSO Github repository into the URL of repository box
  • Press OK to begin downloading from the repository (this may take a few minutes, depending on the speed of your internet connection)


Git Command Line Equivalent: git clone https://github.com/scp-fs2open/fs2open.github.com.git

Simple Development: Tortoise Git

Note: The guide assumes that you will be developing using a github fork (which is recommended for everyone, SCP members and non-members alike)


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Record the URL for your newly forked copy of the FSO repository


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Install the software and get the code per the guide above
    • Note: you need to use the URL for your forked repository, not the main FSO repository listed above
  • Right click on the repository directory and select TortoiseGit -> Create Branch
    • Note: all development should be done in a new branch, instead of being done in the "master" branch. It's just simpler


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • In the new window, enter the name for the new branch, verify that the branch is based on HEAD (master) and check the "Switch to new branch" box


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Write some code with your Editor of Choice
  • Test your new code
  • When you're happy with the code, right click on the repository directory and select TortoiseGit -> Diff


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Review your changes by double-clicking on all the files listed in the new window (ensure no unwanted changes have snuck in!).


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • This is how the diff will be displayed (using TortoiseGitMerge, which is also used to resolve conflicts)


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • When your review is complete, press "Commit" (in the same window that you double clicked on all the changed files)
  • In the new window, add a commit message and press OK


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • When the commit is complete, press the "push" button to send your commit(s) to your github repository


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Select your local branch name from the drop down list and ensure your Destination -> Remote: is "origin"
  • If you want to, you can give the public remote branch a different name to your local branch (this can be useful when rebasing a branch already published to your public repository)
  • Finally, press OK


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Go to your Github Repository webpage and select the branch you just pushed


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • When you have the correct branch selected, click on the "Pull/Review/Compare" button


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Now click on "Create Pull Request"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Note: The previous three steps can be done as a single step if you have recently pushed a branch by selecting the "Compare and Pull Request" button
  • Add comments to the pull request if you wish, then click "Send Pull Request"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • That's it! Now wait for the pull request to be reviewed and committed to primary FSO master branch

Syncing: Tortoise Git


This section will go over synchronizing your local git repo with a remote

Once you've committed to your local git repo and verified its integrity (a simple build-check will suffice), you should update the remote repo through the "Push" process.

  • Right click on the repository directory and select "Push..."


Git Command Line Equivalent: {{{cmdlinetxt}}}

The Push dialog is displayed. From here, you can push one or more branches from one repo to another, local and remote alike. The "Ref" control group will be the repo that will be pushed onto the repo specified in the "Destination" control group. If you are managing multiple remotes, you may also push one remote to another.

For now, we'll focus on just pushing our local repo onto the remote.

  • Select the branch from the local repo in the "Ref" control group
  • Select the branch from the remote repo you wish to push to in the "Destination" control group.
  • Click OK to start the push

If a conflict between the remote repo and your local repo arises, git will halt the push. Otherwise it should complete as shown below.


Git Command Line Equivalent: {{{cmdlinetxt}}}


This section will go over pulling commits from an "upstream" remote (assuming that you're developing in a github forked repo and you want to get new commits from the "official" repo)

If you don't already have it, add the official repo as a remote called "upstream"

  • Right click on your local repo dir
  • Select TortoiseGit -> Settings


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • You should be prompted if you want to "...fetch remote branches...", select "Yes"


Git Command Line Equivalent: {{{cmdlinetxt}}}

The defaults in the next screen are fine, click OK to "fetch" all the "upstream" commits


Git Command Line Equivalent: {{{cmdlinetxt}}}

Now we "pull" the commits from the upstream master into our own master

  • Switch to your local repo master branch (optional really, you can set this in the next step)
  • Right click on the local repo directory and select "Git Sync"
  • Click on the chooser next to the remote branch dropdown


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Select the upstream remote repo in the left hand window
  • Select the master remote branch in the right hand window
  • Click OK


Git Command Line Equivalent: {{{cmdlinetxt}}}

We're back to the previous window. Note how the remote repo and remote branch dropdowns are set to upstream/master

  • Click on Pull to import commits
  • Wait until the process completes... and that is it
  • As always you can use "Show Log" to review the new commits


Git Command Line Equivalent: {{{cmdlinetxt}}}

Resolving Conflicts

This is a simple example of how to resolve a conflict that occurs when you try to push changes to a public repo. This example specifically used:

  • A github "personal" repo cloned from another "master" repo
  • A branch with conflicting changes; one computer committed changes to a file, while the 2nd computer (running TGit) committed changes to the same lines in that file.
  • And yes, the changes are silly

Here's the commit from the other computer.


Git Command Line Equivalent: {{{cmdlinetxt}}}

Here's the commit in your local repo that you're about to push to the same branch.


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Right click and select "push", accept all the defaults


Git Command Line Equivalent: {{{cmdlinetxt}}}

As expected that didn't work...


Git Command Line Equivalent: {{{cmdlinetxt}}}

As suggested, try a pull with the default options.


Git Command Line Equivalent: {{{cmdlinetxt}}}

As expected we have merge conflicts.


Git Command Line Equivalent: {{{cmdlinetxt}}}

At this "yes / no" prompt either options can be picked, it'll be a bit quicker to pick "yes" if you want to resolve the conflict now.


Git Command Line Equivalent: {{{cmdlinetxt}}}

If you didn't pick yes in the previous step, you can get this window by select "Diff" from the TGit menu

  • Start TGitMerge by doubling clicking on a file that has the status of "conflict" (only one file in this example)


Git Command Line Equivalent: {{{cmdlinetxt}}}

"Resolve the conflict" (often simpler said than done). Some tips are available here.


Git Command Line Equivalent: {{{cmdlinetxt}}}

Since this is a trivial example, I've used an equally trivial resolution of taking one line from remote repo and one from the local repo.

  • When you're finished, click on the save button


Git Command Line Equivalent: {{{cmdlinetxt}}}

A prompt should appear asking if you want to mark the conflict as resolved.

  • If you're happy with the resolution, select yes
  • If you've messed something up and want to start over, select no


Git Command Line Equivalent: {{{cmdlinetxt}}}

Note that the Diff window hasn't updated, it still says the file has a conflict :/ If you double click on the file however, nothing will happen.

  • Since the conflict is resolved and there was only one file with a conflict, close the Diff window.


Git Command Line Equivalent: {{{cmdlinetxt}}}

Commit your changes

  • Right click and select "Commit -> {Branch Name}"
    • As an alternative, you could probably have clicked commit in the Diff window (previous step)
  • The default commit message is fine in this case, so just click OK


Git Command Line Equivalent: {{{cmdlinetxt}}}

The commit was successful.


Git Command Line Equivalent: {{{cmdlinetxt}}}

Now back to what was originally wanted - push the changes to the remote repo

  • Enter your username & password when prompted


Git Command Line Equivalent: {{{cmdlinetxt}}}



Git Command Line Equivalent: {{{cmdlinetxt}}}

Collaboration with remotes: Tortoise Git

Here we'll go through:

  • adding a remote branch from someone else's repository
  • committing to that branch and pushing it back to your own repository

You may do this when you're collaborating on a feature prior to it being committed to the master

  • Start by right clicking on the local repository directory and selecting "Settings"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Select the "Remote" item from the left hand menu, then
    • add a local name for the new remote repository
    • add the remote repository URL (I'm using m!m's github repository in this example)
    • Set the "Tags" dropdown to "None"
    • Click "Add New/Save"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • You should be prompted if you want to "...fetch remote branches...", select "Yes"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • All the defaults should be fine, click "OK"
  • Note that this step may take a little time


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • When it's complete you want to create a local branch to track one of the remote repositories branches
  • Right click on the local repository directory and select "Create Branch..."


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Set "Base On" -> "Branch" to the remote branch you want to work on
  • Check "Switch to new branch"
  • Click "OK"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Write some code!
  • When you're ready to commit, right click on the local repository directory and select "Git Commit -> (branchname)..."


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Enter a commit message
  • Review the changes that will make up the commit by double-clicking on files in the list


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • When the commit is completed there will be a button to "Push" your branch.
  • You probably won't have permission to push to the other persons remote branch, so push to your own remote repository
  • Optionally change the remote branch name (e.g. with a reference to the remote it can from)
  • Select "Origin" as your "Destination" -> "Remote"
  • Click "OK"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Now you can tell the other person that you've added to their branch and have pushed the changes to your own remote branch
  • They can now follow (most of) the steps above to add your repository as (to them) a remote and fetch/merge your changes into their branch
  • When that happens you probably want to get their changes into your local branch
  • Firstly ensure that you have the branch to want to merge into selected
  • Right click on the repository directory and select "Fetch..."


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Select the correct remote repository from the dropdown


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Right click on the repository directory and select "Merge..."


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Select the correct remote branch to merge from
  • Click OK and you're done (assuming there are no merge conflicts of course...)


Git Command Line Equivalent: {{{cmdlinetxt}}}

Patches: TortoiseGit

(from http://www.hard-light.net/forums/index.php?topic=83453.msg1736781#msg1736781, written by m!m)

Creating Patches

Just choose the "Create Patch Serial" from the context menu.


Git Command Line Equivalent: {{{cmdlinetxt}}}

In the window choose from which point onwards the patch should be created, master is probably a good idea. Once you hit OK TGit will create a number of patch files in your repository which you can then transfer to the other repository.


Git Command Line Equivalent: {{{cmdlinetxt}}}

Applying patches

To apply a patch serial choose "Apply Patch Serial". You will need to select the patch files from the previous step and possibly rearrange them (in most cases the default ordering should be sufficient though).


Git Command Line Equivalent: {{{cmdlinetxt}}}

Hit Apply and TGit will start creating commits with the changes in the patch files.


Git Command Line Equivalent: {{{cmdlinetxt}}}

If there are conflicts you will need to resolve or skip them.


Git Command Line Equivalent: {{{cmdlinetxt}}}

When that is finished you will have all the changes from the patches in your repository.

Applying old patches plus conflict resolution: TortoiseGit

Here's one way to apply old patches using git. When I say "old patch", I mean a patch that you almost certainly know is going to have conflicts. This is based off a technique I've used with the git command line. It may be that TortoiseGit provides alternate ways of achieving this, however the advantage of this technique is that it's very similar to the conflict resolution that you may need to do when syncing your repo (plus I have a good example in one of Axem's patches that's been floating around for... nearly 2.5 years!) And I really hate dealing with .rej files, I find the graphical tools used in this method make conflict resolution much easier (of course YMMV depending on your experience/preference!)


  • Before you start, ensure that your master is up to date (perform a Sync / Pull)
  • Start with creating a new branch (i.e. the typical git response when you want to do almost anything! :))
  • The only trick is that you want to create the branch based on a specific commit - in this case the commit that the patch was based on
    • Right Click -> TortoiseGit -> Show Log is your friend in finding the commit revision you need to select


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Save the patch to a file and copy it to somewhere inside the git repository
    • depending on the paths in the patch, the exact location of the patch file *may* matter (I haven't personally tested this)
  • Right Click on the patch file, then select TortoiseGit -> Review/apply single patch


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • TortiseGitMerge should start with an extra window displayed
  • Click "Patch all items" in the extra window to apply the patch
    • If you started the branch at the correct revision the patch *should* apply correctly without any editing
  • When done, close both windows (no save is required)


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Next commit the changes to your branch (this is pretty much the normal commit process)


Git Command Line Equivalent: {{{cmdlinetxt}}}

Now we're onto something new - you are going to "rebase" the current master onto your branch. The sequence of steps is basically, remove the patch you applied, then in order apply all the commits from master to your branch, *and then* reapply the patch "on top" of all those changes. This is different to a "merge" which is more like applying all the commits from master "on top" of your current patch

Warning: DO NOT EVER perform a rebase on a branch that you have pushed to a public repository. A rebase changes the previously published commit history which will cause pain for anyone else who has started using your published branch. Perform a "merge" instead. Or maybe create a new branch based off your existing branch, then rebase *the new* local branch and push to a *new* public branch.
  • Right click on the repository directory, select TortoiseGit -> Rebase
  • Select "master" as the upstream
  • Click "Start Rebase"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • As expected, the "Rebase" fails due to conflicts
  • Check which files failed, then double click on each file to resolve the conflicts


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • The TortoiseGitMerge window should open. This a a graphical interface that assists with conflict resolution.
  • The three windows show code from:
    • the master branch (Theirs - REMOTE for a rebase)
    • your branch + patch (Mine - LOCAL)
    • the output of your conflict resolution (Merged - filename)
  • Non conflicting changes should be automatically merged
  • Conflicts are marked in red highlight, and their are "Previous Conflict" and "Next Conflict" buttons at the top of the screen to move between conflicts in this file


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • The conflict in this file is simple to resolve
  • Right click on the numbers in the "Theirs" window and select "Use text block from 'theirs' before 'mine'"
  • Note the red "????" lines in merged window turn green to show the conflict has been resolved


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • That's all for this file, click "Save" then select "Mark as Resolved"


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Close the window, and that's one file down, two to go! (which I'll skip over in this case)


Git Command Line Equivalent: {{{cmdlinetxt}}}

  • Once all the files with conflicts are resolved, click "Commit" to complete the process
  • TortoiseGit -> Show Log is very useful to double check that you got the commit right before pushing it to a public repo
  • If you didn't get it right, edit the files in your normal IDE to fix the mistakes, make another commit and "squash" the two commits together before pushing to a public repository
  • As a last resort if the rebase is beyond saving, simply delete the branch and start again

TortoiseGitMerge Tips

Merge Conflict Tips:

  • The best way to resolve merge conflicts is to avoid them altogether in the first place. This is because it's more likely to induce bugs or unintended behavior whenever manual conflict resolutions come into play.
  • Git offers a few conflict resolution strategies. See the Git documentation on "git merge -strategy" to see if one of them can solve most of the conflicts for you.
  • Never, Ever, try to resolve the conflicts by writing your own .diff or patch. Use the merge tools available to you. Besides simple "Theirs, Mine" resolutions, most of them allow editing, too.
  • If possible, find a merge tool that show you four windows: (unfortunately TGitMerge doesn't do this, only merge tool like this that I've found so far is kdiff3)
    • Your changes
    • Their changes
    • Output / merged results
    • Common ancestor (this is what most tools seem to omit - showing the original code can really clarify what's going on without needing to open another window & find the ancestor yourself)

Local Merge Conflicts: Merging branches

  • If you find that a branch has conflicts when doing a merge, retrieve the commit log for the branch your merging into and save the commit as a unified diff. Use this as a reference during conflict resolutions to ensure you get only the changes that you have made.
  • If you find that a branch has conflicts with files that have nothing to do with the changes you made in the commit, you can quickly choose "Solve Conflict Using Theirs" or "Solve Conflict Using Mine" from the commit dialog by right clicking on the file. This will help reduce the number of files you'll have to spot check to just the ones you made changes to.

Lastly, here's a list of some of the tools offered by TortoiseGitMerge which can help with conflict resolution (the list has some overlap with stuff I've already mentioned)

  • Right click the line numbers in the "theirs" or "mine" windows to select "text blocks" which will be applied to the "merged" window
  • For simple conflicts you can choose "theirs then mine" or vice versa from the right click menu
  • By clicking on the line numbers on the left hand side you can select individual lines to apply
  • Similarly you can select multiple lines by click/dragging on the line numbers
  • When "theirs/mine" lines are selected another right-click option becomes available, "copy". These lines can then be pasted to "merged"
  • You can also make edits in the "merged" window just like any other text editor
  • Use the "Next/Previous Commit" buttons to rapidly find the conflicts
  • Click the "Mark as Resolved" button when you're done. This not only saves your changes/selections, but also clears the conflict flags from the file. If the commit dialog still shows the resolved file as in-conflict, you can right click on the file name and select "Resolved" to mark it as resolved.

General Repo Housekeeping

Doing a full fork of the scp-fs2open codebase will likely leave you with a number of branches that won't be of much interest to you. Thankfully, you can prune off the unwanted/unneeded branches from your fork leaving only the branches you will be working on. Should you decide that you want to see what's going on in any of the other branches (such as antipodes), you can still issue a pull from "upstream".

  • Check out all the branches that you want to work on from origin onto your local machine
  • In the git console, issue a "git push origin --prune" to start the process. Git may give you a warning message about the push.default setting, you may safely ignore this.
  • Check on the status of your pruning using either github's web page or by issuing "git branch -r" to the git console