X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=pep-git.txt;h=a9b4d9ea3b37911fbdc6431541bc7a419946637c;hb=3464b8a43624f0a795e7a0b2908304cd4a661a70;hp=8aa472cd7a3ac23a6549ffdf2eb6eae732147191;hpb=6ac5e8abf4fcf720b730dc946353bd9727bc2a14;p=git-wiki.git

diff --git a/pep-git.txt b/pep-git.txt
index 8aa472c..a9b4d9e 100644
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -85,16 +85,17 @@ MacOS X: use git installed with `XCode
 <http://sourceforge.net/projects/git-osx-installer/files/>`_ or
 install git with `Homebrew <http://brew.sh/>`_: ``brew install git``.
 
-`Atlassins's SourceTree <https://www.sourcetreeapp.com/>`_ is a free
-Git and Mercurial GUI client for Windows or Mac.
+`git-cola <https://git-cola.github.io/index.html>`_ is a sleek and
+powerful Git GUI written in Python and GPL licensed. Linux, Windows,
+MacOS X.
 
 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 committer names/emails, so configure your real name and preferred
-email::
+important so let repeat it here. Git stores author and committer
+names/emails in every commit, so configure your real name and
+preferred email::
 
     $ git config --global user.name "User Name"
     $ git config --global user.email user.name@example.org
@@ -226,6 +227,20 @@ that non-current branch and then merge::
                                   # rebase instead of merge
     $ git merge v1
 
+If you have not yet pushed commits on ``v1``, though, the scenario has
+to become a bit more complex. Git refuses to update
+non-fast-forwardable branch, and you don't want to do force-pull
+because that would remove your non-pushed commits and you would need
+to recover. So you want to rebase ``v1`` but you cannot rebase
+non-current branch. Hence, checkout ``v1`` and rebase it before
+merging::
+
+    $ git checkout v1
+    $ git pull --rebase origin v1
+    $ git checkout v2
+    $ git pull --rebase origin v2
+    $ git merge v1
+
 It is possible to configure git to make it fetch/pull a few branches
 or all branches at once, so you can simply run
 
@@ -297,7 +312,7 @@ during fetch/pull. To fetch all tags (and commits they point to) run
 ``git fetch --tags origin``. To fetch some specific tags fetch them
 explicitly::
 
-    $ git fetch origin tag NAME1 tag NAME2...
+    $ git fetch origin tag TAG1 tag TAG2...
 
 For example::
 
@@ -310,6 +325,8 @@ pushed). To push tags list them explicitly::
     $ git push origin tag 1.4.2
     $ git push origin v1 v2 tag 2.1.7
 
+Don't move tags with ``git tag -f`` after they have been published.
+
 
 Commit editing and caveats
 ==========================
@@ -363,22 +380,58 @@ How to undo a merge
 https://kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html
 
 
-Advanced topics
-===============
+Merge or rebase?
+================
 
-Staging area
-------------
+Internet is full of heated discussions on the topic: "merge or
+rebase?" Most of them are meaningless. When a DVCS is being used in a
+big team with a big and complex project with many branches there is
+simply no way to avoid merges. So the question diminished to "whether
+to use rebase, and if yes - when to use rebase?" Considering that it
+is very much recommended not to rebase published commits the question
+diminished even further: "whether to use rebase on non-pushed
+commits?"
 
-Staging area aka index is a distinguishing feature of git. See
-`WhatIsTheIndex
-<https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
-`IndexCommandQuickref
-<https://git.wiki.kernel.org/index.php/IndexCommandQuickref>`_ in Git
-Wiki.
+That small question is for the team to decide. The author of the PEP
+recommends to use rebase when pulling, i.e. always do ``git pull
+--rebase`` or even configure automatic setup of rebase for every new
+branch::
 
+    $ git config branch.autosetuprebase true
 
-Merge or rebase?
-================
+and configure rebase for existing branches::
+
+    $ git config branch.NAME.rebase true
+
+After that ``git pull origin v2`` will be equivalent to ``git pull
+--rebase origin v2``.
+
+In case when merge is preferred it is recommended to create new
+commits in a separate feature or topic branch while using rebase to
+update the mainline branch. When the topic branch is ready merge it
+into mainline. To avoid a tedious task of resolving conflicts you can
+merge the topic branch to the mainline from time to time and switch
+back to the topic branch to continue working on it. The entire
+workflow would be something like::
+
+    $ git checkout -b issue-42 # create and switch to a new branch
+        ...edit/test/commit...
+    $ git checkout v2
+    $ git pull --rebase origin v2 # update v2 from the upstream
+    $ git merge issue-42
+    $ git branch -d issue-42 # delete the topic branch
+    $ git push origin v2
+
+When the topic branch is deleted only the label is removed, commits
+are stayed in the database, they are now merged into v2::
+
+    --o--o--o--o--o--o-M-<v2 - it is the mainline branch
+            \         /
+             --*--*--*       - it is 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
+feature was implemented should be in the commit messages.
 
 
 Null-merges
@@ -396,6 +449,20 @@ ReReRe
 https://git-scm.com/book/en/Git-Tools-Rerere
 
 
+Advanced topics
+===============
+
+Staging area
+------------
+
+Staging area aka index is a distinguishing feature of git. See
+`WhatIsTheIndex
+<https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
+`IndexCommandQuickref
+<https://git.wiki.kernel.org/index.php/IndexCommandQuickref>`_ in Git
+Wiki.
+
+
 Advanced configuration
 ======================
 
@@ -416,9 +483,17 @@ TODO: dangling objects, git gc, git repack.
 Tips and tricks
 ===============
 
+TODO: sticky options; example: git grep -O.
+
 TODO: bash/zsh completion, bash/zsh prompt.
 
 
+git on server
+=============
+
+TODO: anonymous access; git over ssh; gitolite; gitweb; cgit; gitlab.
+
+
 From Mercurial to git
 =====================