X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=pep-git.txt;h=d995d2456fe367ceaa1d0fa0a8081274497d2e2c;hb=2081cc6efd1cc32ab084713a7e2d30d435f93131;hp=3e13d14ac4881688e36a65ad2d8564c1481b09e0;hpb=505205bf5aafd921ae626fd13dcbdf55d3498a2b;p=git-wiki.git

diff --git a/pep-git.txt b/pep-git.txt
index 3e13d14..d995d24 100644
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -23,9 +23,124 @@ Python development from Mercurial to git.
 The author of the PEP doesn't currently plan to write a Process PEP on
 migration from Mercurial to git.
 
+
+Documentation
+=============
+
+Git is accompanied with a lot of documentation, both online and
+offline.
+
+Documentation for starters
+--------------------------
+
+Git Tutorial: `part 1
+<https://www.kernel.org/pub/software/scm/git/docs/gittutorial.html>`_,
+`part 2
+<https://www.kernel.org/pub/software/scm/git/docs/gittutorial-2.html>`_.
+
+`Git User's manual
+<https://www.kernel.org/pub/software/scm/git/docs/user-manual.html>`_.
+`Everyday GIT With 20 Commands Or So
+<https://www.kernel.org/pub/software/scm/git/docs/everyday.html>`_.
+`Git workflows
+<https://www.kernel.org/pub/software/scm/git/docs/gitworkflows.html>`_.
+
+`Git Magic
+<http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html>`_,
+also with a number of translations.
+
+Advanced documentation
+----------------------
+
+`Pro Git <https://git-scm.com/book>`_. The Book about git. Buy it at
+Amazon or download in PDF, mobi, or ePub form. Has translations to
+many different languages. Download Russian translation from `GArik
+<https://github.com/GArik/progit/wiki>`_.
+
+`Git Wiki <https://git.wiki.kernel.org/index.php/Main_Page>`_.
+
+Offline documentation
+---------------------
+
+Git has builtin help: run ``git help TOPIC``. For example, run
+``git help git`` or ``git help help``.
+
+
+Quick start
+===========
+
+Download and installation
+-------------------------
+
+Unix users: download and install using your package manager.
+
+Microsoft Windows: download `git-for-windows
+<https://git-for-windows.github.io/>`_.
+
+MacOS X: use git installed with `XCode
+<https://developer.apple.com/xcode/downloads/>`_ or download
+`git-osx-installer
+<http://sourceforge.net/projects/git-osx-installer/files/>`_.
+
+Initial configuration
+---------------------
+
+This simple code is often appears in documentation, but it is
+important so let repeat it here::
+
+    $ git config --global user.name "User Name"
+    $ git config --global user.email user.name@example.org
+
+
+Examples in this PEP
+====================
+
+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``. Usually the currently
+checked out branch is ``v2``.
+
+
+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.
+
+It is possible to recover from forced push but it's PITA for the
+entire team. Please avoid it.
+
+To see what commits have not been published yet see the head of the
+remote branch::
+
+    $ git log origin/v2..
+
+For every branch that has an upstream remote branch git maintains an
+alias @{upstream} (short version @{u})::
+
+    $ git log @{u}..
+    $ git log v1@{u}..v1
+
+To see the status of all branches::
+
+    $ git branch -avv
+
+Read `how to recover from upstream rebase
+<https://git-scm.com/docs/git-rebase#_recovering_from_upstream_rebase>`_.
+It is in ``git help rebase``.
+
+On the other hand don't be too afraid about commit editing. You can
+safely edit 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.
+
+
 References
 ==========
 
+.. [] 
+
 
 Copyright
 =========