A Guided Tour of emacs-git (by TSKim)

Installation

Configuration

Cloning

1. Run 'git-clone'
2. Select local directory
3. Select repository
4. All things done

Importing

1. run 'git-init-from-archive'
2. Select archive file
3. If necessary, set config user.name and user.email
4. Initial commit
5. Commited result

Making changes

1. Open the file which is under the git
2. Editing sources and saving the changes
3. Commit your changes with 'C-x v v' key or 'git-commit-all'
4. All things done

Viewing project history

1. Run 'git-history' for project or 'git-log' for each file
2. 'vc-log' history browser with fancy color

Managing Branches

1. Show branchs with 'git-branch'
2. Create new branch with 'c' in git-branch buffer
3. Select the base branch
4. All things done
5. Topic : Switch to other branch
6. Topic : Delete branches
7. Topic : gitk

Tagging

1. Create new tag 'git-tag' or 'git-snapshot'
2. Input the tag
3. All things done
4. Checking out
5. Checking out to new branch

Diffing

1. Run 'git-diff'
2. Select diffing target
3. Select diffing revision
4. Ediff

Merging

1. Try to merge from other branch with 'git-merge'
2. Select target branch
3. After merge
4. 3 way merge
5. After resolving conflicts

Checking the status of the project

Run 'git-status'
Inspecting Directory
Naive command on git with '.'
Rename with 'r'
Marking with '*'
Add .gitignore with 'i'
Switching branch with 'b'
Sarcastic blame! with '?'
Summary mode with 's'

Installation

Download git-emacs-1.1.tar.gz [git clone git://github.com/tsgates/git-emacs.git]
git-emacs.el/raw
git-modeline.el/raw
git-blame.el/raw

(add-to-list 'load-path "/home/tsgates/Skills/git/git-emacs-1.0")
(require 'git-emacs)

Configuration

git-config-init command

Automatically set current user.name & user.email

Set user.name & user.email if it is not set yet
But, git-emacs recommends the full name and email address of the user logged in

Cloning

1. Run 'git-clone'

Run 'git-clone'

Run 'git-clone'

2. Select local directory

Move directory

Select the directory to be cloned

With 'ido' interface, you can change directory
Create directory with 'C-m' ('M-n', 'M-p' to search history, reference to 'ido')

3. Select repository

Select repository

Select repositories from history and your bookmarks or type new one

4. All things done

Start to clone from repository

All things done

Support asynchronous downloading from the repository
All things ok, you can see message "Cloned"!

Importing

1. run 'git-init-from-archive'

Init from archive

Run 'git-init-from-archive'

2. Select archive file

Selecting archive file

Select the project file
And then create git repository

3. If necessary, set config user.name and user.email

Then, setting config user.name and user.email

It comes from OS user information

4. Initial commit

Inital commit log

'C-cC-c' to actually commit the revisions

5. Commited result

After commiting

Making changes

1. Open the file which is under the git

Open the file

The green dot in the modeline indicates the state of this source file is uptodate (gray : unknown, tomato : modified, red : deleted, purple : unmerged)
As you saw in the modeline, 'vc-git' is still working also

2. Editing sources and saving the changes

After saving the changes

After saving the changes, the state of the file also change from uptodate to modified (tomato dot in the modeline)

3. Commit your changes with 'C-x v v' key or 'git-commit-all'

Commit your changes after editing log

Of course 'C-x v v' key is well-known 'next action' in vc-mode in emacs
It works depending on the state of the file you are editing

("modified -> commmit" & "unmerged -> merge" & "unknown -> add", etc)
Edit your log and then press 'C-c C-c' in git-log buffer

4. All things done

After commit

The state of the buffer turns to uptodate also

Viewing project history

1. Run 'git-history' for project or 'git-log' for each file

History view

Run 'git-history'

2. 'vc-log' history browser with fancy color

History browsing

Actually, it is 'vc-log' with fancy advises
'p', 'n' with a convenient per log up/down moving
'q' with a simple quit

Managing Branches

1. Show branchs with 'git-branch'

Display branch list

Since we did not create any buffers, we are simply in the master branch (marked with a asterisk, '')

If you want simply checkout only, run 'git-checkout'* instead

2. Create new branch with 'c' in git-branch buffer

After pressing 'c', input the new name of the branch

run 'git-create-branch' or 'git-checkout-to-new-branch' if you are not in 'git branch' buffer

3. Select the base branch

Select the branch you want to base on

Only master branch exists

4. All things done

Reload current buffer

Check see if switched to the new branch

Everything seems to be fine, and modeline in the "test.c" also changed to 'new-branch'!

5. Topic : Switch to other branch

Switch to other branch after selecting branch

Generate automatic commit log

Finally switched to 'mater'

With a 'RET' key in 'git-branch', you can switch to selected other branch
If this buffer is not uptodate, commit with a automatically generated log

6. Topic : Delete branches

Delete 'new-branch' in 'git-branch'

Finally delete a 'new-branch'

Isn't it simple?

7. Topic : gitk

Launching gitk in emacs

Run gitk with a 'gitk' command in the buffer!

Tagging

1. Create new tag 'git-tag' or 'git-snapshot'

Create new tag

Run 'git-tag' or 'git-snapshot'

2. Input the tag

Input tag name

Input new tag name

3. All things done

All things done

4. Checking out

Checking out

Checking out to new branch

Checking out may cause the branch to be dangle
Better to checkout to new branch

5. Checking out to new branch

Checking out to new branch

Input the new branch name

Based on what?

Ok on new 'wild-idea' branch

You can make new branch based on tags and other branches!

Diffing

1. Run 'git-diff'

Run 'git-diff'

Run 'git-diff'

2. Select diffing target

Select diffing target

Select the target

3. Select diffing revision

Select revision

HEAD means diffing against HEAD vs cached file you selected at step 2
HEAD~2 means diffing against second parent of HEAD (referencing to git manual)

4. Ediff

Diffing with ediff

Diffing against HEAD~2

Move with 'p', 'n' keys to the next/previous different region
Of course 'q' to quit and restore previous windows

Merging

1. Try to merge from other branch with 'git-merge'

Run 'git-merge'

Run 'git-merge'

2. Select target branch

Select the branch to be merged

In 'git-merge', you can easily select with a 'ido' interface you may be familiar

3. After merge

After merge, it will launch git-status mode

As you see in above, there is a conflict in 'test.c'
Try to resolve conflict(merged) with '!' key

4. 3 way merge

3 way merge similar to famous 'psvn.el'

ediff-merge works fantastically

5. After resolving conflicts

Return to the merged 'test.c'

But, as you know, you have to commit to reflect your changes with 'C-x v v' (purple dot in modeline indicates 'test.c' is unmerged(conflict))
Submit the commit log to complete the job