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>`_ or `msysGit
  79 <https://github.com/msysgit/msysgit/releases>`_.
  80
  81 MacOS X: use git installed with `XCode
  82 <https://developer.apple.com/xcode/downloads/>`_ or download from
  83 `MacPorts <https://www.macports.org/ports.php?by=name&substr=git>`_ or
  84 `git-osx-installer
  85 <http://sourceforge.net/projects/git-osx-installer/files/>`_ or
  86 install git with `Homebrew <http://brew.sh/>`_: ``brew install git``.
  87
  88 `Atlassins's SourceTree <https://www.sourcetreeapp.com/>`_ is a free
  89 Git and Mercurial GUI client for Windows or Mac.
  90
  91 Initial configuration
  92 ---------------------
  93
  94 This simple code is often appears in documentation, but it is
  95 important so let repeat it here. Git marks every commit with author
  96 and committer names/emails, so configure your real name and preferred
  97 email::
  98
  99     $ git config --global user.name "User Name"
 100     $ git config --global user.email user.name@example.org
 101
 102
 103 Examples in this PEP
 104 ====================
 105
 106 Examples of git commands in this PEP use the following approach. It is
 107 supposed that you, the user, works with a local repository named
 108 ``python`` that has an upstream remote repo named ``origin``. Your
 109 local repo has two branches ``v1`` and ``v2``. For most examples the
 110 currently checked out branch is ``v2``. That is, it's assumed you have
 111 done something like that::
 112
 113     $ git clone -b v2 http://git.python.org/python.git
 114     $ cd python
 115     $ git branch v1 origin/v1
 116
 117 The last command creates a new local branch v1 and sets
 118 remotes/origin/v1 as its upstream remote branch.
 119
 120 The same result can achieved with commands::
 121
 122     $ git clone -b v1 http://git.python.org/python.git
 123     $ cd python
 124     $ git checkout --track origin/v2
 125
 126 The last command creates a new local branch v2, sets
 127 remotes/origin/v2 as its upstream remote branch and checks it out into
 128 the working directory.
 129
 130
 131 Branches and branches
 132 =====================
 133
 134 Git terminology can be a bit misleading. Take, for example, the term
 135 "branch". In git it has two meanings. A branch is a directed line of
 136 commits (possibly with merges). And a branch is a label or a pointer
 137 assigned to a line of commits. It is important to differentiate when
 138 you talk about commits and when about their labels. Lines of commits
 139 are by itself unnamed and are usually only lengthening and merging.
 140 Labels, on the other hand, can be created, moved, renamed and deleted
 141 freely.
 142
 143
 144 Remote repository and remote branches
 145 =====================================
 146
 147 Another example of slightly misleading terminology. Remote
 148 repositories are really remote, you access them via network (well, a
 149 remote repository can be on your local disk, but it's still remote
 150 because it's not the current repo).
 151
 152 Remote branches, on the other hand, are branches (pointers to commits)
 153 in your local repository. They are there for you to remember what
 154 branches and commits have been pulled from and pushed to what remote
 155 repos (you can pull from and push to many remotes). Remote branches
 156 live under ``remotes/REMOTE`` namespaces, e.g. ``remotes/origin/v2``.
 157
 158 To see the status of remote branches run::
 159
 160     $ git branch -rv
 161
 162 To see local and remote branches (and tags) pointing to commits::
 163
 164     $ git log --decorate
 165
 166 You never do your own development on remote branches. You create a
 167 local branch that has a remote branch as upstream and do development
 168 on that local branch. On push git updates remote branches, and on pull
 169 git updates remote branches and fast-forwards, merges or rebases local
 170 branches.
 171
 172 When you do an initial clone like this::
 173
 174     $ git clone -b v1 http://git.python.org/python.git
 175
 176 git clones remote repository ``http://git.python.org/python.git`` to
 177 directory ``python``, creates remote branches, creates a local branch
 178 ``v1``, configure it to track upstream remotes/origin/v1 branch and
 179 checks out ``v1`` into the working directory.
 180
 181 Updating local and remote branches
 182 ----------------------------------
 183
 184 There is a major difference between
 185
 186 ::
 187
 188     $ git fetch REMOTE BRANCH
 189
 190 and
 191
 192 ::
 193
 194     $ git fetch REMOTE BRANCH:BRANCH
 195
 196 The first command fetches commits from the named BRANCH in the REMOTE
 197 repository that are not in your repository and leaves the id (the
 198 hash) of the head commit in file .git/FETCH_HEAD. But it doesn't
 199 update any branch (doesn't move any pointer).
 200
 201 The second command fetches commits from the named BRANCH in the REMOTE
 202 repository that are not in your repository and updates both the local
 203 branch BRANCH and its upstream remote branch. But it refuses to update
 204 branches in case of non-fast-forward. And it refuses to update the
 205 current branch.
 206
 207 The first command is used internally by ``git pull``.
 208
 209 ::
 210
 211     $ git pull REMOTE BRANCH
 212
 213 is equivalent to
 214
 215 ::
 216
 217     $ git fetch REMOTE BRANCH
 218     $ git merge FETCH_HEAD # FETCH_HEAD is a literal here
 219
 220 Certainly, BRANCH in that case should be your current branch. If you
 221 want to merge a different branch into your current branch first update
 222 that non-current branch and then merge::
 223
 224     $ git fetch origin v1:v1 # Update v1
 225     $ git pull --rebase origin v2 # Update the current branch v2 using
 226                                   # rebase instead of merge
 227     $ git merge v1
 228
 229 It is possible to configure git to make it fetch/pull a few branches
 230 or all branches at once, so you can simply run
 231
 232 ::
 233
 234     $ git pull origin
 235
 236 or even
 237
 238 ::
 239
 240     $ git pull
 241
 242 Push
 243 ''''
 244
 245 Pushing is a bit simpler. There is only one command ``push``. When you
 246 run
 247
 248 ::
 249
 250     $ git push origin v1 v2
 251
 252 git guesses (knowing upstream remote branches) that you really want
 253
 254 ::
 255
 256     $ git push origin v1:v1 v2:v2
 257
 258 Git pushes commits to the remote repo and updates remote branches. Git
 259 refuses to push commits that aren't fast-forwardable. You can
 260 force-push anyway, but please remember - you can force-push to your
 261 own repositories but don't force-push to public or shared repos. If
 262 you find git refuses to push commits that aren't fast-forwardable,
 263 better fetch and merge commits from the remote repo (or rebase your
 264 commits on top of the fetched commits), then push. Only force-push if
 265 you know what you do and why you do it. See the section `Commit
 266 editing and caveats`_ below.
 267
 268 It is possible to configure git to make it push a few branches or all
 269 branches at once, so you can simply run
 270
 271 ::
 272
 273     $ git push origin
 274
 275 or even
 276
 277 ::
 278
 279     $ git push
 280
 281 Git refuses to push a branch if it's the current branch in the remote
 282 non-bare repository: git refuses to update remote working directory.
 283 You really should push only to bare repositories. For non-bare
 284 repositories git prefers pull-based workflow.
 285
 286 When you want to deploy code on a remote host and can only use push
 287 (because your workstation is behind a firewall and you cannot pull
 288 from it) you do that in two steps using two repositories: you push
 289 from the workstation to a bare repo on the remote host, ssh to the
 290 remote host and pull from the bare repo to a non-bare deployment repo.
 291
 292 Tags
 293 ''''
 294
 295 Git automatically fetches tags that point to commits being fetched
 296 during fetch/pull. To fetch all tags (and commits they point to) run
 297 ``git fetch --tags origin``. To fetch some specific tags fetch them
 298 explicitly::
 299
 300     $ git fetch origin tag TAG1 tag TAG2...
 301
 302 For example::
 303
 304     $ git fetch origin tag 1.4.2 tag 2.1.7
 305
 306 Git doesn't automatically pushes tags. That allows you to have private
 307 tags (lightweight tags are also private for a repo, they cannot be
 308 pushed). To push tags list them explicitly::
 309
 310     $ git push origin tag 1.4.2
 311     $ git push origin v1 v2 tag 2.1.7
 312
 313 Don't move tags with ``git tag -f`` after they have been published.
 314
 315
 316 Commit editing and caveats
 317 ==========================
 318
 319 A warning not to edit published (pushed) commits also appears in
 320 documentation but it's repeated here anyway as it's very important.
 321
 322 It is possible to recover from forced push but it's PITA for the
 323 entire team. Please avoid it.
 324
 325 To see what commits have not been published yet compare the head of the
 326 branch with its upstream remote branch::
 327
 328     $ git log origin/v2..
 329     $ git log origin/v1..v1
 330
 331 For every branch that has an upstream remote branch git maintains an
 332 alias @{upstream} (short version @{u}), so the commands above can be
 333 given as::
 334
 335     $ git log @{u}..
 336     $ git log v1@{u}..v1
 337
 338 To see the status of all branches::
 339
 340     $ git branch -avv
 341
 342 To compare the status of local branches with a remote repo::
 343
 344     $ git remote show origin
 345
 346 Read `how to recover from upstream rebase
 347 <https://git-scm.com/docs/git-rebase#_recovering_from_upstream_rebase>`_.
 348 It is in ``git help rebase``.
 349
 350 On the other hand don't be too afraid about commit editing. You can
 351 safely edit, remove, reorder, combine and split commits that hasn't
 352 been pushed yet. You can even push commits to your own (backup) repo,
 353 edit them later and force-push edited commits to replace what has
 354 already been pushed. Not a problem until commits are in a public
 355 or shared repository.
 356
 357
 358 Undo
 359 ====
 360
 361 TODO: describe undo strategies: git reset, git revert, git checkout,
 362 git reflog. "Commit early, commit often".
 363
 364 How to undo a merge
 365 https://kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html
 366
 367
 368 Advanced topics
 369 ===============
 370
 371 Staging area
 372 ------------
 373
 374 Staging area aka index is a distinguishing feature of git. See
 375 `WhatIsTheIndex
 376 <https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
 377 `IndexCommandQuickref
 378 <https://git.wiki.kernel.org/index.php/IndexCommandQuickref>`_ in Git
 379 Wiki.
 380
 381
 382 Merge or rebase?
 383 ================
 384
 385
 386 Null-merges
 387 ===========
 388
 389 Git has a builtin strategy for what Python core developers call
 390 "null-merge"::
 391
 392     $ git merge -s ours v1 # null-merge v1 into v2
 393
 394
 395 ReReRe
 396 ======
 397
 398 https://git-scm.com/book/en/Git-Tools-Rerere
 399
 400
 401 Advanced configuration
 402 ======================
 403
 404 Line endings
 405 ------------
 406
 407 Git has builtin mechanisms to handle line endings.
 408
 409 TODO: describe crlf configuration and .gitattributes.
 410
 411
 412 Database maintenance
 413 ====================
 414
 415 TODO: dangling objects, git gc, git repack.
 416
 417
 418 Tips and tricks
 419 ===============
 420
 421 TODO: sticky options; example: git grep -O.
 422
 423 TODO: bash/zsh completion, bash/zsh prompt.
 424
 425
 426 From Mercurial to git
 427 =====================
 428
 429 Mercurial for Git users https://mercurial.selenic.com/wiki/GitConcepts
 430
 431 https://github.com/felipec/git-remote-hg
 432
 433 https://hg-git.github.io/
 434
 435
 436 References
 437 ==========
 438
 439 .. []
 440
 441
 442 Copyright
 443 =========
 444
 445 This document has been placed in the public domain.
 446
 447
 448 \f
 449 ..
 450    Local Variables:
 451    mode: indented-text
 452    indent-tabs-mode: nil
 453    sentence-end-double-space: t
 454    fill-column: 70
 455    coding: utf-8
 456    End:
 457    vim: set fenc=us-ascii tw=70 :