]> git.phdru.name Git - git-wiki.git/commitdiff
Change wording
authorOleg Broytman <phd@phdru.name>
Tue, 2 Jun 2015 07:29:30 +0000 (10:29 +0300)
committerOleg Broytman <phd@phdru.name>
Tue, 2 Jun 2015 16:58:31 +0000 (19:58 +0300)
pep-git.txt

index 0a120b479eb391b1063c1ae7fea15b77be7d76ea..9f7eeea29faf08bcbecd3a224efe9b220606409e 100644 (file)
@@ -14,7 +14,7 @@ Abstract
 
 This Informational PEP collects information about git. There is, of
 course, a lot of documentation for git, so the PEP concentrates on
-more complex issues, topics and scenarios.
+more complex issues, scenarios and topics.
 
 The plan is to extend the PEP in the future collecting information
 about equivalence of Mercurial and git scenarios to help migrating
@@ -86,13 +86,13 @@ Initial configuration
 ---------------------
 
 This simple code is often appears in documentation, but it is
-important so let repeat it here::
+important so let repeat it here. Git marks every commit with author
+and commiter names/emails, so configure your real name and preferred
+email::
 
     $ git config --global user.name "User Name"
     $ git config --global user.email user.name@example.org
 
-Put your real name and preferred email.
-
 
 Examples in this PEP
 ====================
@@ -114,32 +114,34 @@ Branches and branches
 =====================
 
 Git terminology can be a bit misleading. Take, for example, the term
-"branch". In git it has two meanings. A branch is a directed chain of
-commits (possible with merges). And a branch is a label or a pointer
+"branch". In git it has two meanings. A branch is a directed line of
+commits (possibly with merges). And a branch is a label or a pointer
 assigned to a line of commits. It is important to differentiate when
-you talk about commits and when about their labels. Chains of commits
-are unnamed and are usually only lengthening. Labels, on the other
-hand, can be created, moved, renamed and deleted freely.
+you talk about commits and when about their labels. Lines of commits
+are by itself unnamed and are usually only lengthening and merging.
+Labels, on the other hand, can be created, moved, renamed and deleted
+freely.
 
 
 Remote repository and remote branches
 =====================================
 
-Another example of misleading terminology. A remote repository is
-really remote, you access it via network (well, a remote repository
-can be on your local disk, but it's still remote because it's not the
-current repo).
+Another example of slightly misleading terminology. Remote
+repositories are really remote, you access them via network (well, a
+remote repository can be on your local disk, but it's still remote
+because it's not the current repo).
 
 Remote branches, on the other hand, are branches (pointers to commits)
-in your local repository. They are there for git to remember what
+in your local repository. They are there for you to remember what
 branches and commits have been pulled from and pushed to what remote
-repos (you can pull from and push to many remotes).
+repos (you can pull from and push to many remotes). Remote branches
+live under ``remotes/REMOTE`` namespaces, e.g. ``remotes/origin/v2``.
 
-To see the status of remote branches::
+To see the status of remote branches run::
 
     $ git branch -rv
 
-To see local and remote branches (and tags) pointing to commits run::
+To see local and remote branches (and tags) pointing to commits::
 
     $ git log --decorate