From bb91e98e10aabd0b8ae3972e10333c68e5ca803d Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Tue, 30 Jun 2015 22:14:05 +0300 Subject: [PATCH 01/16] Push-to-deploy was implemented in 2.3 and improved in 2.4 --- pep-git.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pep-git.txt b/pep-git.txt index d215a58..51701c9 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -326,6 +326,11 @@ 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. +That changed in git 2.3, but see `the blog post +`_ +for caveats; in 2.4 the push-to-deploy feature was `further improved +`_. + Tags '''' -- 2.39.2 From 3c69930122749e2c433afedec102dbae698d88d3 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Wed, 1 Jul 2015 19:06:21 +0300 Subject: [PATCH 02/16] Explain text/eol/binary .gitattributes --- pep-git.txt | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/pep-git.txt b/pep-git.txt index 51701c9..bb1d77b 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -596,9 +596,23 @@ Advanced configuration Line endings ------------ -Git has builtin mechanisms to handle line endings. +Git has builtin mechanisms to handle line endings between platforms +with different EOL styles. To allow git to do CRLF conversion assign +``text`` attribute to files using `.gitattributes +`_. +For files that have to have specific line ending assign ``eol`` +attribute. For binary files the attribute is, naturally, ``binary``. -TODO: describe crlf configuration and .gitattributes. +For example:: + + $ cat .gitattributes + *.py text + *.txt text + *.png binary + /readme.txt eol=CRLF + +To check what attributes git uses for files use ``git check-attr`` +command. Advanced topics -- 2.39.2 From 5a0fd8f0ab3191f27410de88e9e25d8d6b8b12c7 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sat, 4 Jul 2015 18:40:31 +0300 Subject: [PATCH 03/16] Change wording --- pep-git.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pep-git.txt b/pep-git.txt index bb1d77b..42cce32 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -199,9 +199,9 @@ and $ git fetch $REMOTE $BRANCH:$BRANCH The first command fetches commits from the named $BRANCH in the -$REMOTE repository that are not in your repository and leaves the id -(the hash) of the head commit in file .git/FETCH_HEAD and updates -remote-tracking branch. +$REMOTE repository that are not in your repository, updates +remote-tracking branch and leaves the id (the hash) of the head commit +in file .git/FETCH_HEAD. The second command fetches commits from the named $BRANCH in the $REMOTE repository that are not in your repository and updates both -- 2.39.2 From a43b1b6ac9e19c829716aef20d017238dcabc337 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sat, 4 Jul 2015 18:42:30 +0300 Subject: [PATCH 04/16] Change example a bit --- pep-git.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pep-git.txt b/pep-git.txt index 42cce32..970f4a2 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -343,7 +343,8 @@ explicitly:: For example:: - $ git fetch origin tag 1.4.2 tag 2.1.7 + $ git fetch origin tag 1.4.2 + $ git fetch origin v1:v1 tag 2.1.7 Git doesn't automatically pushes tags. That allows you to have private tags (lightweight tags are also private for a repo, they cannot be -- 2.39.2 From f0213305a7740b63a41120da14aff3c54b8e3ea8 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sat, 4 Jul 2015 18:47:36 +0300 Subject: [PATCH 05/16] Minor grammar fixes --- pep-git.txt | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/pep-git.txt b/pep-git.txt index 970f4a2..6588eda 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -392,9 +392,9 @@ Read `how to recover from upstream rebase It is in ``git help rebase``. On the other hand don't be too afraid about commit editing. You can -safely edit, remove, reorder, combine and split commits that hasn't +safely edit, remove, reorder, combine and split commits that haven'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 +edit them later and force-push edited commits to replace what have already been pushed. Not a problem until commits are in a public or shared repository. @@ -489,10 +489,11 @@ git revert: revert a commit --------------------------- ``git revert`` reverts a commit or commits, that is, it creates a new -commit or commits that reverts the effects of the given commits. It's -the only way to undo published commits (``git commit --amend``, ``git -rebase`` and ``git reset`` change the branch in non-fast-forwardable -ways so they should only be used for non-pushed commits.) +commit or commits that revert(s) the effects of the given commits. +It's the only way to undo published commits (``git commit --amend``, +``git rebase`` and ``git reset`` change the branch in +non-fast-forwardable ways so they should only be used for non-pushed +commits.) There is a problem with reverting a merge commit. ``git revert`` can undo the code created by the merge commit but it cannot undo the fact -- 2.39.2 From bb5daae63fb5070f59e30b831190f6d3d8ce5958 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sat, 4 Jul 2015 19:00:33 +0300 Subject: [PATCH 06/16] Add an example for ``git check-attr`` --- pep-git.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pep-git.txt b/pep-git.txt index 6588eda..af8fc37 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -614,7 +614,9 @@ For example:: /readme.txt eol=CRLF To check what attributes git uses for files use ``git check-attr`` -command. +command. For example:: + +$ git check-attr -a -- \*.py Advanced topics -- 2.39.2 From e9e7f5a63ac0b7c94f1bb3db7ef0d04921683129 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Tue, 7 Jul 2015 04:01:49 +0300 Subject: [PATCH 07/16] Fix: lightweight tags can be pushed too --- pep-git.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pep-git.txt b/pep-git.txt index af8fc37..8ef719d 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -347,8 +347,7 @@ For example:: $ git fetch origin v1:v1 tag 2.1.7 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 tags list them explicitly:: +tags. To push tags list them explicitly:: $ git push origin tag 1.4.2 $ git push origin v1 v2 tag 2.1.7 -- 2.39.2 From d319fc89bb9ae625c70a7c1085110a0be5a54391 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Fri, 10 Jul 2015 00:43:25 +0300 Subject: [PATCH 08/16] Explain updateable and private-to-the-repo information --- pep-git.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/pep-git.txt b/pep-git.txt index 8ef719d..a721a85 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -355,6 +355,19 @@ tags. To push tags list them explicitly:: Don't move tags with ``git tag -f`` or remove tags with ``git tag -d`` after they have been published. +Private information +''''''''''''''''''' + +When cloning/fetching/pulling/pushing git copies only database objects +(commits, trees, files and tags) and symbolic references (branches and +lightweight tags). Everything else is private to the repository and +never cloned, updated or pushed. It's your config, your hooks, your +private exclude file. + +If you want to distribute hooks, copy them to the working tree, add, +commit, push and instruct the team to update ind install the hook +manually. + Commit editing and caveats ========================== -- 2.39.2 From a841ec549917bc8caf438bd971cba541be66aba2 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Wed, 22 Jul 2015 21:54:44 +0300 Subject: [PATCH 09/16] Rename v2 to master --- pep-git.txt | 74 ++++++++++++++++++++++++++--------------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/pep-git.txt b/pep-git.txt index a721a85..9dd4b0c 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -109,18 +109,18 @@ Examples in this PEP 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 have -done something like that:: +local repo has two branches ``v1`` and ``master``. For most examples +the currently checked out branch is ``master``. That is, it's assumed +you have done something like that:: - $ git clone -b v2 http://git.python.org/python.git + $ git clone http://git.python.org/python.git $ 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-tracking branch and checks it out into the working -directory. +`python``, creates a new local branch master, sets +remotes/origin/master as its upstream remote-tracking 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-tracking branch. @@ -129,11 +129,11 @@ The same result can be achieved with commands:: $ git clone -b v1 http://git.python.org/python.git $ cd python - $ git checkout --track origin/v2 + $ git checkout --track origin/master -The last command creates a new local branch v2, sets remotes/origin/v2 -as its upstream remote-tracking branch and checks it out into the -working directory. +The last command creates a new local branch master, sets +remotes/origin/master as its upstream remote-tracking branch and +checks it out into the working directory. Branches and branches @@ -156,7 +156,7 @@ Remote-tracking branches are branches (pointers to commits) in your local repository. They are there for you to remember what branches and commits have been pulled from and pushed to what remote repos (you can pull from and push to many remotes). Remote-tracking branches live -under ``remotes/$REMOTE`` namespaces, e.g. ``remotes/origin/v2``. +under ``remotes/$REMOTE`` namespaces, e.g. ``remotes/origin/master``. To see the status of remote-tracking branches run:: @@ -227,8 +227,8 @@ 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 pull --rebase origin master # Update the current branch master + # using rebase instead of merge $ git merge v1 If you have not yet pushed commits on ``v1``, though, the scenario has @@ -241,8 +241,8 @@ merging:: $ git checkout v1 $ git pull --rebase origin v1 - $ git checkout v2 - $ git pull --rebase origin v2 + $ git checkout master + $ git pull --rebase origin master $ git merge v1 It is possible to configure git to make it fetch/pull a few branches @@ -270,12 +270,12 @@ run :: - $ git push origin v1 v2 + $ git push origin v1 master -git pushes local v1 to remote v1 and local v2 to remote v2. The same -as:: +git pushes local v1 to remote v1 and local master to remote master. +The same as:: - $ git push origin v1:v1 v2:v2 + $ git push origin v1:v1 master:master Git pushes commits to the remote repo and updates remote-tracking branches. Git refuses to push commits that aren't fast-forwardable. @@ -350,7 +350,7 @@ Git doesn't automatically pushes tags. That allows you to have private tags. To push tags list them explicitly:: $ git push origin tag 1.4.2 - $ git push origin v1 v2 tag 2.1.7 + $ git push origin v1 master tag 2.1.7 Don't move tags with ``git tag -f`` or remove tags with ``git tag -d`` after they have been published. @@ -381,7 +381,7 @@ entire team. Please avoid it. To see what commits have not been published yet compare the head of the branch with its upstream remote-tracking branch:: - $ git log origin/v2.. + $ git log origin/master.. $ git log origin/v1..v1 For every branch that has an upstream remote-tracking branch git @@ -487,15 +487,15 @@ reflog, so you can undo that undo later again. In a more complex situation you'd want to move some commits along with resetting the head of the branch. Cherry-pick them to the new branch. -For example, if you want to reset the branch ``v2`` back to the +For example, if you want to reset the branch ``master`` back to the original commit but preserve two commits created in the current branch do something like:: - $ git branch save-v2 # create a new branch saving v2 - $ git reflog # find the original place of v2 + $ git branch save-master # create a new branch saving master + $ git reflog # find the original place of master $ git reset $COMMIT_ID - $ git cherry-pick save-v2~ save-v2 - $ git branch -D save-v2 # remove temporary branch + $ git cherry-pick save-master~ save-master + $ git branch -D save-master # remove temporary branch git revert: revert a commit --------------------------- @@ -562,10 +562,10 @@ and configure rebase for existing branches:: For example:: $ git config branch.v1.rebase true - $ git config branch.v2.rebase true + $ git config branch.master.rebase true -After that ``git pull origin v2`` becomes equivalent to ``git pull ---rebase origin v2``. +After that ``git pull origin master`` becomes equivalent to ``git pull +--rebase origin master``. In case when merge is preferred it is recommended to create new commits in a separate feature or topic branch while using rebase to @@ -577,18 +577,18 @@ on it. The entire workflow would be something like:: $ 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 + $ git checkout master + $ git pull --rebase origin master # update master from the upstream $ git merge issue-42 $ git branch -d issue-42 # delete the topic branch - $ git push origin v2 + $ git push origin master When the topic branch is deleted only the label is removed, commits -are stayed in the database, they are now merged into v2:: +are stayed in the database, they are now merged into master:: - o--o--o--o--o--M--< v2 - the mainline branch + o--o--o--o--o--M--< master - the mainline branch \ / - --*--*--* - 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 @@ -601,7 +601,7 @@ Null-merges Git has a builtin merge 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 master Advanced configuration -- 2.39.2 From c3b62e0d9d7d8fb16a24dbc6dddc1ad59999b5d9 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Tue, 28 Jul 2015 17:39:55 +0300 Subject: [PATCH 10/16] Describe staging area --- pep-git.txt | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/pep-git.txt b/pep-git.txt index 9dd4b0c..552901e 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -637,8 +637,31 @@ Advanced topics Staging area ------------ -Staging area aka index is a distinguishing feature of git. See -`WhatIsTheIndex +Staging area aka index aka cache is a distinguishing feature of git. +Staging area is where git collects patches before committing them. +Separation between collecting patches and commit phases provides a +very useful feature of git: one can review collected patches before +commit and even edit them - remove some hunks, add new hunks and +review again. + +To add files to the index use ``git add``. Collecting patches before +committing means you need to do that for every change, not only to add +new (untracked) files. To simplify committing in case you just want to +commit everything without reviewing run ``git commit --all`` (or just +``-a``) - the command adds every changed tracked file to the index and +then commit. + +To add hunks of patches to the index use ``git add --patch`` (or just +``-p``). To remove collected files from the index use ``git reset HEAD +-- $FILE...`` To add/inspect/remove collected hunks use ``git add +--interactive`` (``-i``). + +To see the diff between the index and the last commit (i.e., collected +patches) use ``git diff --cached``. To see the diff between the +working tree and the index (i.e., uncollected patches) use just ``git +diff``. + +See `WhatIsTheIndex `_ and `IndexCommandQuickref `_ in Git -- 2.39.2 From d06522b3056fcb2ce9d016e63b9cabf2c635672d Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Fri, 31 Jul 2015 00:56:25 +0300 Subject: [PATCH 11/16] Add a link to unix package managers commands --- pep-git.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pep-git.txt b/pep-git.txt index 552901e..28f8cc1 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -72,7 +72,8 @@ Quick start Download and installation ------------------------- -Unix users: download and install using your package manager. +Unix users: `download and install using your package manager +`_. Microsoft Windows: download `git-for-windows `_ or `msysGit -- 2.39.2 From af24d7c3f871f5f8e21e1a7ba2750f212f201489 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Wed, 19 Aug 2015 18:56:26 +0300 Subject: [PATCH 12/16] git diff HEAD between the tree and the HEAD --- pep-git.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pep-git.txt b/pep-git.txt index 28f8cc1..aa86ef8 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -660,7 +660,8 @@ To add hunks of patches to the index use ``git add --patch`` (or just To see the diff between the index and the last commit (i.e., collected patches) use ``git diff --cached``. To see the diff between the working tree and the index (i.e., uncollected patches) use just ``git -diff``. +diff``. To see the diff between the working tree and the last commit +(i.e., both collected and uncollected patches) use ``git diff HEAD``. See `WhatIsTheIndex `_ and -- 2.39.2 From aef095b9ca8c6fdc71be1b1d05dd28ceb672ab37 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Thu, 20 Aug 2015 01:43:46 +0300 Subject: [PATCH 13/16] git commit [--only] -- $FILE --- pep-git.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pep-git.txt b/pep-git.txt index aa86ef8..43e8ddd 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -650,7 +650,8 @@ committing means you need to do that for every change, not only to add new (untracked) files. To simplify committing in case you just want to commit everything without reviewing run ``git commit --all`` (or just ``-a``) - the command adds every changed tracked file to the index and -then commit. +then commit. To commit a file or files regardless of patches collected +in the index run ``git commit [--only] -- $FILE...``. To add hunks of patches to the index use ``git add --patch`` (or just ``-p``). To remove collected files from the index use ``git reset HEAD -- 2.39.2 From b0b8875db65efcdc065f1fec308a2c4fe147cec4 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Thu, 20 Aug 2015 01:44:36 +0300 Subject: [PATCH 14/16] Anonymous access == git daemon --- pep-git.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pep-git.txt b/pep-git.txt index 43e8ddd..6563191 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -701,7 +701,8 @@ https://git.kernel.org/cgit/git/git.git/tree/contrib/completion git on server ============= -TODO: anonymous access; git over ssh; gitolite; gitweb; cgit; gitlab. +TODO: anonymous access (``git daemon``); git over ssh; gitolite; +gitweb; cgit; gitlab. http://gitolite.com/gitolite/index.html -- 2.39.2 From 5200492373a6f0b13a1f7c585ceaba02d067bf78 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Thu, 20 Aug 2015 02:14:01 +0300 Subject: [PATCH 15/16] git commit --only == git commit -o --- pep-git.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pep-git.txt b/pep-git.txt index 6563191..f3b5e55 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -651,7 +651,7 @@ new (untracked) files. To simplify committing in case you just want to commit everything without reviewing run ``git commit --all`` (or just ``-a``) - the command adds every changed tracked file to the index and then commit. To commit a file or files regardless of patches collected -in the index run ``git commit [--only] -- $FILE...``. +in the index run ``git commit [--only|-o] -- $FILE...``. To add hunks of patches to the index use ``git add --patch`` (or just ``-p``). To remove collected files from the index use ``git reset HEAD -- 2.39.2 From 97f3e523886fffbea92e87a78b9e7ac1ceb9a94c Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Thu, 20 Aug 2015 05:08:24 +0300 Subject: [PATCH 16/16] Explain git gc, git repack, git fsck --- pep-git.txt | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/pep-git.txt b/pep-git.txt index f3b5e55..1d16640 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -680,11 +680,35 @@ https://git-scm.com/book/en/Git-Tools-Rerere Database maintenance ==================== -TODO: dangling objects, git gc, git repack. - -https://gcc.gnu.org/ml/gcc/2007-12/msg00165.html - -http://vcscompare.blogspot.ru/2008/06/git-repack-parameters.html +Git object database and other files/directories under .git require +periodic maintenance and cleanup. For example, commit editing left +unreferenced objects (dangling objects, in git terminology) and these +objects should be pruned to avoid collecting cruft in the DB. The +command ``git gc`` can be used for maintenance. Git runs ``git gc +--auto`` as a part of some commands to do quick maintenance. Users are +recommended to run ``git gc --aggressive`` from time to time; ``git +help gc`` recommends to run it every few hundred changesets; for more +intensive projects it should be something like once a week and less +frequent (biweekly or monthly) for lesser active projects. + +``git gc --aggressive`` not only removes dangling objects, it also +repacks object database into indexed and better optimized pack(s). +Another way to do it is to run ``git repack``. + +There is a well-known `message +`_ from Linus +Torvalds regarding "stupidity" of ``git gc --aggressive``. The message +can safely be ignored now. It is old and outdated, ``git gc +--aggressive`` became much better since that time. + +For those who still prefer ``git repack`` over ``git gc --aggressive`` +the recommended parameters are ``git repack -a -d -f --depth=20 +--window=250``. See `this detailed experiment +`_ +for explanation on the effects of these parameters. + +From time to time run ``git fsck [--strict]`` to verify integrity of +the database. Tips and tricks -- 2.39.2