X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=pep-git.txt;h=6365fb8c0825bedc7ebe0c2f2b48666f73d8ed91;hb=0e2710589d8649fc39f27185072001dd5aa56ce0;hp=40bdeb44e379a615aa152db905691fcef8b83f46;hpb=72de340c4df0f5b393540ab876d9f5126eff749a;p=git-wiki.git diff --git a/pep-git.txt b/pep-git.txt index 40bdeb4..6365fb8 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -3,7 +3,7 @@ Title: Collecting information about git Version: $Revision$ Last-Modified: $Date$ Author: Oleg Broytman -Status: Active +Status: Draft Type: Informational Content-Type: text/x-rst Created: 01-Jun-2015 @@ -45,13 +45,13 @@ Git Tutorial: `part 1 `Git workflows `_. +Advanced documentation +---------------------- + `Git Magic `_, also with a number of translations. -Advanced documentation ----------------------- - `Pro Git `_. The Book about git. Buy it at Amazon or download in PDF, mobi, or ePub form. Has translations to many different languages. Download Russian translation from `GArik @@ -85,16 +85,20 @@ MacOS X: use git installed with `XCode `_ or install git with `Homebrew `_: ``brew install git``. -`Atlassins's SourceTree `_ is a free -Git and Mercurial GUI client for Windows or Mac. +`git-cola `_ is a sleek and +powerful Git GUI written in Python and GPL licensed. Linux, Windows, +MacOS X. + +`TortoiseGit `_ is a Windows Shell Interface +to Git based on TortoiseSVN; open source. 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 @@ -215,15 +219,29 @@ is equivalent to :: $ git fetch REMOTE BRANCH - $ git merge FETCH_HEAD # FETCH_HEAD is a literal here + $ git merge FETCH_HEAD # FETCH_HEAD is a literal here Certainly, BRANCH in that case should be your current branch. If you want to merge a different branch into your current branch first update 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 fetch origin v1:v1 # Update v1 + $ git pull --rebase origin v2 # Update the current branch v2 using + # 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 @@ -362,12 +380,66 @@ TODO: describe undo strategies: git reset, git revert, git checkout, git reflog. "Commit early, commit often". How to undo a merge -https://kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html +https://www.kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html Merge or rebase? ================ +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's 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's diminished even further: "whether to use rebase on +non-pushed commits?" + +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 + +and configure rebase for existing branches:: + + $ git config branch.NAME.rebase true + +For example:: + + $ git config branch.v2.rebase true + +After that ``git pull origin v2`` becomes 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--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 =========== @@ -375,7 +447,7 @@ Null-merges Git has a builtin 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 v2 ReReRe @@ -423,6 +495,12 @@ 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 =====================