Download and installation
-------------------------
-Unix users: download and install using your package manager.
+Unix users: `download and install using your package manager
+<https://git-scm.com/download/linux>`_.
Microsoft Windows: download `git-for-windows
<https://github.com/git-for-windows/git/releases>`_ or `msysGit
Examples of git commands in this PEP use the following approach. It is
supposed that you, the user, works with a local repository named
``python`` that has an upstream remote repo named ``origin``. Your
-local repo has two branches ``v1`` and ``v2``. For most examples the
-currently checked out branch is ``v2``. That is, it's assumed you have
-done something like that::
+local repo has two branches ``v1`` and ``master``. For most examples
+the currently checked out branch is ``master``. That is, it's assumed
+you have done something like that::
- $ git clone -b v2 http://git.python.org/python.git
+ $ git clone http://git.python.org/python.git
$ cd python
$ git branch v1 origin/v1
The first command clones remote repository into local directory
-`python``, creates a new local branch v2, sets remotes/origin/v2 as
-its upstream remote-tracking branch and checks it out into the working
-directory.
+`python``, creates a new local branch master, sets
+remotes/origin/master as its upstream remote-tracking branch and
+checks it out into the working directory.
The last command creates a new local branch v1 and sets
remotes/origin/v1 as its upstream remote-tracking branch.
$ git clone -b v1 http://git.python.org/python.git
$ cd python
- $ git checkout --track origin/v2
+ $ git checkout --track origin/master
-The last command creates a new local branch v2, sets remotes/origin/v2
-as its upstream remote-tracking branch and checks it out into the
-working directory.
+The last command creates a new local branch master, sets
+remotes/origin/master as its upstream remote-tracking branch and
+checks it out into the working directory.
Branches and branches
local repository. They are there for you to remember what branches and
commits have been pulled from and pushed to what remote repos (you can
pull from and push to many remotes). Remote-tracking branches live
-under ``remotes/$REMOTE`` namespaces, e.g. ``remotes/origin/v2``.
+under ``remotes/$REMOTE`` namespaces, e.g. ``remotes/origin/master``.
To see the status of remote-tracking branches run::
that non-current branch and then merge::
$ git fetch origin v1:v1 # Update v1
- $ git pull --rebase origin v2 # Update the current branch v2 using
- # rebase instead of merge
+ $ git pull --rebase origin master # Update the current branch master
+ # using rebase instead of merge
$ git merge v1
If you have not yet pushed commits on ``v1``, though, the scenario has
$ git checkout v1
$ git pull --rebase origin v1
- $ git checkout v2
- $ git pull --rebase origin v2
+ $ git checkout master
+ $ git pull --rebase origin master
$ git merge v1
It is possible to configure git to make it fetch/pull a few branches
::
- $ git push origin v1 v2
+ $ git push origin v1 master
-git pushes local v1 to remote v1 and local v2 to remote v2. The same
-as::
+git pushes local v1 to remote v1 and local master to remote master.
+The same as::
- $ git push origin v1:v1 v2:v2
+ $ git push origin v1:v1 master:master
Git pushes commits to the remote repo and updates remote-tracking
branches. Git refuses to push commits that aren't fast-forwardable.
tags. To push tags list them explicitly::
$ git push origin tag 1.4.2
- $ git push origin v1 v2 tag 2.1.7
+ $ git push origin v1 master tag 2.1.7
Don't move tags with ``git tag -f`` or remove tags with ``git tag -d``
after they have been published.
To see what commits have not been published yet compare the head of the
branch with its upstream remote-tracking branch::
- $ git log origin/v2..
+ $ git log origin/master..
$ git log origin/v1..v1
For every branch that has an upstream remote-tracking branch git
In a more complex situation you'd want to move some commits along with
resetting the head of the branch. Cherry-pick them to the new branch.
-For example, if you want to reset the branch ``v2`` back to the
+For example, if you want to reset the branch ``master`` back to the
original commit but preserve two commits created in the current branch
do something like::
- $ git branch save-v2 # create a new branch saving v2
- $ git reflog # find the original place of v2
+ $ git branch save-master # create a new branch saving master
+ $ git reflog # find the original place of master
$ git reset $COMMIT_ID
- $ git cherry-pick save-v2~ save-v2
- $ git branch -D save-v2 # remove temporary branch
+ $ git cherry-pick save-master~ save-master
+ $ git branch -D save-master # remove temporary branch
git revert: revert a commit
---------------------------
For example::
$ git config branch.v1.rebase true
- $ git config branch.v2.rebase true
+ $ git config branch.master.rebase true
-After that ``git pull origin v2`` becomes equivalent to ``git pull
---rebase origin v2``.
+After that ``git pull origin master`` becomes equivalent to ``git pull
+--rebase origin master``.
In case when merge is preferred it is recommended to create new
commits in a separate feature or topic branch while using rebase to
$ git checkout -b issue-42 # create a new issue branch and switch to it
...edit/test/commit...
- $ git checkout v2
- $ git pull --rebase origin v2 # update v2 from the upstream
+ $ git checkout master
+ $ git pull --rebase origin master # update master from the upstream
$ git merge issue-42
$ git branch -d issue-42 # delete the topic branch
- $ git push origin v2
+ $ git push origin master
When the topic branch is deleted only the label is removed, commits
-are stayed in the database, they are now merged into v2::
+are stayed in the database, they are now merged into master::
- o--o--o--o--o--M--< v2 - the mainline branch
+ o--o--o--o--o--M--< master - the mainline branch
\ /
- --*--*--* - the topic branch, now unnamed
+ --*--*--* - the topic branch, now unnamed
The topic branch is deleted to avoid cluttering branch namespace with
small topic branches. Information on what issue was fixed or what
Git has a builtin merge strategy for what Python core developers call
"null-merge"::
- $ git merge -s ours v1 # null-merge v1 into v2
+ $ git merge -s ours v1 # null-merge v1 into master
Advanced configuration
Staging area
------------
-Staging area aka index is a distinguishing feature of git. See
-`WhatIsTheIndex
+Staging area aka index aka cache is a distinguishing feature of git.
+Staging area is where git collects patches before committing them.
+Separation between collecting patches and commit phases provides a
+very useful feature of git: one can review collected patches before
+commit and even edit them - remove some hunks, add new hunks and
+review again.
+
+To add files to the index use ``git add``. Collecting patches before
+committing means you need to do that for every change, not only to add
+new (untracked) files. To simplify committing in case you just want to
+commit everything without reviewing run ``git commit --all`` (or just
+``-a``) - the command adds every changed tracked file to the index and
+then commit.
+
+To add hunks of patches to the index use ``git add --patch`` (or just
+``-p``). To remove collected files from the index use ``git reset HEAD
+-- $FILE...`` To add/inspect/remove collected hunks use ``git add
+--interactive`` (``-i``).
+
+To see the diff between the index and the last commit (i.e., collected
+patches) use ``git diff --cached``. To see the diff between the
+working tree and the index (i.e., uncollected patches) use just ``git
+diff``. To see the diff between the working tree and the last commit
+(i.e., both collected and uncollected patches) use ``git diff HEAD``.
+
+See `WhatIsTheIndex
<https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
`IndexCommandQuickref
<https://git.wiki.kernel.org/index.php/IndexCommandQuickref>`_ in Git
projects / git-wiki.git / blobdiff