GitDocumentation

From Git SCM Wiki

Jump to: navigation, search

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
Git SVN crash course
Many Howto documents come with git as well
Documentation/technical http://repo.or.cz/w/git.git?a=tree;f=Documentation/technical;hb=HEAD 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
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

User contributed Documentation

The Git Community Book at git-scm.com.
gitready.com daily tips for the noob to the guru
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)
CVS to Git transition guide Mirror(HTML)
An introduction to git-svn
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 Debain Lenny and Ubuntu Jaunty
HowTo: Installation and tutorial of Braid (submodule alternative)

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. 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:

http://www.kernel.org/pub/software/scm/git/docs/

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.