Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
277 lines (275 sloc) 10.8 KB

Git: Your Favorite Tool

1 Intro

1.1 Who am I?

1.2 Git is awesome

  • Extremely robust
    • Bit-perfection guaranteed with SHA-1 everywhere
  • Extremely powerful
    • Tons of commands

1.3 No one uses all of git all the time

2 Main Git components

2.1 Main Git components

  • .git folder
  • Working tree
  • Index (aka Staging Area)
  • Commits and Branches

2.2 .git folder

  • Single monolithic place that has everything git needs
  • Low-level (not that interesting)
  • But .git/config (per-project home of git-config(1)) is high-level and human-friendly!

2.3 Working tree

  • Everything tracked in your repo except .git folder
    • “tracked” means tied to the current commit
  • Home of what Git calls “local changes”
  • Local changes are fragile!
  • Requires housekeeping (.gitignore)

2.4 Index (aka Staging Area)

  • Holding place for next commit
  • Gives you fine-grained (intra-file) control
  • Less fragile than working tree
  • Makes Git awesome, but is an alien concept to other source control systems

“Git is the only DistributedSCM that exposes the concept of index or staging area.” — Mercurial

2.5 Commit

  • Git really only cares about commits
  • Every commit has a parent (except the first)
  • Commits are automatically “insured” with git reflog
  • The older the commit, the more painful it is to kill

2.6 Branch

  • Default is master, but no branch is special
  • Pointer to a commit
  • By default, you’re always on a branch

2.7 Recap

  • Commit - working tree = local changes (stageable things)
  • Branches are just convenience pointers to commits

3 Practical git usage (basic)

3.1 Practical git usage (basic)

The bare minimum you need to get real work done

3.2 Work work work

  • Make changes (aka “local changes”) and save files
  • Until you commit (or at least stage into index), your changes are fragile!

3.3 git diff

  • Diffs your work tree against your latest commit
  • Visually easier than git status
    • Less reading involved — it’s either something or nothing

3.4 git add -p

  • Interactively marks content as “to be committed”
    • Content, not necessarily files
  • For surgical precision, press e to add specific lines/characters

3.5 git diff --cached

  • Shows you what’s in the index (aka staging area)
  • Always run this before you do git commit

3.6 git status

  • Shows you both git diff and git diff --cached (abbreviated)
  • Especially useful when git diff [--cached] is too long (e.g., directory renames)
  • Also shows you your untracked files
    • Use this for updating .gitignore

3.7 git reset

  • Clears your index (clears out git diff --cached)
    • Basically undos all your git add stuff
  • Working tree is not touched (unless --hard flag)

3.8 git commit

  • Converts index (git diff --cached not git diff) into a commit
  • Write short and sweet commit messages
  • The point is to make them grep-able
  • Use -m flag for 1-liner commit messages
  • Use --verbose flag as a reminder of git diff --cached

3.9 git log -p

  • Show commits with diffs b/n them
  • git log FILE
    • Show commits that touched FILE

3.10 git push (pre vs post v2.0 era)

  • Use git config --global push.default simple
  • Use matching with caution — actually, just don’t use it
  • Only push if your work is final
    • Exceptions: you have your own branch, or your own (non-github) repo for backups
  • Use --force with caution

3.11 git pull

  • Get (newest) upstream commits
  • Same as git fetch then git merge
  • If your branch is ahead of the remote, nothing happens
    • “Already up-to-date.” is a bit misleading

4 Practical git usage (the fun part)

4.1 Practical git usage (the fun part)

Some more tools for your daily routine

4.2 git branch

  • Lists local branches, including the one you’re on
  • -d deletes local branches
  • -D forces deletion (careful)
  • -r lists remote branches
  • -a lists both remote and local branches

4.3 git checkout -b NEW_BRANCH_NAME

  • Use current commit as a base for a new branch

4.4 git merge OTHER_BRANCH

  • Merge OTHER_BRANCH into current one
  • Conflict?
    • Fix conflicted files
      • Make conflicted areas look like the way you want them to be
    • git add those files
    • git commit to resolve the conflict
  • Merge responsibly, not randomly

4.5 git reset --hard

  • Clears your index and your working tree (git diff and git diff --cached are empty now!)
  • Be very careful — anything uncommitted will be lost!
  • Thankfully, any untracked file in your working tree is left alone

4.6 git reset --hard HEAD~5

  • Like git reset --hard, but also moves your branch 5 commits back
  • Basically chops off the 5 latest commits from your branch

4.7 git checkout FILE

  • Undos working tree changes (local changes) you made to FILE
    • IOW, clears git diff for FILE
  • Careful — only way to undo this is from your text editor’s memory!

4.8 git checkout DIR

  • Undos working tree changes (local changes) you made to all files in DIR
  • Be careful!

4.9 git checkout COMMIT_HASH

  • Time travel to an older commit
  • Good for examining an old commit’s entire working tree

4.10 git show COMMIT_HASH

  • Like git log, but for a single commit
  • Shows all info (diff, author, etc.)

4.11 git rebase -i HEAD~N

  • Time travel N commits back, and (potentially) amend (or even delete!) commits as needed
  • My secret weapon
  • Can also use git rebase -i COMMIT_HASH

5 Edge cases

5.1 Edge cases

Uncommon, but still useful, commands

5.2 vim PROJECT/.gitignore

  • Necessary housekeeping
  • Defines the line between tracked vs. untracked

5.3 git blame FILE

  • Who touched FILE last?
  • Poor man’s documentation
  • Logical continuation: git show COMMIT or git log -p FILE

5.4 git mv, git rm

  • Like UNIX mv and rm, but Git-aware
  • Automatically performs a git add on the paths

5.5 git reflog

  • Tracks all operations involving a commit hash
  • Can undo git reset --hard
  • The best place to look if you messed up big time

5.6 git stash (poor man’s commit)

  • Save local changes away (so git diff shows nothing), but outside the realm of commits
  • Show what’s stashed with git stash list
  • git stash pop
    • Apply saved changes to working tree
  • Only use for temporary one-off things to save time

5.7 git cherry-pick

  • Instead of merging an entire branch, merge in only parts of it
  • Sounds nice, but only really useful for large projects

5.8 git grep

  • Self-explanatory
  • But, I’m lazy and abuse git log -p with ag

5.9 git tag -a

  • Only for maintainers who cut releases
  • Traditional workflow:
    • Change a “VERSION” line in some file
    • git add -p
    • =git commit -m ‘project_name 1.6’=
    • =git tag -a ‘v1.6’ -m ‘project_name 1.6’=

6 Common problems

6.1 Common problems

“Oops” moments

6.2 “I did git commit but I’m not ready yet”

  • Vim: :cq
  • My preferred “dumb” way: delete entire commit message ggVGd:x

6.3 “I forgot to add something to my commit”

  • git add -p
  • git commit --amend (reuses your existing commit as a template)

6.4 “My new commit is too big!”

  • git reset HEAD~1
  • git add -p
  • git commit -c ORIG_HEAD (uses big commit’s original commit message as a template)
  • Now do git add -p and git commit as many times as necessary

6.5 “I have a typo in my commit message”

  • git commit --amend

6.6 “I want to combine some of my older commits into one”

  • git rebase -i HEAD~N where N is how far back you want to change things
  • Use s to squash (combine) a commit into its parent
    • f is like squash, but discards its commit message

6.7 “I want to undo a commit”

  • Local, unpushed commit? git reset HEAD~1
    • Index will now have the undone commit’s changes
    • Throw away index? git reset --hard
    • Shortcut: git reset --hard HEAD~1
  • Old, already-pushed commit? git revert COMMIT_HASH
    • Creates a new commit that undoes the old one
    • Good for history

6.8 git pull

  • “I have unfinished (but commited) work, but I still want upstream commits too. But, I don’t want to merge yet (again, I have unfinished work).”
    • git pull --rebase

6.9 git merge

  • Undo
    • Bail out of pending merge? git reset --hard
    • Undo a merge commit? git reset --hard HEAD~1
  • Avoid creating automated merge commit when updating? git pull --rebase
    • But if you have a long-running branch, merge responsibly
      • git rerere may help

7 Tips, tools, and more

7.1 Tips, tools, and more

How to make Git less stupid/painful

7.2 Heavily clean up your commits before pushing

  • Use git add -p, git commit --amend and git rebase -i aggressively
  • The smaller your commits, the easier it becomes to debug later!
  • At the end of the day, Git is for looking at history
  • Rebase to re-order commits
  • Use commits as backup

7.3 Track things sensibly

  • Only do git add against human-written code
    • .gitignore the rest
  • Git does not really care about file permissions/ownership
    • Git does track execute bits though

7.4 Use aliases

  • Git offers aliases, but I prefer shorter shell aliases
alias g='git'
alias gdf='git diff'
alias gdfc='git diff --cached'
alias gcm='git commit --verbose'
alias gst='git status'
etc...

7.5 tig (ncurses GUI)

  • Basically git log -p and git show on steroids
  • Recent versions also do git status by default
  • brew install tig
  • In your bashrc/zshrc: ~alias tig=’tig -n1000’~

7.6 tig (continued)

  • t for tree view (working tree view)
  • b for blaming
  • Makes git blame, git show, git log much faster

7.7 Docs

7.8 Thank you!

Have a nice day!