Add git-cola GUI client

[git-wiki.git] / pep-git.txt

diff --git a/pep-git.txt b/pep-git.txt
index c123c389a0105284c043935ec8667f6e7f72eb64..165726390477547ca5eab0f60be8c058b9327935 100644 (file)
--- 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
@@ -174,8 +175,9 @@ 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
 ----------------------------------
@@ -225,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
 
@@ -282,6 +298,12 @@ non-bare repository: git refuses to update remote working directory.
 You really should push only to bare repositories. For non-bare
 repositories git prefers pull-based workflow.
 
+When you want to deploy code on a remote host and can only use push
+(because your workstation is behind a firewall and you cannot pull
+from it) you do that in two steps using two repositories: you push
+from the workstation to a bare repo on the remote host, ssh to the
+remote host and pull from the bare repo to a non-bare deployment repo.
+
 Tags
 ''''
 
@@ -290,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::
 
@@ -298,11 +320,13 @@ 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
 
+Don't move tags with ``git tag -f`` after they have been published.
+
 
 Commit editing and caveats
 ==========================
@@ -356,20 +380,6 @@ How to undo a merge
 https://kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html
 
 
-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.
-
-
 Merge or rebase?
 ================
 
@@ -389,6 +399,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
 ======================
 
@@ -409,9 +433,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
 =====================