GitDocumentation
OBSOLETE CONTENT
This wiki has been archived and the content is no longer updated. Please visit git-scm.com/doc for up-to-date documentation.
Git Documentation
- Git glossary (GitWiki version, HTML version, source via gitweb)
- Git manual page - Online version bundled with Git. (The information displayed when using the command man git or git help)
- Git User's Manual - Online version bundled with Git
- A tutorial introduction to git and A tutorial introduction to git: part two - Online version bundled with Git
- Everyday Git, with 20 commands or so - Online version bundled with Git
- Git for CVS users - Online version bundled with Git. To migrate, consider Interfaces, frontends, and tools#CVS, and especially reposurgeon.
- Git for SVN users
- Git as Subverison Client: git-svn
- Many Howto documents come with git as well
- Documentation/technical for all the technical information relating to Git
- TroubleShooting
Documentation on this Wiki
All documentation residing on this wiki is put in the
- Git glossary (GitWiki version, HTML version, source via gitweb)
- Git QuickStart
- GitCheatSheet
- GitTheory
- An overview of the RevisionSpecification used by the
git log
command and several repository visualizers. - GraftPoint; when and how to use them
- Introduction to git's IndexFile and WhatIsTheIndex
- BranchesInGit is an explanation about how Git understand branches
- Using common CommitMessageConventions
- SubprojectSupport in Git
- Ideas and thoughts on PatchManagement
- HowToWriteTests describes how to write test cases for git
- Using Aliases
- GitTips and GitFaq
- GitWorkflows
- Doing a graft at GraftPoint
- IndexCommandQuickref
- The RevisionSpecification
- Equivalent of svn switch for git-svn: GitSvnSwitch - when an SVN repos moves
- A guide to migrating your organisation from SVN to git: SvnMigration
- Installing and developing GitP4
- How to use Textconv feature
User contributed Documentation
- Pro Git Book 2nd edition by Scott Chacon and the Git Community, under Creative Commons BY-NC-SA 3.0 license.
- Ry's Git Tutorial - A comprehensive introduction to Git with lots of hands-on examples.
- gitready.com daily tips for the noob to the guru
- Git Reference, a quick reference for learning and remembering the most important and commonly used Git commands.
- git clone is not resumable - a practical workaround for unreliable connections / large clones
- Carl Worth's A tour of git: the basics Mirror(PDF) Recommended
- John Wiegley's tutorial describing Git From Bottom Up Link to PDF, Mirror(PDF) Recommended
- My Git workflow and Commit Policies by Oliver Steele
- Git magic. A nice use-case driven tutorial. Chinese translation:Git ??.
- Shipping quality code with git at Redhat Magazine
- GitCasts
- Git for computer scientists
- Git in a Nutshell by Jonas Jusélius is very well done Mirror(HTML)
- An introduction to git-svn
- How to use Git and Subversion together, screencasts and blog-posts by Thomas Ferris Nicolaisen
- The Git Papers by Jon Loeliger
- Git wikibook: Source Control Management With Git
- The Kernel Hacker's Git Tutorial by Jeff Garzik
- Documents and Notes by Raymond S Brand -Out of date? (edit if not)
- Packaging Software using Git is an analysis of schemes people use for packaging.
- See also vcs-pkg project, aim of which is to investigate the use of version control for distro package maintenance.
- Git scripts for Xcode users Build and distribution scripts for Xcode can now also found on github.
- Slides from Git as cvs replacement talk (for cvs refugees) and Advanced Git talk by Thomas Pasch
- Visual git tutorial - The visual git tutorial explains how to locally track project files. It shows how to add and commit changes, how to browse the history, revert changes and how to work with tags and branches.
- Mark Lodato made a visual git guide - with source code repository.
- Collaborative git workflow explains how to collaborate with git on an open source project that is (not necessarily) hosted on GitHub.
- HowTo: Installation of Apache WebDAV for git over http
- HowTo: Installation of git 1.6.5 under Debian Lenny and Ubuntu Jaunty
- GIT Tutorial: Maintain your project easily (How to: for beginners)
- HowTo: Installation and tutorial of Braid (submodule alternative)
- Screencast: Git in Action - Introduction to distributed version control with git
- GitGuys Git Tutorials
- 9 101 video tutorials (about 40 mins) by Jeremy Skinner with full quality download available.
- Dr. Dobb's Journal - Git Tutorial: Branches and Workflow - Includes a Git tutorial with very small steps and a lot of screen shots, by Scott Danzig
Publications
Here are some published resources about Git.
- Pro Git by Scott Chacon and Ben Straub (Apress)
- Git Essentials by Ferdinando Santacroce (Packt Publishing)
- Mastering Git by Jakub Narębski (Packt Publishing)
- Git for Teams by Emma Jane Hogbin Westby (O'Reilly)
- Version Control with Git by Jon Loeliger and Matthew McCullough (O'Reilly)
- Professional Git by Brent Laster (Wiley)
- Git in Practice by Mike McQuaid (Manning Publications)
- Learn Git in a Month of Lunches by Rick Umali (Manning Publications)
- Pragmatic Version Control Using Git by Travis Swicegood (The Pragmatic Bookshelf)
- Pragmatic Guide to Git by Travis Swicegood (The Pragmatic Bookshelf)
Man pages
Each git command is documented in its own man page. If the man pages are installed on your local system running:
$ man git-log
will give you the man page for the git log command.
Alternatively you can use (especially on systems where there is no man command):
$ git help log
if both git and the git man pages are installed on your system.
git(7) serves as an overview of git commands and man pages.
Online versions of the Git man pages corresponding to the latest development version can be found at:
There also exists a handful of technical documents that describes lowlevel details on how different parts of git operates. These are mostly useful for developers. You can find them in the Documentation/technical directory in the git source tree.
Git's Documentation To-Do list
If you wish that something were documented better (or at all), or would like to contribute to Git's documentation, you should check the Documentation_To-Do_List to see whether your wish has already been mentioned, or to find something to write about.
Non-english Language Documentation
Chinese
- http://www.bitsun.com/documents/GitUserManualChinese.html translation of official Git user's manual
- http://www.bitsun.com/documents/gittutorcn.htm translation of official tutorials
- http://www.linuxsir.org/bbs/showthread.php?t=281294 or http://www.newsmth.net/bbscon.php?bid=392&id=422519
- http://my.opera.com/dahema/blog/show.dml/171011
French
German
- German translation of the Git man pages - currently work in progress.
- Several tutorials and installation howtos for: *DAV, Braid, Gitorious, Gitosis, Submodul, Debian*
Spanish
- http://gitorious.org/projects/curso-git-osluca - some notes that I wrote for a short 1-week course on Git
Japanese
- http://www8.atwiki.jp/git_jp/ - early attempts to translate the manuals. Has translation of the user-manual (completed).
Catalan
- http://ca.wikibooks.org/wiki/Tutorial_de_git - A basic tutorial in Catalan
- http://gabarro.org/wiki/git_mini-howto - A nice mini-howto of distributed workflows
- http://comesfa.poble.cat/Manual:GIT - A complete manual
Korean
- http://namhyung.springnote.com/pages/3132772 - A Korean translation of Git user's manual