pep-git.txt

   1 PEP: XXX
   2 Title: Collecting information about git
   3 Version: $Revision$
   4 Last-Modified: $Date$
   5 Author: Oleg Broytman <phd@phdru.name>
   6 Status: Active
   7 Type: Informational
   8 Content-Type: text/x-rst
   9 Created: 01-Jun-2015
  10 Post-History:
  11
  12 Abstract
  13 ========
  14
  15 This Informational PEP collects information about git. There is, of
  16 course, a lot of documentation for git, so the PEP concentrates on
  17 more complex issues, scenarios and topics.
  18
  19 The plan is to extend the PEP in the future collecting information
  20 about equivalence of Mercurial and git scenarios to help migrating
  21 Python development from Mercurial to git.
  22
  23 The author of the PEP doesn't currently plan to write a Process PEP on
  24 migration from Mercurial to git.
  25
  26
  27 Documentation
  28 =============
  29
  30 Git is accompanied with a lot of documentation, both online and
  31 offline.
  32
  33 Documentation for starters
  34 --------------------------
  35
  36 Git Tutorial: `part 1
  37 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial.html>`_,
  38 `part 2
  39 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial-2.html>`_.
  40
  41 `Git User's manual
  42 <https://www.kernel.org/pub/software/scm/git/docs/user-manual.html>`_.
  43 `Everyday GIT With 20 Commands Or So
  44 <https://www.kernel.org/pub/software/scm/git/docs/everyday.html>`_.
  45 `Git workflows
  46 <https://www.kernel.org/pub/software/scm/git/docs/gitworkflows.html>`_.
  47
  48 `Git Magic
  49 <http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html>`_,
  50 also with a number of translations.
  51
  52 Advanced documentation
  53 ----------------------
  54
  55 `Pro Git <https://git-scm.com/book>`_. The Book about git. Buy it at
  56 Amazon or download in PDF, mobi, or ePub form. Has translations to
  57 many different languages. Download Russian translation from `GArik
  58 <https://github.com/GArik/progit/wiki>`_.
  59
  60 `Git Wiki <https://git.wiki.kernel.org/index.php/Main_Page>`_.
  61
  62 Offline documentation
  63 ---------------------
  64
  65 Git has builtin help: run ``git help TOPIC``. For example, run
  66 ``git help git`` or ``git help help``.
  67
  68
  69 Quick start
  70 ===========
  71
  72 Download and installation
  73 -------------------------
  74
  75 Unix users: download and install using your package manager.
  76
  77 Microsoft Windows: download `git-for-windows
  78 <https://git-for-windows.github.io/>`_.
  79
  80 MacOS X: use git installed with `XCode
  81 <https://developer.apple.com/xcode/downloads/>`_ or download
  82 `git-osx-installer
  83 <http://sourceforge.net/projects/git-osx-installer/files/>`_.
  84
  85 Initial configuration
  86 ---------------------
  87
  88 This simple code is often appears in documentation, but it is
  89 important so let repeat it here. Git marks every commit with author
  90 and commiter names/emails, so configure your real name and preferred
  91 email::
  92
  93     $ git config --global user.name "User Name"
  94     $ git config --global user.email user.name@example.org
  95
  96
  97 Examples in this PEP
  98 ====================
  99
 100 Examples of git commands in this PEP use the following approach. It is
 101 supposed that you, the user, works with a local repository named
 102 ``python`` that has an upstream remote repo named ``origin``. Your
 103 local repo has two branches ``v1`` and ``v2``. For most examples the
 104 currently checked out branch is ``v2``. That is, it's assumed you did
 105 something like that::
 106
 107     $ git clone -b v1 http://git.python.org/python.git
 108     $ cd python
 109     $ git fetch origin v2:v2
 110     $ git checkout -b v2
 111
 112
 113 Branches and branches
 114 =====================
 115
 116 Git terminology can be a bit misleading. Take, for example, the term
 117 "branch". In git it has two meanings. A branch is a directed line of
 118 commits (possibly with merges). And a branch is a label or a pointer
 119 assigned to a line of commits. It is important to differentiate when
 120 you talk about commits and when about their labels. Lines of commits
 121 are by itself unnamed and are usually only lengthening and merging.
 122 Labels, on the other hand, can be created, moved, renamed and deleted
 123 freely.
 124
 125
 126 Remote repository and remote branches
 127 =====================================
 128
 129 Another example of slightly misleading terminology. Remote
 130 repositories are really remote, you access them via network (well, a
 131 remote repository can be on your local disk, but it's still remote
 132 because it's not the current repo).
 133
 134 Remote branches, on the other hand, are branches (pointers to commits)
 135 in your local repository. They are there for you to remember what
 136 branches and commits have been pulled from and pushed to what remote
 137 repos (you can pull from and push to many remotes). Remote branches
 138 live under ``remotes/REMOTE`` namespaces, e.g. ``remotes/origin/v2``.
 139
 140 To see the status of remote branches run::
 141
 142     $ git branch -rv
 143
 144 To see local and remote branches (and tags) pointing to commits::
 145
 146     $ git log --decorate
 147
 148 You never do your own development on remote branches. You create a
 149 local branch that has a remote branch as an upstream and do
 150 development on that local branch. On push git updates remote branches,
 151 and on pull git updates remote branches and fast-forwards, merges or
 152 rebases local branches.
 153
 154 When you do an initial clone like this::
 155
 156     $ git clone -b v1 http://git.python.org/python.git
 157
 158 git clones remote repository ``http://git.python.org/python.git`` to
 159 directory ``python``, creates remote branches and checks out branch
 160 ``v1`` into the working directory.
 161
 162 Updating local and remote branches
 163 ----------------------------------
 164
 165 There is a major difference between
 166
 167 ::
 168
 169     $ git fetch REMOTE BRANCH
 170
 171 and
 172
 173 ::
 174
 175     $ git fetch REMOTE BRANCH:BRANCH
 176
 177 The first command fetches commits from the named BRANCH in the REMOTE
 178 repository that are not in your repository and leaves the id (the
 179 hash) of the head commit in file .git/FETCH_HEAD. But it doesn't
 180 update any branch (doesn't move any label).
 181
 182 The second command fetches commits from the named BRANCH in the REMOTE
 183 repository that are not in your repository and updates both the local
 184 branch BRANCH and its upstream remote branch. But it refuses to update
 185 branches in case of non-fast-forward. And it refuses to update the
 186 current branch.
 187
 188 The first command is used internall by ``git pull``.
 189
 190 ::
 191
 192     $ git pull REMOTE BRANCH
 193
 194 is equivalent to
 195
 196 ::
 197
 198     $ git fetch REMOTE BRANCH
 199     $ git merge FETCH_HEAD # FETCH_HEAD is a literal here
 200
 201 Certainly, BRANCH in that case should be your current branch. If you
 202 want to merge a different branch into your current branch first update
 203 that non-current branch and then merge::
 204
 205     $ git fetch origin v1:v1 # Update v1
 206     $ git pull --rebase origin v2 # Update the current branch v2 using
 207                                   # rebase instead of merge
 208     $ git merge v1
 209
 210
 211 Commit editing and caveats
 212 ==========================
 213
 214 A warning not to edit published (pushed) commits also appears in
 215 documentation but it's also repeated here as it's very important.
 216
 217 It is possible to recover from forced push but it's PITA for the
 218 entire team. Please avoid it.
 219
 220 To see what commits have not been published yet compare the head of the
 221 branch with its upstream remote branch::
 222
 223     $ git log origin/v2..
 224     $ git log origin/v1..v1
 225
 226 For every branch that has an upstream remote branch git maintains an
 227 alias @{upstream} (short version @{u}), so the commands above can be
 228 given as::
 229
 230     $ git log @{u}..
 231     $ git log v1@{u}..v1
 232
 233 To see the status of all branches::
 234
 235     $ git branch -avv
 236
 237 To compare the status of local branches with a remote repo::
 238
 239     $ git remote show origin
 240
 241 Read `how to recover from upstream rebase
 242 <https://git-scm.com/docs/git-rebase#_recovering_from_upstream_rebase>`_.
 243 It is in ``git help rebase``.
 244
 245 On the other hand don't be too afraid about commit editing. You can
 246 safely edit, remove, reorder, combine and split commits that hasn't
 247 been pushed yet. You can even push commits to your own (backup) repo,
 248 edit them later and force-push edited commits to replace what has
 249 already been pushed. Not a problem until commits are in a public
 250 repository.
 251
 252
 253 Undo
 254 ====
 255
 256 TODO: describe undo strategies: git reset, git revert, git checkout,
 257 git reflog. "Commit early, commit often".
 258
 259 How to undo a merge
 260 https://kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html
 261
 262
 263 Advanced topics
 264 ===============
 265
 266 Staging area
 267 ------------
 268
 269 Staging area aka index is a distinguishing feature of git. See
 270 `WhatIsTheIndex
 271 <https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
 272 `IndexCommandQuickref
 273 <https://git.wiki.kernel.org/index.php/IndexCommandQuickref>`_ in Git
 274 Wiki.
 275
 276
 277 Advanced configuration
 278 ======================
 279
 280 Line endings
 281 ------------
 282
 283 Git has builtin mechanisms to handle line endings.
 284
 285 TODO: describe crlf configuration and .gitattributes.
 286
 287
 288 Null-merges
 289 ===========
 290
 291 Git has a builtin strategy for what Python core developers call
 292 "null-merge"::
 293
 294     $ git merge -s ours v1 # null-merge v1 into v2
 295
 296
 297 Database maintenance
 298 ====================
 299
 300 TODO: dangling objects, git gc, git repack.
 301
 302
 303 Tips and tricks
 304 ===============
 305
 306 TODO: bash/zsh completion, bash/zsh prompt.
 307
 308
 309 From Mercurial to git
 310 =====================
 311
 312 Mercurial for Git users https://mercurial.selenic.com/wiki/GitConcepts
 313
 314 https://github.com/felipec/git-remote-hg
 315
 316 https://hg-git.github.io/
 317
 318
 319 References
 320 ==========
 321
 322 .. []
 323
 324
 325 Copyright
 326 =========
 327
 328 This document has been placed in the public domain.
 329
 330
 331 \f
 332 ..
 333    Local Variables:
 334    mode: indented-text
 335    indent-tabs-mode: nil
 336    sentence-end-double-space: t
 337    fill-column: 70
 338    coding: utf-8
 339    End:
 340    vim: set fenc=us-ascii tw=70 :