Why Source Control?
When working with computer code, you may have run into a tricky situation: while making changes to try to solve a difficult problem, your code gets so far from its original state that it's nearly impossible to get it running again. It would be great if you could roll back your code to the last working version, and start again from there, wouldn't it?
Or: you may be working with other people, and need to keep everyone's code in sync with everyone else's. Copying files around manually, or opening them off a shared folder, can cause problems when two people make changes in the same file, or if one person starts a very extensive project that breaks the program for everyone else. You really need a system where people can work independently, but still merge their changes together into a canonical location.
Or: you want to open-source your code, so that other people can use it and possibly send you improvements. You want to keep track of who has contributed, so that everyone can get credit for their work, and you'd also prefer to be as safe as possible when accepting patches. Now you have all the problems of group collaboration, plus problems of hosting and security.
The solution to all three of these problems, and many more, is a source control system. At its simplest level, source control is just a way of keeping a copy of all the changes that are made to your code over time. However, most of them also offer powerful utilities for merging, managing, and sharing source code. For this chapter, we'll be talking about Git, but the basic concepts apply to other systems, such as Subversion and Mercurial.
What does Git do?
Git works by taking snapshots of your files and their contents at a given moment in time and storing those in a repository--a kind of database. Each of these snapshots is called a commit. Between one commit and the next, Git tracks the changes that you make--new files, changes to existing files, and file deletions. Using Git, we can track our work similar to the "track changes" feature in word processors. If we make a mistake, we can use Git to revert back to an earlier, working state. It's like a universal undo function for all your source code.
As you can imagine, source control is crucial to working on software teams, and yet it's strangely under-taught by many academic programs. In this chapter, I hope to remedy that. Even working individually, and on non-traditional projects, source control systems can be incredibly helpful to you. In fact, this book was written using Git extensively to track its history and share the current version of the code between the two or three computers that I typically use for writing. You can visit its repository and see my commit history at https://github.com/thomaswilburn/textbook.
The World's Smallest Git Tutorial
First, you'll need to download Git and install it on your computer. You can get an installer for all major operating systems here. Once you've done that, open up a command line (on Windows, the installer creates a shortcut in your Start Menu named "Git Bash" that opens a UNIX-like command line for you, but the regular Command Prompt or PowerShell programs will work as well).
If you haven't used a command line very much, this may be both exciting and scary. After all, it's not a particularly user-friendly interface. On the plus side, it feels a bit like being a hacker in a big-budget Hollywood film. But don't worry! For the purposes of this tutorial, what you mainly need to be able to do is explore and change directories, which are very similar commands across all three operating systems. To list all the files and folders in your current directory, use the ls or dir commands. To change directories, type cd, followed by the name of the directory you want to open, and press enter. To go up a directory, use cd .. (".." is always the directory above the current location).
In this example, I open up the textbook folder on my desktop using Windows Powershell. It will look a little different on other operating systems, but the basics are the same.
//ls works on everything except the Windows Command Prompt
//For Command Prompt, use "dir" instead.
Directory: C:\Users\Thomas Wilburn\Desktop
Mode LastWriteTime Length Name
---- ------------- ------ ----
d---- 5/18/2013 9:38 AM crypto2
d---- 1/27/2013 3:12 PM SafeInCloud_Portable
d---- 3/26/2013 9:47 PM SCCC
d---- 5/19/2013 1:29 PM textbook
d---- 4/30/2013 8:34 PM webgl
-a--- 11/28/2012 11:26 PM 59 chrome_remote.bat
-a--- 5/3/2013 1:35 PM 308 GitHub.appref-ms
-a--- 1/15/2013 1:12 PM 2208 Google Chrome.lnk
-a--- 7/13/2011 4:22 AM 483328 putty.exe
C:\Users\Thomas Wilburn\Desktop>cd textbook
//The prompt updates when I change directories
To get started, let's create a blank repository. First, make an empty folder, then navigate to it on the command line and type the following command.
You should see a response like "Initialized empty Git repository in Your/Directory/Path/.git/" after this command. If you can see hidden files in your file manager, you'll also see a ".git" folder created: this is where Git keeps its database of file changes.
Now, create a file in the directory named "first.txt" and type several lines of text into it using your favorite editor (I always find a haiku to be a relaxing source of sample text). We're going to tell Git to track this file and save a snapshot of it. Back at the command line, type the following commands:
git add first.txt
git commit -m "Hello, world!"
[master (root-commit) 306d187] Hello, world!
1 file changed, 1 insertion(+)
create mode 100644 first.txt
The git add command tells git that we want it to add this file to our next snapshot. Git will stay aware of changes to all files in its directory, but it won't actually take snapshots unless you add them. You can always type git add * to add them all, if you've changed or created lots of files. The next command, git commit, actually saves the snapshot to Git's history. By appending -m "Hello, world!", we also added a commit message, which we can use to keep track of what changes were made in this snapshot (it's probably a good idea to use more descriptive messages than "Hello, world" in your real repositories).
To see the history of your repository, type:
You should see a list of all the commits you've made so far (just one, if you've been following along). You can make whatever changes you want to first.txt, or to other files, and commit those as well, and all their history will be saved.
Now, let's see how Git can help you recover from mistakes. First, erase the contents of first.txt and save it. Now, let's get the last snapshot back out of our repository. On your command line, run a git log, then look for the commit ID hash (highlighted below):
Author: Thomas Wilburn
Every commit gets a long, hexadecimal ID number generated by the system. Luckily, you don't have to type the whole thing--if you give Git enough digits, it'll figure out the rest. For the commit above, to restore the first.txt file, we can use the following command:
git checkout 306d187 first.txt
And voila! Our file contents are back to their snapshotted state. In fact, this can be even easier: if we know that we want to revert to the last commit (say, to roll back all the changes we've made since then), we can just check out the HEAD commit (as in "head of the line," since Git models your commits as a timeline flowing away into the past). Just type git checkout head * to revert all files to their previous versions.
Beyond the Basics
These few operations--init, add, commit, log, and checkout--are the minimum necessary to start using Git, but they don't even touch on its powerful features for collaboration and workflow. If you'd like to learn more, it's probably a good idea to start with a graphical client, which will abstract away the command line so that you can be immediately productive. There are a couple of good, free Git clients available: GitHub offers an easy-to-use program that also connects with its hosted repository service, and SourceTree provides a more powerful set of commands, including a timeline visualization of commits.
Once you do feel like getting more well-acquainted with Git's command line options, be sure to check out the free Pro Git textbook available at the Git home page. It covers everything you'd want to know, and more. The page also links to videos and detailed reference materials.
Finally, it would be a good idea to be familiar with other source control systems. The most common options in the open-source world are Subversion and Mercurial. Although they differ from Git in many ways, the basic workflow--committing and checking out--is much the same.