X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=pep-git.txt;h=73b2ecbf1dccf834bd6a20252b97ed3de6922475;hb=e32d8a3898bc6047a8855cec051c4bcbc22fcb4e;hp=46b70537695ffa02a56352287cc4c3329b3a6222;hpb=d4c26d6596de1933139128e45c2514afb5540acb;p=git-wiki.git
diff --git a/pep-git.txt b/pep-git.txt
index 46b7053..73b2ecb 100644
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -75,19 +75,25 @@ Download and installation
Unix users: download and install using your package manager.
Microsoft Windows: download `git-for-windows
-`_.
+`_ or `msysGit
+`_.
MacOS X: use git installed with `XCode
-`_ or download
+`_ or download from
+`MacPorts `_ or
`git-osx-installer
-`_.
+`_ or
+install git with `Homebrew `_: ``brew install git``.
+
+`Atlassins's SourceTree `_ is a free
+Git and Mercurial GUI client for Windows or Mac.
Initial configuration
---------------------
This simple code is often appears in documentation, but it is
important so let repeat it here. Git marks every commit with author
-and commiter names/emails, so configure your real name and preferred
+and committer names/emails, so configure your real name and preferred
email::
$ git config --global user.name "User Name"
@@ -101,13 +107,25 @@ 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 did
-something like that::
+currently checked out branch is ``v2``. That is, it's assumed you have
+done something like that::
+
+ $ git clone -b v2 http://git.python.org/python.git
+ $ cd python
+ $ git branch v1 origin/v1
+
+The last command creates a new local branch v1 and sets
+remotes/origin/v1 as its upstream remote branch.
+
+The same result can achieved with commands::
$ git clone -b v1 http://git.python.org/python.git
$ cd python
- $ git fetch origin v2:v2
- $ git checkout -b v2
+ $ git checkout --track origin/v2
+
+The last command creates a new local branch v2, sets
+remotes/origin/v2 as its upstream remote branch and checks it out into
+the working directory.
Branches and branches
@@ -146,18 +164,19 @@ To see local and remote branches (and tags) pointing to commits::
$ git log --decorate
You never do your own development on remote branches. You create a
-local branch that has a remote branch as an upstream and do
-development on that local branch. On push git updates remote branches,
-and on pull git updates remote branches and fast-forwards, merges or
-rebases local branches.
+local branch that has a remote branch as upstream and do development
+on that local branch. On push git updates remote branches, and on pull
+git updates remote branches and fast-forwards, merges or rebases local
+branches.
When you do an initial clone like this::
$ git clone -b v1 http://git.python.org/python.git
git clones remote repository ``http://git.python.org/python.git`` to
-directory ``python``, creates remote branches and checks out branch
-``v1`` into the working directory.
+directory ``python``, creates remote branches, creates a local branch
+``v1``, configure it to track upstream remotes/origin/v1 branch and
+checks out ``v1`` into the working directory.
Updating local and remote branches
----------------------------------
@@ -185,7 +204,7 @@ branch BRANCH and its upstream remote branch. But it refuses to update
branches in case of non-fast-forward. And it refuses to update the
current branch.
-The first command is used internall by ``git pull``.
+The first command is used internally by ``git pull``.
::
@@ -236,8 +255,17 @@ git guesses (knowing upstream remote branches) that you really want
$ git push origin v1:v1 v2:v2
-Git pushes commits to the remote repo and updates remote branches. It
-is possible to configure git to make it push a few branches or all
+Git pushes commits to the remote repo and updates remote branches. Git
+refuses to push commits that aren't fast-forwardable. You can
+force-push anyway, but please remember - you can force-push to your
+own repositories but don't force-push to public or shared repos. If
+you find git refuses to push commits that aren't fast-forwardable,
+better fetch and merge commits from the remote repo (or rebase your
+commits on top of the fetched commits), then push. Only force-push if
+you know what you do and why you do it. See the section `Commit
+editing and caveats`_ below.
+
+It is possible to configure git to make it push a few branches or all
branches at once, so you can simply run
::
@@ -271,7 +299,7 @@ For example::
Git doesn't automatically pushes tags. That allows you to have private
tags (lightweight tags are also private for a repo, they cannot be
-pushed). To push tag(s) list them explicitly::
+pushed). To push tags list them explicitly::
$ git push origin tag 1.4.2
$ git push origin v1 v2 tag 2.1.7
@@ -281,7 +309,7 @@ Commit editing and caveats
==========================
A warning not to edit published (pushed) commits also appears in
-documentation but it's also repeated here as it's very important.
+documentation but it's repeated here anyway as it's very important.
It is possible to recover from forced push but it's PITA for the
entire team. Please avoid it.
@@ -316,7 +344,7 @@ safely edit, remove, reorder, combine and split commits that hasn't
been pushed yet. You can even push commits to your own (backup) repo,
edit them later and force-push edited commits to replace what has
already been pushed. Not a problem until commits are in a public
-repository.
+or shared repository.
Undo