diff options
author | Junio C Hamano <junkio@cox.net> | 2005-08-30 23:11:12 -0700 |
---|---|---|
committer | Junio C Hamano <junkio@cox.net> | 2005-08-30 23:11:12 -0700 |
commit | 466fede1bdfd55c78b71c71547b5b5a70adbaef2 (patch) | |
tree | e205fd7fafce8dc0a46cb27e3254dcf71794c072 | |
parent | Merge refs/heads/master from . (diff) | |
parent | Update tutorial. (diff) | |
download | tgif-466fede1bdfd55c78b71c71547b5b5a70adbaef2.tar.xz |
Merge refs/heads/master from .
-rw-r--r-- | Documentation/tutorial.txt | 661 | ||||
-rwxr-xr-x | git-archimport-script | 593 | ||||
-rw-r--r-- | show-branch.c | 2 |
3 files changed, 965 insertions, 291 deletions
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index 0c7d85d7cb..1ed8038f79 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -47,7 +47,7 @@ to which git will reply defaulting to local storage area which is just git's way of saying that you haven't been doing anything -strange, and that it will have created a local .git directory setup for +strange, and that it will have created a local `.git` directory setup for your new project. You will now have a `.git` directory, and you can inspect that with `ls`. For your new empty project, it should show you three entries, among other things: @@ -55,7 +55,7 @@ three entries, among other things: - a symlink called `HEAD`, pointing to `refs/heads/master` + Don't worry about the fact that the file that the `HEAD` link points to -doesn't even exist yet - you haven't created the commit that will +doesn't even exist yet -- you haven't created the commit that will start your `HEAD` development branch yet. - a subdirectory called `objects`, which will contain all the @@ -84,13 +84,13 @@ branch. A number of the git tools will assume that `.git/HEAD` is valid, though. [NOTE] -An "object" is identified by its 160-bit SHA1 hash, aka "name", +An 'object' is identified by its 160-bit SHA1 hash, aka 'object name', and a reference to an object is always the 40-byte hex -representation of that SHA1 name. The files in the "refs" +representation of that SHA1 name. The files in the `refs` subdirectory are expected to contain these hex references -(usually with a final '\n' at the end), and you should thus +(usually with a final `\'\n\'` at the end), and you should thus expect to see a number of 41-byte files containing these -references in this refs subdirectories when you actually start +references in these `refs` subdirectories when you actually start populating your tree. You have now created your first git repository. Of course, since it's @@ -112,10 +112,10 @@ echo "Hello World" >hello echo "Silly example" >example ------------------------------------------------ -you have now created two files in your working tree (aka "working directory"), but to +you have now created two files in your working tree (aka 'working directory'), but to actually check in your hard work, you will have to go through two steps: - - fill in the "index" file (aka "cache") with the information about your + - fill in the 'index' file (aka 'cache') with the information about your working tree state. - commit that index file as an object. @@ -125,8 +125,8 @@ to your working tree, you use the `git-update-cache` program. That program normally just takes a list of filenames you want to update, but to avoid trivial mistakes, it refuses to add new entries to the cache (or remove existing ones) unless you explicitly tell it that you're -adding a new entry with the `--add` flag (or removing an entry with the -`--remove`) flag. +adding a new entry with the `\--add` flag (or removing an entry with the +`\--remove`) flag. So to populate the index with the two files you just created, you can do @@ -150,25 +150,25 @@ and see two files: which correspond with the objects with names of 557db... and f24c7.. respectively. -If you want to, you can use "git-cat-file" to look at those objects, but +If you want to, you can use `git-cat-file` to look at those objects, but you'll have to use the object name, not the filename of the object: git-cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 -where the "-t" tells git-cat-file to tell you what the "type" of the +where the `-t` tells `git-cat-file` to tell you what the "type" of the object is. Git will tell you that you have a "blob" object (ie just a regular file), and you can see the contents with git-cat-file "blob" 557db03 which will print out "Hello World". The object 557db03 is nothing -more than the contents of your file "hello". +more than the contents of your file `hello`. [NOTE] -Don't confuse that object with the file "hello" itself. The -object is literally just those specific _contents_ of the file, and -however much you later change the contents in file "hello", the object we -just looked at will never change. Objects are immutable. +Don't confuse that object with the file `hello` itself. The +object is literally just those specific *contents* of the file, and +however much you later change the contents in file `hello`, the object +we just looked at will never change. Objects are immutable. [NOTE] The second example demonstrates that you can @@ -187,54 +187,57 @@ file. This is the index that describes your current working tree, and something you should be very aware of. Again, you normally never worry about the index file itself, but you should be aware of the fact that you have not actually really "checked in" your files into git so far, -you've only _told_ git about them. +you've only *told* git about them. However, since git knows about them, you can now start using some of the most basic git commands to manipulate the files or look at their status. In particular, let's not even check in the two files into git yet, we'll -start off by adding another line to "hello" first: +start off by adding another line to `hello` first: ------------------------------------------------ echo "It's a new day for git" >>hello ------------------------------------------------ -and you can now, since you told git about the previous state of "hello", ask +and you can now, since you told git about the previous state of `hello`, ask git what has changed in the tree compared to your old index, using the -"git-diff-files" command: +`git-diff-files` command: - git-diff-files +------------ +git-diff-files +------------ Oops. That wasn't very readable. It just spit out its own internal -version of a "diff", but that internal version really just tells you +version of a `diff`, but that internal version really just tells you that it has noticed that "hello" has been modified, and that the old object contents it had have been replaced with something else. To make it readable, we can tell git-diff-files to output the -differences as a patch, using the "-p" flag: +differences as a patch, using the `-p` flag: - git-diff-files -p +------------ +git-diff-files -p +------------ which will spit out - diff --git a/hello b/hello - --- a/hello - +++ b/hello - @@ -1 +1,2 @@ - Hello World - +It's a new day for git +------------ +diff --git a/hello b/hello +--- a/hello ++++ b/hello +@@ -1 +1,2 @@ + Hello World ++It's a new day for git +---- -ie the diff of the change we caused by adding another line to "hello". +i.e. the diff of the change we caused by adding another line to `hello`. -In other words, git-diff-files always shows us the difference between +In other words, `git-diff-files` always shows us the difference between what is recorded in the index, and what is currently in the working tree. That's very useful. -A common shorthand for "git-diff-files -p" is to just write - - git diff - -which will do the same thing. +A common shorthand for `git-diff-files -p` is to just write `git +diff`, which will do the same thing. Committing git state @@ -242,11 +245,11 @@ Committing git state Now, we want to go to the next stage in git, which is to take the files that git knows about in the index, and commit them as a real tree. We do -that in two phases: creating a "tree" object, and committing that "tree" -object as a "commit" object together with an explanation of what the +that in two phases: creating a 'tree' object, and committing that 'tree' +object as a 'commit' object together with an explanation of what the tree was all about, along with information of how we came to that state. -Creating a tree object is trivial, and is done with "git-write-tree". +Creating a tree object is trivial, and is done with `git-write-tree`. There are no options or other input: git-write-tree will take the current index state, and write an object that describes that whole index. In other words, we're now tying together all the different @@ -263,27 +266,28 @@ and this will just output the name of the resulting tree, in this case 8988da15d077d4829fc51d8544c097def6644dbb which is another incomprehensible object name. Again, if you want to, -you can use "git-cat-file -t 8988d.." to see that this time the object +you can use `git-cat-file -t 8988d\...` to see that this time the object is not a "blob" object, but a "tree" object (you can also use -git-cat-file to actually output the raw object contents, but you'll see +`git-cat-file` to actually output the raw object contents, but you'll see mainly a binary mess, so that's less interesting). -However - normally you'd never use "git-write-tree" on its own, because +However -- normally you'd never use `git-write-tree` on its own, because normally you always commit a tree into a commit object using the -"git-commit-tree" command. In fact, it's easier to not actually use -git-write-tree on its own at all, but to just pass its result in as an -argument to "git-commit-tree". +`git-commit-tree` command. In fact, it's easier to not actually use +`git-write-tree` on its own at all, but to just pass its result in as an +argument to `git-commit-tree`. -"git-commit-tree" normally takes several arguments - it wants to know -what the _parent_ of a commit was, but since this is the first commit +`git-commit-tree` normally takes several arguments -- it wants to know +what the 'parent' of a commit was, but since this is the first commit ever in this new repository, and it has no parents, we only need to pass in -the object name of the tree. However, git-commit-tree also wants to get a commit message +the object name of the tree. However, `git-commit-tree` +also wants to get a commit message on its standard input, and it will write out the resulting object name for the commit to its standard output. -And this is where we start using the .git/HEAD file. The HEAD file is +And this is where we start using the `.git/HEAD` file. The `HEAD` file is supposed to contain the reference to the top-of-tree, and since that's -exactly what git-commit-tree spits out, we can do this all with a simple +exactly what `git-commit-tree` spits out, we can do this all with a simple shell pipeline: ------------------------------------------------ @@ -295,52 +299,49 @@ which will say: Committing initial tree 8988da15d077d4829fc51d8544c097def6644dbb just to warn you about the fact that it created a totally new commit -that is not related to anything else. Normally you do this only _once_ +that is not related to anything else. Normally you do this only *once* for a project ever, and all later commits will be parented on top of an earlier commit, and you'll never see this "Committing initial tree" message ever again. Again, normally you'd never actually do this by hand. There is a -helpful script called "git commit" that will do all of this for you. So -you could have just written - - git commit - +helpful script called `git commit` that will do all of this for you. So +you could have just written `git commit` instead, and it would have done the above magic scripting for you. Making a change --------------- -Remember how we did the "git-update-cache" on file "hello" and then we -changed "hello" afterward, and could compare the new state of "hello" with the +Remember how we did the `git-update-cache` on file `hello` and then we +changed `hello` afterward, and could compare the new state of `hello` with the state we saved in the index file? -Further, remember how I said that "git-write-tree" writes the contents -of the _index_ file to the tree, and thus what we just committed was in -fact the _original_ contents of the file "hello", not the new ones. We did +Further, remember how I said that `git-write-tree` writes the contents +of the *index* file to the tree, and thus what we just committed was in +fact the *original* contents of the file `hello`, not the new ones. We did that on purpose, to show the difference between the index state, and the state in the working tree, and how they don't have to match, even when we commit things. -As before, if we do "git-diff-files -p" in our git-tutorial project, +As before, if we do `git-diff-files -p` in our git-tutorial project, we'll still see the same difference we saw last time: the index file hasn't changed by the act of committing anything. However, now that we have committed something, we can also learn to use a new command: -"git-diff-cache". +`git-diff-cache`. -Unlike "git-diff-files", which showed the difference between the index -file and the working tree, "git-diff-cache" shows the differences -between a committed _tree_ and either the index file or the working -tree. In other words, git-diff-cache wants a tree to be diffed +Unlike `git-diff-files`, which showed the difference between the index +file and the working tree, `git-diff-cache` shows the differences +between a committed *tree* and either the index file or the working +tree. In other words, `git-diff-cache` wants a tree to be diffed against, and before we did the commit, we couldn't do that, because we didn't have anything to diff against. -But now we can do +But now we can do git-diff-cache -p HEAD -(where "-p" has the same meaning as it did in git-diff-files), and it +(where `-p` has the same meaning as it did in `git-diff-files`), and it will show us the same difference, but for a totally different reason. Now we're comparing the working tree not against the index file, but against the tree we just wrote. It just so happens that those two @@ -353,29 +354,31 @@ it with which ends up doing the above for you. -In other words, "git-diff-cache" normally compares a tree against the -working tree, but when given the "--cached" flag, it is told to +In other words, `git-diff-cache` normally compares a tree against the +working tree, but when given the `\--cached` flag, it is told to instead compare against just the index cache contents, and ignore the current working tree state entirely. Since we just wrote the index -file to HEAD, doing "git-diff-cache --cached -p HEAD" should thus return +file to HEAD, doing `git-diff-cache \--cached -p HEAD` should thus return an empty set of differences, and that's exactly what it does. [NOTE] -"git-diff-cache" really always uses the index for its +================ +`git-diff-cache` really always uses the index for its comparisons, and saying that it compares a tree against the working tree is thus not strictly accurate. In particular, the list of -files to compare (the "meta-data") _always_ comes from the index file, -regardless of whether the --cached flag is used or not. The --cached -flag really only determines whether the file _contents_ to be compared +files to compare (the "meta-data") *always* comes from the index file, +regardless of whether the `\--cached` flag is used or not. The `\--cached` +flag really only determines whether the file *contents* to be compared come from the working tree or not. -+ + This is not hard to understand, as soon as you realize that git simply never knows (or cares) about files that it is not told about -explicitly. Git will never go _looking_ for files to compare, it +explicitly. Git will never go *looking* for files to compare, it expects you to tell it what the files are, and that's what the index is there for. +================ -However, our next step is to commit the _change_ we did, and again, to +However, our next step is to commit the *change* we did, and again, to understand what's going on, keep in mind the difference between "working tree contents", "index file" and "committed tree". We have changes in the working tree that we want to commit, and we always have to @@ -386,20 +389,20 @@ update the index cache: git-update-cache hello ------------------------------------------------ -(note how we didn't need the "--add" flag this time, since git knew +(note how we didn't need the `\--add` flag this time, since git knew about the file already). -Note what happens to the different git-diff-xxx versions here. After -we've updated "hello" in the index, "git-diff-files -p" now shows no -differences, but "git-diff-cache -p HEAD" still _does_ show that the +Note what happens to the different `git-diff-\*` versions here. After +we've updated `hello` in the index, `git-diff-files -p` now shows no +differences, but `git-diff-cache -p HEAD` still *does* show that the current state is different from the state we committed. In fact, now -"git-diff-cache" shows the same difference whether we use the "--cached" +`git-diff-cache` shows the same difference whether we use the `--cached` flag or not, since now the index is coherent with the working tree. -Now, since we've updated "hello" in the index, we can commit the new +Now, since we've updated `hello` in the index, we can commit the new version. We could do it by writing the tree by hand again, and -committing the tree (this time we'd have to use the "-p HEAD" flag to -tell commit that the HEAD was the _parent_ of the new commit, and that +committing the tree (this time we'd have to use the `-p HEAD` flag to +tell commit that the HEAD was the *parent* of the new commit, and that this wasn't an initial commit any more), but you've done that once already, so let's just use the helpful script this time: @@ -414,13 +417,14 @@ Write whatever message you want, and all the lines that start with '#' will be pruned out, and the rest will be used as the commit message for the change. If you decide you don't want to commit anything after all at this point (you can continue to edit things and update the cache), you -can just leave an empty message. Otherwise git-commit-script will commit +can just leave an empty message. Otherwise `git commit` will commit the change for you. You've now made your first real git commit. And if you're interested in -looking at what git-commit-script really does, feel free to investigate: +looking at what `git commit` really does, feel free to investigate: it's a few very simple shell scripts to generate the helpful (?) commit -message headers, and a few one-liners that actually do the commit itself. +message headers, and a few one-liners that actually do the +commit itself (`git-commit-script`). Checking it out @@ -428,9 +432,9 @@ Checking it out While creating changes is useful, it's even more useful if you can tell later what changed. The most useful command for this is another of the -"diff" family, namely "git-diff-tree". +`diff` family, namely `git-diff-tree`. -git-diff-tree can be given two arbitrary trees, and it will tell you the +`git-diff-tree` can be given two arbitrary trees, and it will tell you the differences between them. Perhaps even more commonly, though, you can give it just a single commit object, and it will figure out the parent of that commit itself, and show the difference directly. Thus, to get @@ -438,18 +442,18 @@ the same diff that we've already seen several times, we can now do git-diff-tree -p HEAD -(again, "-p" means to show the difference as a human-readable patch), -and it will show what the last commit (in HEAD) actually changed. +(again, `-p` means to show the difference as a human-readable patch), +and it will show what the last commit (in `HEAD`) actually changed. -More interestingly, you can also give git-diff-tree the "-v" flag, which +More interestingly, you can also give `git-diff-tree` the `-v` flag, which tells it to also show the commit message and author and date of the commit, and you can tell it to show a whole series of diffs. Alternatively, you can tell it to be "silent", and not show the diffs at all, but just show the actual commit message. -In fact, together with the "git-rev-list" program (which generates a -list of revisions), git-diff-tree ends up being a veritable fount of -changes. A trivial (but very useful) script called "git-whatchanged" is +In fact, together with the `git-rev-list` program (which generates a +list of revisions), `git-diff-tree` ends up being a veritable fount of +changes. A trivial (but very useful) script called `git-whatchanged` is included with git which does exactly this, and shows a log of recent activities. @@ -468,8 +472,8 @@ and you will see exactly what has changed in the repository over its short history. [NOTE] -The "--root" flag is a flag to git-diff-tree to tell it to -show the initial aka "root" commit too. Normally you'd probably not +The `\--root` flag is a flag to `git-diff-tree` to tell it to +show the initial aka 'root' commit too. Normally you'd probably not want to see the initial import diff, but since the tutorial project was started from scratch and is so small, we use it to make the result a bit more interesting. @@ -481,11 +485,11 @@ can explore on your own. Most likely, you are not directly using the core git Plumbing commands, but using Porcelain like Cogito on top of it. Cogito works a bit differently and you usually do not -have to run "git-update-cache" yourself for changed files (you +have to run `git-update-cache` yourself for changed files (you do tell underlying git about additions and removals via -"cg-add" and "cg-rm" commands). Just before you make a commit -with "cg-commit", Cogito figures out which files you modified, -and runs "git-update-cache" on them for you. +`cg-add` and `cg-rm` commands). Just before you make a commit +with `cg-commit`, Cogito figures out which files you modified, +and runs `git-update-cache` on them for you. Tagging a version @@ -494,14 +498,14 @@ Tagging a version In git, there are two kinds of tags, a "light" one, and an "annotated tag". A "light" tag is technically nothing more than a branch, except we put -it in the ".git/refs/tags/" subdirectory instead of calling it a "head". +it in the `.git/refs/tags/` subdirectory instead of calling it a `head`. So the simplest form of tag involves nothing more than ------------------------------------------------ git tag my-first-tag ------------------------------------------------ -which just writes the current HEAD into the .git/refs/tags/my-first-tag +which just writes the current `HEAD` into the `.git/refs/tags/my-first-tag` file, after which point you can then use this symbolic name for that particular state. You can, for example, do @@ -514,18 +518,20 @@ since you tagged it. An "annotated tag" is actually a real git object, and contains not only a pointer to the state you want to tag, but also a small tag name and -message, along with optionally a PGP signature that says that yes, you really did -that tag. You create these signed tags with either the "-a" or "-s" flag to "git tag": +message, along with optionally a PGP signature that says that yes, +you really did +that tag. You create these annotated tags with either the `-a` or +`-s` flag to `git tag`: git tag -s <tagname> -which will sign the current HEAD (but you can also give it another +which will sign the current `HEAD` (but you can also give it another argument that specifies the thing to tag, ie you could have tagged the -current "mybranch" point by using "git tag <tagname> mybranch"). +current `mybranch` point by using `git tag <tagname> mybranch`). You normally only do signed tags for major releases or things like that, while the light-weight tags are useful for any marking you -want to do - any time you decide that you want to remember a certain +want to do -- any time you decide that you want to remember a certain point, just create a private tag for it, and you have a nice symbolic name for the state at that point. @@ -535,8 +541,8 @@ Copying repositories Git repositories are normally totally self-sufficient, and it's worth noting that unlike CVS, for example, there is no separate notion of -"repository" and "working tree". A git repository normally _is_ the -working tree, with the local git information hidden in the ".git" +"repository" and "working tree". A git repository normally *is* the +working tree, with the local git information hidden in the `.git` subdirectory. There is nothing else. What you see is what you got. [NOTE] @@ -558,38 +564,38 @@ and it will be gone. There's no external repository, and there's no history outside the project you created. - if you want to move or duplicate a git repository, you can do so. There - is "git clone" command, but if all you want to do is just to + is `git clone` command, but if all you want to do is just to create a copy of your repository (with all the full history that went along with it), you can do so with a regular - "cp -a git-tutorial new-git-tutorial". + `cp -a git-tutorial new-git-tutorial`. + Note that when you've moved or copied a git repository, your git index file (which caches various information, notably some of the "stat" information for the files involved) will likely need to be refreshed. -So after you do a "cp -a" to create a new copy, you'll want to do +So after you do a `cp -a` to create a new copy, you'll want to do git-update-cache --refresh + in the new repository to make sure that the index file is up-to-date. Note that the second point is true even across machines. You can -duplicate a remote git repository with _any_ regular copy mechanism, be it -"scp", "rsync" or "wget". +duplicate a remote git repository with *any* regular copy mechanism, be it +`scp`, `rsync` or `wget`. When copying a remote repository, you'll want to at a minimum update the index cache when you do this, and especially with other peoples' repositories you often want to make sure that the index cache is in some -known state (you don't know _what_ they've done and not yet checked in), -so usually you'll precede the "git-update-cache" with a +known state (you don't know *what* they've done and not yet checked in), +so usually you'll precede the `git-update-cache` with a git-read-tree --reset HEAD git-update-cache --refresh -which will force a total index re-build from the tree pointed to by HEAD. -It resets the index contents to HEAD, and then the git-update-cache +which will force a total index re-build from the tree pointed to by `HEAD`. +It resets the index contents to `HEAD`, and then the `git-update-cache` makes sure to match up all index entries with the checked-out files. If the original repository had uncommitted changes in its -working tree, "git-update-cache --refresh" notices them and +working tree, `git-update-cache --refresh` notices them and tells you they need to be updated. The above can also be written as simply @@ -597,21 +603,21 @@ The above can also be written as simply git reset and in fact a lot of the common git command combinations can be scripted -with the "git xyz" interfaces, and you can learn things by just looking +with the `git xyz` interfaces, and you can learn things by just looking at what the `git-*-script` scripts do (`git reset` is the above two lines -implemented in `git-reset-script`, but some things like "git status" and +implemented in `git-reset-script`, but some things like `git status` and `git commit` are slightly more complex scripts around the basic git commands). Many (most?) public remote repositories will not contain any of -the checked out files or even an index file, and will 'only' contain the +the checked out files or even an index file, and will *only* contain the actual core git files. Such a repository usually doesn't even have the `.git` subdirectory, but has all the git files directly in the repository. To create your own local live copy of such a "raw" git repository, you'd first create your own subdirectory for the project, and then copy the -raw repository contents into the ".git" directory. For example, to +raw repository contents into the `.git` directory. For example, to create your own copy of the git repository, you'd do the following mkdir my-git @@ -629,11 +635,11 @@ those, you'd check them out with git-checkout-cache -u -a -where the "-u" flag means that you want the checkout to keep the index +where the `-u` flag means that you want the checkout to keep the index up-to-date (so that you don't have to refresh it afterward), and the -"-a" flag means "check out all files" (if you have a stale copy or an -older version of a checked out tree you may also need to add the "-f" -flag first, to tell git-checkout-cache to _force_ overwriting of any old +`-a` flag means "check out all files" (if you have a stale copy or an +older version of a checked out tree you may also need to add the `-f` +flag first, to tell git-checkout-cache to *force* overwriting of any old files). Again, this can all be simplified with @@ -652,15 +658,15 @@ Creating a new branch --------------------- Branches in git are really nothing more than pointers into the git -object database from within the ".git/refs/" subdirectory, and as we -already discussed, the HEAD branch is nothing but a symlink to one of +object database from within the `.git/refs/` subdirectory, and as we +already discussed, the `HEAD` branch is nothing but a symlink to one of these object pointers. You can at any time create a new branch by just picking an arbitrary point in the project history, and just writing the SHA1 name of that -object into a file under .git/refs/heads/. You can use any filename you +object into a file under `.git/refs/heads/`. You can use any filename you want (and indeed, subdirectories), but the convention is that the -"normal" branch is called "master". That's just a convention, though, +"normal" branch is called `master`. That's just a convention, though, and nothing enforces it. To show that as an example, let's go back to the git-tutorial repository we @@ -671,23 +677,23 @@ saying that you want to check out a new branch: git checkout -b mybranch ------------ -will create a new branch based at the current HEAD position, and switch +will create a new branch based at the current `HEAD` position, and switch to it. [NOTE] ================================================ If you make the decision to start your new branch at some -other point in the history than the current HEAD, you can do so by -just telling "git checkout" what the base of the checkout would be. +other point in the history than the current `HEAD`, you can do so by +just telling `git checkout` what the base of the checkout would be. In other words, if you have an earlier tag or branch, you'd just do git checkout -b mybranch earlier-commit -and it would create the new branch "mybranch" at the earlier commit, +and it would create the new branch `mybranch` at the earlier commit, and check out the state at that time. ================================================ -You can always just jump back to your original "master" branch by doing +You can always just jump back to your original `master` branch by doing git checkout master @@ -710,8 +716,8 @@ checking it out and switching to it. If so, just use the command git branch <branchname> [startingpoint] which will simply _create_ the branch, but will not do anything further. -You can then later - once you decide that you want to actually develop -on that branch - switch to that branch with a regular "git checkout" +You can then later -- once you decide that you want to actually develop +on that branch -- switch to that branch with a regular `git checkout` with the branchname as the argument. @@ -720,19 +726,19 @@ Merging two branches One of the ideas of having a branch is that you do some (possibly experimental) work in it, and eventually merge it back to the main -branch. So assuming you created the above "mybranch" that started out -being the same as the original "master" branch, let's make sure we're in +branch. So assuming you created the above `mybranch` that started out +being the same as the original `master` branch, let's make sure we're in that branch, and do some work there. ------------- +------------------------------------------------ git checkout mybranch echo "Work, work, work" >>hello git commit -m 'Some work.' hello ------------- +------------------------------------------------ -Here, we just added another line to "hello", and we used a shorthand for -both going a "git-update-cache hello" and "git commit" by just giving the -filename directly to "git commit". The '-m' flag is to give the +Here, we just added another line to `hello`, and we used a shorthand for +both going a `git-update-cache hello` and `git commit` by just giving the +filename directly to `git commit`. The `-m` flag is to give the commit log message from the command line. Now, to make it a bit more interesting, let's assume that somebody else @@ -743,9 +749,9 @@ to the master branch, and editing the same file differently there: git checkout master ------------ -Here, take a moment to look at the contents of "hello", and notice how they -don't contain the work we just did in "mybranch" - because that work -hasn't happened in the "master" branch at all. Then do +Here, take a moment to look at the contents of `hello`, and notice how they +don't contain the work we just did in `mybranch` -- because that work +hasn't happened in the `master` branch at all. Then do ------------ echo "Play, play, play" >>hello @@ -761,15 +767,15 @@ helps you view what's going on: gitk --all -will show you graphically both of your branches (that's what the "--all" -means: normally it will just show you your current HEAD) and their +will show you graphically both of your branches (that's what the `\--all` +means: normally it will just show you your current `HEAD`) and their histories. You can also see exactly how they came to be from a common source. -Anyway, let's exit gitk (^Q or the File menu), and decide that we want -to merge the work we did on the "mybranch" branch into the "master" -branch (which is currently our HEAD too). To do that, there's a nice -script called "git resolve", which wants to know which branches you want +Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want +to merge the work we did on the `mybranch` branch into the `master` +branch (which is currently our `HEAD` too). To do that, there's a nice +script called `git resolve`, which wants to know which branches you want to resolve and what the merge is all about: ------------ @@ -781,8 +787,8 @@ the merge can be resolved automatically. Now, in this case we've intentionally created a situation where the merge will need to be fixed up by hand, though, so git will do as much -of it as it can automatically (which in this case is just merge the "example" -file, which had no differences in the "mybranch" branch), and say: +of it as it can automatically (which in this case is just merge the `example` +file, which had no differences in the `mybranch` branch), and say: Simple merge failed, trying Automatic merge Auto-merging hello. @@ -793,12 +799,12 @@ file, which had no differences in the "mybranch" branch), and say: which is way too verbose, but it basically tells you that it failed the really trivial merge ("Simple merge") and did an "Automatic merge" -instead, but that too failed due to conflicts in "hello". +instead, but that too failed due to conflicts in `hello`. -Not to worry. It left the (trivial) conflict in "hello" in the same form you +Not to worry. It left the (trivial) conflict in `hello` in the same form you should already be well used to if you've ever used CVS, so let's just -open "hello" in our editor (whatever that may be), and fix it up somehow. -I'd suggest just making it so that "hello" contains all four lines: +open `hello` in our editor (whatever that may be), and fix it up somehow. +I'd suggest just making it so that `hello` contains all four lines: ------------ Hello World @@ -815,17 +821,17 @@ git commit hello which will very loudly warn you that you're now committing a merge (which is correct, so never mind), and you can write a small merge -message about your adventures in git-merge-land. +message about your adventures in git-merge-land. -After you're done, start up "gitk --all" to see graphically what the -history looks like. Notice that "mybranch" still exists, and you can +After you're done, start up `gitk --all` to see graphically what the +history looks like. Notice that `mybranch` still exists, and you can switch to it, and continue to work with it if you want to. The -"mybranch" branch will not contain the merge, but next time you merge it -from the "master" branch, git will know how you merged it, so you'll not +`mybranch` branch will not contain the merge, but next time you merge it +from the `master` branch, git will know how you merged it, so you'll not have to do _that_ merge again. Another useful tool, especially if you do not always work in X-Window -environment, is "git show-branch". +environment, is `git show-branch`. ------------------------------------------------ $ git show-branch master mybranch @@ -839,20 +845,20 @@ $ git show-branch master mybranch The first two lines indicate that it is showing the two branches and the first line of the commit log message from their -top-of-the-tree commits, you are currently on "master" branch -(notice the asterisk "*" character), and the first column for +top-of-the-tree commits, you are currently on `master` branch +(notice the asterisk `*` character), and the first column for the later output lines is used to show commits contained in the -"master" branch, and the second column for the "mybranch" +`master` branch, and the second column for the `mybranch` branch. Three commits are shown along with their log messages. -All of them have plus '+' characters in the first column, which -means they are now part of the "master" branch. Only the "Some -work" commit has the plus '+' character in the second column, -because "mybranch" has not been merged to incorporate these +All of them have plus `+` characters in the first column, which +means they are now part of the `master` branch. Only the "Some +work" commit has the plus `+` character in the second column, +because `mybranch` has not been merged to incorporate these commits from the master branch. Now, let's pretend you are the one who did all the work in -mybranch, and the fruit of your hard work has finally been merged -to the master branch. Let's go back to "mybranch", and run +`mybranch`, and the fruit of your hard work has finally been merged +to the `master` branch. Let's go back to `mybranch`, and run resolve to get the "upstream changes" back to your branch. git checkout mybranch @@ -867,13 +873,13 @@ would be different) 2 files changed, 2 insertions(+), 0 deletions(-) Because your branch did not contain anything more than what are -already merged into the master branch, the resolve operation did +already merged into the `master` branch, the resolve operation did not actually do a merge. Instead, it just updated the top of -the tree of your branch to that of the "master" branch. This is -often called "fast forward" merge. +the tree of your branch to that of the `master` branch. This is +often called 'fast forward' merge. -You can run "gitk --all" again to see how the commit ancestry -looks like, or run "show-branch", which tells you this. +You can run `gitk --all` again to see how the commit ancestry +looks like, or run `show-branch`, which tells you this. ------------------------------------------------ $ git show-branch master mybranch @@ -890,43 +896,99 @@ Merging external work |