Remove advertisement ;-)

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

diff --git a/pep-git.txt b/pep-git.txt
index 6365fb8c0825bedc7ebe0c2f2b48666f73d8ed91..4b7a9702413c59b47c4bf73c2b35807862f8171a 100644 (file)
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -85,9 +85,8 @@ 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``.
 
 <http://sourceforge.net/projects/git-osx-installer/files/>`_ or
 install git with `Homebrew <http://brew.sh/>`_: ``brew install git``.
 

-`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.
+`git-cola <https://git-cola.github.io/index.html>`_ is a Git GUI
+written in Python and GPL licensed. Linux, Windows, MacOS X.

 
 `TortoiseGit <https://tortoisegit.org/>`_ is a Windows Shell Interface
 to Git based on TortoiseSVN; open source.
 
 `TortoiseGit <https://tortoisegit.org/>`_ is a Windows Shell Interface
 to Git based on TortoiseSVN; open source.


@@ -118,10 +117,15 @@ done something like that::
     $ cd python
     $ git branch v1 origin/v1
 
     $ 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 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 branch.
 
 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::
+The same result can be achieved with commands::

 
     $ git clone -b v1 http://git.python.org/python.git
     $ cd python
 
     $ git clone -b v1 http://git.python.org/python.git
     $ cd python


@@ -376,8 +380,21 @@ or shared repository.
 Undo
 ====
 
 Undo
 ====
 

-TODO: describe undo strategies: git reset, git revert, git checkout,
-git reflog. "Commit early, commit often".
+Whatever you do, don't panic. Almost anything in git can be undone.
+``git checkout``, for example, can be used to restore the content of
+file(s) to that one of a commit. Like this::
+
+    git checkout HEAD~ README
+
+The commands restores the contente of README file to the last but one
+commit in the current branch. By default a commit ID is simple HEAD;
+i.e. ``git checkout README`` restores README to the latest commit.
+
+(Do not use ``git checkout`` to view a content of a file in a commit,
+use ``git cat-file -p``; e.g. ``git cat-file -p HEAD~:path/to/README``).
+
+TODO: describe undo strategies: git reset, git reflog, git revert.
+"Commit early, commit often".

 
 How to undo a merge
 https://www.kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html
 
 How to undo a merge
 https://www.kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html


@@ -408,6 +425,7 @@ and configure rebase for existing branches::
 
 For example::
 
 
 For example::
 

+    $ git config branch.v1.rebase true

     $ git config branch.v2.rebase true
 
 After that ``git pull origin v2`` becomes equivalent to ``git pull
     $ git config branch.v2.rebase true
 
 After that ``git pull origin v2`` becomes equivalent to ``git pull


@@ -416,12 +434,12 @@ After that ``git pull origin v2`` becomes equivalent to ``git pull
 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
 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::
+into mainline. To avoid a tedious task of resolving large number of
+conflicts at once 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
+    $ 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
         ...edit/test/commit...
     $ git checkout v2
     $ git pull --rebase origin v2  # update v2 from the upstream


@@ -432,9 +450,9 @@ workflow would be something like::
 When the topic branch is deleted only the label is removed, commits
 are stayed in the database, they are now merged into 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--M--< v2 - it is the mainline branch
+    o--o--o--o--o--M--< v2 - the mainline branch

         \         /
         \         /

-         --*--*--*         - it is 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
 
 The topic branch is deleted to avoid cluttering branch namespace with
 small topic branches. Information on what issue was fixed or what


@@ -444,7 +462,7 @@ feature was implemented should be in the commit messages.
 Null-merges
 ===========
 
 Null-merges
 ===========
 

-Git has a builtin strategy for what Python core developers call
+Git has a builtin merge strategy for what Python core developers call

 "null-merge"::
 
     $ git merge -s ours v1  # null-merge v1 into v2
 "null-merge"::
 
     $ git merge -s ours v1  # null-merge v1 into v2


@@ -485,6 +503,7 @@ Database maintenance
 ====================
 
 TODO: dangling objects, git gc, git repack.
 ====================
 
 TODO: dangling objects, git gc, git repack.

+https://gcc.gnu.org/ml/gcc/2007-12/msg00165.html

 
 
 Tips and tricks
 
 
 Tips and tricks


@@ -492,7 +511,10 @@ Tips and tricks
 
 TODO: sticky options; example: git grep -O.
 
 
 TODO: sticky options; example: git grep -O.
 

+TODO: tricky options; example: git log -p3.
+

 TODO: bash/zsh completion, bash/zsh prompt.
 TODO: bash/zsh completion, bash/zsh prompt.

+https://git.kernel.org/cgit/git/git.git/tree/contrib/completion

 
 
 git on server
 
 
 git on server


@@ -500,6 +522,11 @@ git on server
 
 TODO: anonymous access; git over ssh; gitolite; gitweb; cgit; gitlab.
 
 
 TODO: anonymous access; git over ssh; gitolite; gitweb; cgit; gitlab.
 

+http://gitolite.com/gitolite/index.html
+
+https://git.kernel.org/cgit/git/git.git/tree/gitweb
+
+http://git.zx2c4.com/cgit/

 
 From Mercurial to git
 =====================
 
 From Mercurial to git
 =====================