Add an explanation about examples

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

diff --git a/pep-git.txt b/pep-git.txt
index 118787f5881089b7e77b3804a123503012ac6001..a2e2780905cb3d8699dd56bbd0fb0e1f760a3f02 100644 (file)
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -92,6 +92,16 @@ important so let repeat it here::
     $ 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
 ==========