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://github.com/git-for-windows/git/releases>`_.
  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 committer 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 pointer).
 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 internally 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 It is possible to configure git to make it fetch/pull a few branches
 211 or all branches at once, so you can simply run
 212
 213 ::
 214
 215     $ git pull origin
 216
 217 or even
 218
 219 ::
 220
 221     $ git pull
 222
 223 Push
 224 ''''
 225
 226 Pushing is a bit simpler. There is only one command ``push``. When you
 227 run
 228
 229 ::
 230
 231     $ git push origin v1 v2
 232
 233 git guesses (knowing upstream remote branches) that you really want
 234
 235 ::
 236
 237     $ git push origin v1:v1 v2:v2
 238
 239 Git pushes commits to the remote repo and updates remote branches. Git
 240 refuses to push commits that aren't fast-forwardable. You can
 241 force-push anyway, but please remember - you can force-push to your
 242 own repositories but don't force-push to public or shared repos. If
 243 you find git refuses to push commits that aren't fast-forwardable,
 244 better fetch and merge commits from the remote repo (or rebase your
 245 commits on top of the fetched commits), then push. Only force-push if
 246 you know what you do and why you do it. See the section `Commit
 247 editing and caveats`_ below.
 248
 249 It is possible to configure git to make it push a few branches or all
 250 branches at once, so you can simply run
 251
 252 ::
 253
 254     $ git push origin
 255
 256 or even
 257
 258 ::
 259
 260     $ git push
 261
 262 Git refuses to push a branch if it's the current branch in the remote
 263 non-bare repository: git refuses to update remote working directory.
 264 You really should push only to bare repositories. For non-bare
 265 repositories git prefers pull-based workflow.
 266
 267 Tags
 268 ''''
 269
 270 Git automatically fetches tags that point to commits being fetched
 271 during fetch/pull. To fetch all tags (and commits they point to) run
 272 ``git fetch --tags origin``. To fetch some specific tags fetch them
 273 explicitly::
 274
 275     $ git fetch origin tag NAME1 tag NAME2...
 276
 277 For example::
 278
 279     $ git fetch origin tag 1.4.2 tag 2.1.7
 280
 281 Git doesn't automatically pushes tags. That allows you to have private
 282 tags (lightweight tags are also private for a repo, they cannot be
 283 pushed). To push tag(s) list them explicitly::
 284
 285     $ git push origin tag 1.4.2
 286     $ git push origin v1 v2 tag 2.1.7
 287
 288
 289 Commit editing and caveats
 290 ==========================
 291
 292 A warning not to edit published (pushed) commits also appears in
 293 documentation but it's repeated here anyway as it's very important.
 294
 295 It is possible to recover from forced push but it's PITA for the
 296 entire team. Please avoid it.
 297
 298 To see what commits have not been published yet compare the head of the
 299 branch with its upstream remote branch::
 300
 301     $ git log origin/v2..
 302     $ git log origin/v1..v1
 303
 304 For every branch that has an upstream remote branch git maintains an
 305 alias @{upstream} (short version @{u}), so the commands above can be
 306 given as::
 307
 308     $ git log @{u}..
 309     $ git log v1@{u}..v1
 310
 311 To see the status of all branches::
 312
 313     $ git branch -avv
 314
 315 To compare the status of local branches with a remote repo::
 316
 317     $ git remote show origin
 318
 319 Read `how to recover from upstream rebase
 320 <https://git-scm.com/docs/git-rebase#_recovering_from_upstream_rebase>`_.
 321 It is in ``git help rebase``.
 322
 323 On the other hand don't be too afraid about commit editing. You can
 324 safely edit, remove, reorder, combine and split commits that hasn't
 325 been pushed yet. You can even push commits to your own (backup) repo,
 326 edit them later and force-push edited commits to replace what has
 327 already been pushed. Not a problem until commits are in a public
 328 repository.
 329
 330
 331 Undo
 332 ====
 333
 334 TODO: describe undo strategies: git reset, git revert, git checkout,
 335 git reflog. "Commit early, commit often".
 336
 337 How to undo a merge
 338 https://kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html
 339
 340
 341 Advanced topics
 342 ===============
 343
 344 Staging area
 345 ------------
 346
 347 Staging area aka index is a distinguishing feature of git. See
 348 `WhatIsTheIndex
 349 <https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
 350 `IndexCommandQuickref
 351 <https://git.wiki.kernel.org/index.php/IndexCommandQuickref>`_ in Git
 352 Wiki.
 353
 354
 355 Merge or rebase?
 356 ================
 357
 358
 359 Null-merges
 360 ===========
 361
 362 Git has a builtin strategy for what Python core developers call
 363 "null-merge"::
 364
 365     $ git merge -s ours v1 # null-merge v1 into v2
 366
 367
 368 ReReRe
 369 ======
 370
 371 https://git-scm.com/book/en/Git-Tools-Rerere
 372
 373
 374 Advanced configuration
 375 ======================
 376
 377 Line endings
 378 ------------
 379
 380 Git has builtin mechanisms to handle line endings.
 381
 382 TODO: describe crlf configuration and .gitattributes.
 383
 384
 385 Database maintenance
 386 ====================
 387
 388 TODO: dangling objects, git gc, git repack.
 389
 390
 391 Tips and tricks
 392 ===============
 393
 394 TODO: bash/zsh completion, bash/zsh prompt.
 395
 396
 397 From Mercurial to git
 398 =====================
 399
 400 Mercurial for Git users https://mercurial.selenic.com/wiki/GitConcepts
 401
 402 https://github.com/felipec/git-remote-hg
 403
 404 https://hg-git.github.io/
 405
 406
 407 References
 408 ==========
 409
 410 .. []
 411
 412
 413 Copyright
 414 =========
 415
 416 This document has been placed in the public domain.
 417
 418
 419 \f
 420 ..
 421    Local Variables:
 422    mode: indented-text
 423    indent-tabs-mode: nil
 424    sentence-end-double-space: t
 425    fill-column: 70
 426    coding: utf-8
 427    End:
 428    vim: set fenc=us-ascii tw=70 :