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, topics and scenarios.
  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 Documentation
  27 =============
  28
  29 Git is accompanied with a lot of documentation, both online and
  30 offline.
  31
  32 Documentation for starters
  33 --------------------------
  34
  35 Git Tutorial: `part 1
  36 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial.html>`_,
  37 `part 2
  38 <https://www.kernel.org/pub/software/scm/git/docs/gittutorial-2.html>`_.
  39
  40 `Git User's manual
  41 <https://www.kernel.org/pub/software/scm/git/docs/user-manual.html>`_.
  42 `Everyday GIT With 20 Commands Or So
  43 <https://www.kernel.org/pub/software/scm/git/docs/everyday.html>`_.
  44 `Git workflows
  45 <https://www.kernel.org/pub/software/scm/git/docs/gitworkflows.html>`_.
  46
  47 `Git Magic
  48 <http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html>`_,
  49 also with a number of translations.
  50
  51 Advanced documentation
  52 ----------------------
  53
  54 `Pro Git <https://git-scm.com/book>`_. The Book about git. Buy it at
  55 Amazon or download in PDF, mobi, or ePub form. Has translations to
  56 many different languages. Download Russian translation from `GArik
  57 <https://github.com/GArik/progit/wiki>`_.
  58
  59 `Git Wiki <https://git.wiki.kernel.org/index.php/Main_Page>`_.
  60
  61 Offline documentation
  62 ---------------------
  63
  64 Git has builtin help: run ``git help TOPIC``. For example, run
  65 ``git help git`` or ``git help help``.
  66
  67 References
  68 ==========
  69
  70 .. []
  71
  72
  73 Copyright
  74 =========
  75
  76 This document has been placed in the public domain.
  77
  78
  79 \f
  80 ..
  81    Local Variables:
  82    mode: indented-text
  83    indent-tabs-mode: nil
  84    sentence-end-double-space: t
  85    fill-column: 70
  86    coding: utf-8
  87    End:
  88    vim: set fenc=us-ascii tw=70 :