X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=pep-git.txt;h=6a9f20b2371c9cb813d6268f946c2d9011012fda;hb=a6d17ba08116f8da6ab854e3913c2ab10c9a7aea;hp=2d9b20c588cfe628fb11c09a7b2e6edb4ca1702b;hpb=a97db2d494d3981d34507f5d04e7b3cc15bdb682;p=git-wiki.git

diff --git a/pep-git.txt b/pep-git.txt
index 2d9b20c..6a9f20b 100644
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -75,20 +75,23 @@ Download and installation
 Unix users: download and install using your package manager.
 
 Microsoft Windows: download `git-for-windows
-<https://git-for-windows.github.io/>`_.
+<https://github.com/git-for-windows/git/releases>`_ or `msysGit
+<https://github.com/msysgit/msysgit/releases>`_.
 
 MacOS X: use git installed with `XCode
-<https://developer.apple.com/xcode/downloads/>`_ or download
+<https://developer.apple.com/xcode/downloads/>`_ or download from
+`MacPorts <https://www.macports.org/ports.php?by=name&substr=git>`_ or
 `git-osx-installer
-<http://sourceforge.net/projects/git-osx-installer/files/>`_.
+<http://sourceforge.net/projects/git-osx-installer/files/>`_ or
+install git with `Homebrew <http://brew.sh/>`_: ``brew install git``.
 
 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 commiter 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
@@ -101,13 +104,25 @@ 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 did
-something like that::
+currently checked out branch is ``v2``. That is, it's assumed you have
+done something like that::
+
+    $ git clone -b v2 http://git.python.org/python.git
+    $ cd python
+    $ git branch v1 origin/v1
+
+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::
 
     $ git clone -b v1 http://git.python.org/python.git
     $ cd python
-    $ git fetch origin v2:v2
-    $ git checkout -b v2
+    $ git checkout --track origin/v2
+
+The last command creates a new local branch v2, sets
+remotes/origin/v2 as its upstream remote branch and checks it out into
+the working directory.
 
 
 Branches and branches
@@ -146,18 +161,19 @@ To see local and remote branches (and tags) pointing to commits::
     $ git log --decorate
 
 You never do your own development on remote branches. You create a
-local branch that has a remote branch as an upstream and do
-development on that local branch. On push git updates remote branches,
-and on pull git updates remote branches and fast-forwards, merges or
-rebases local branches.
+local branch that has a remote branch as upstream and do development
+on that local branch. On push git updates remote branches, and on pull
+git updates remote branches and fast-forwards, merges or rebases local
+branches.
 
 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
 ----------------------------------
@@ -185,7 +201,7 @@ branch BRANCH and its upstream remote branch. But it refuses to update
 branches in case of non-fast-forward. And it refuses to update the
 current branch.
 
-The first command is used internall by ``git pull``.
+The first command is used internally by ``git pull``.
 
 ::
 
@@ -207,6 +223,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
 
@@ -236,8 +266,17 @@ git guesses (knowing upstream remote branches) that you really want
 
     $ git push origin v1:v1 v2:v2
 
-Git pushes commits to the remote repo and updates remote branches. It
-is possible to configure git to make it push a few branches or all
+Git pushes commits to the remote repo and updates remote branches. Git
+refuses to push commits that aren't fast-forwardable. You can
+force-push anyway, but please remember - you can force-push to your
+own repositories but don't force-push to public or shared repos. If
+you find git refuses to push commits that aren't fast-forwardable,
+better fetch and merge commits from the remote repo (or rebase your
+commits on top of the fetched commits), then push. Only force-push if
+you know what you do and why you do it. See the section `Commit
+editing and caveats`_ below.
+
+It is possible to configure git to make it push a few branches or all
 branches at once, so you can simply run
 
 ::
@@ -255,6 +294,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
 ''''
 
@@ -263,7 +308,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::
 
@@ -271,17 +316,19 @@ 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
 ==========================
 
 A warning not to edit published (pushed) commits also appears in
-documentation but it's also repeated here as it's very important.
+documentation but it's repeated here anyway as it's very important.
 
 It is possible to recover from forced push but it's PITA for the
 entire team. Please avoid it.
@@ -316,7 +363,7 @@ safely edit, remove, reorder, combine and split commits that hasn'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
 already been pushed. Not a problem until commits are in a public
-repository.
+or shared repository.
 
 
 Undo
@@ -329,6 +376,25 @@ How to undo a merge
 https://kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html
 
 
+Merge or rebase?
+================
+
+
+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
+
+
+ReReRe
+======
+
+https://git-scm.com/book/en/Git-Tools-Rerere
+
+
 Advanced topics
 ===============
 
@@ -354,19 +420,6 @@ Git has builtin mechanisms to handle line endings.
 TODO: describe crlf configuration and .gitattributes.
 
 
-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
-
-
-ReReRe
-======
-
-
 Database maintenance
 ====================
 
@@ -376,9 +429,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
 =====================