2 Title: Collecting information about git
5 Author: Oleg Broytman <phd@phdru.name>
8 Content-Type: text/x-rst
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, topics and scenarios.
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.
23 The author of the PEP doesn't currently plan to write a Process PEP on
24 migration from Mercurial to git.
30 Git is accompanied with a lot of documentation, both online and
33 Documentation for starters
34 --------------------------
37 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial.html>`_,
39 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial-2.html>`_.
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>`_.
46 <https://www.kernel.org/pub/software/scm/git/docs/gitworkflows.html>`_.
49 <http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html>`_,
50 also with a number of translations.
52 Advanced documentation
53 ----------------------
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>`_.
60 `Git Wiki <https://git.wiki.kernel.org/index.php/Main_Page>`_.
65 Git has builtin help: run ``git help TOPIC``. For example, run
66 ``git help git`` or ``git help help``.
72 Download and installation
73 -------------------------
75 Unix users: download and install using your package manager.
77 Microsoft Windows: download `git-for-windows
78 <https://git-for-windows.github.io/>`_.
80 MacOS X: use git installed with `XCode
81 <https://developer.apple.com/xcode/downloads/>`_ or download
83 <http://sourceforge.net/projects/git-osx-installer/files/>`_.
88 This simple code is often appears in documentation, but it is
89 important so let repeat it here::
91 $ git config --global user.name "User Name"
92 $ git config --global user.email user.name@example.org
94 Put your real name and preferred email.
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::
107 $ git clone -b v1 http://git.python.org/python.git
109 $ git fetch origin v2:v2
113 Commit editing and caveats
114 ==========================
116 A warning not to edit published (pushed) commits also appears in
117 documentation but it's also repeated here as it's very important.
119 It is possible to recover from forced push but it's PITA for the
120 entire team. Please avoid it.
122 To see what commits have not been published yet compare the head of the
123 branch with its upstream remote branch::
125 $ git log origin/v2..
126 $ git log origin/v1..v1
128 For every branch that has an upstream remote branch git maintains an
129 alias @{upstream} (short version @{u}), so the commands above can be
135 To see the status of all branches::
139 To compare the status of local branches with a remote repo::
141 $ git remote show origin
143 Read `how to recover from upstream rebase
144 <https://git-scm.com/docs/git-rebase#_recovering_from_upstream_rebase>`_.
145 It is in ``git help rebase``.
147 On the other hand don't be too afraid about commit editing. You can
148 safely edit, remove, reorder, combine and split commits that hasn't
149 been pushed yet. You can even push commits to your own (backup) repo,
150 edit them later and force-push edited commits to replace what has
151 already been pushed. Not a problem until commits are in a public
164 This document has been placed in the public domain.
171 indent-tabs-mode: nil
172 sentence-end-double-space: t
176 vim: set fenc=us-ascii tw=70 :