Add an explanation about examples

[git-wiki.git] / pep-git.txt

diff --git a/pep-git.txt b/pep-git.txt
index e8a7673dfa43bb8de78b38d65ca3639b05af77bd..a2e2780905cb3d8699dd56bbd0fb0e1f760a3f02 100644 (file)
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -23,6 +23,7 @@ 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
 =============
 
@@ -64,6 +65,7 @@ Offline documentation
 Git has builtin help: run ``git help TOPIC``. For example, run
 ``git help git`` or ``git help help``.
 
+
 Quick start
 ===========
 
@@ -80,6 +82,26 @@ MacOS X: use git installed with `XCode
 `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``.
+
+
 References
 ==========