From: Oleg Broytman <phd@phdru.name>
Date: Thu, 20 Aug 2015 02:31:21 +0000 (+0300)
Subject: Change wording and formatting
X-Git-Url: https://git.phdru.name/?a=commitdiff_plain;h=d0784f8e3802bbb89683024783d744c04c13a4bc;p=git-wiki.git

Change wording and formatting
---

diff --git a/pep-git.txt b/pep-git.txt
index 1d16640..2f5a5b0 100644
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -662,7 +662,7 @@ To see the diff between the index and the last commit (i.e., collected
 patches) use ``git diff --cached``. To see the diff between the
 working tree and the index (i.e., uncollected patches) use just ``git
 diff``. To see the diff between the working tree and the last commit
-(i.e., both collected and uncollected patches) use ``git diff HEAD``.
+(i.e., both collected and uncollected patches) run ``git diff HEAD``.
 
 See `WhatIsTheIndex
 <https://git.wiki.kernel.org/index.php/WhatIsTheIndex>`_ and
@@ -680,20 +680,22 @@ https://git-scm.com/book/en/Git-Tools-Rerere
 Database maintenance
 ====================
 
-Git object database and other files/directories under .git require
+Git object database and other files/directories under ``.git`` require
 periodic maintenance and cleanup. For example, commit editing left
 unreferenced objects (dangling objects, in git terminology) and these
 objects should be pruned to avoid collecting cruft in the DB. The
-command ``git gc`` can be used for maintenance. Git runs ``git gc
---auto`` as a part of some commands to do quick maintenance. Users are
-recommended to run ``git gc --aggressive`` from time to time; ``git
-help gc`` recommends to run it  every few hundred changesets; for more
-intensive projects it should be something like once a week and less
-frequent (biweekly or monthly) for lesser active projects.
+command ``git gc`` is used for maintenance. Git automatically runs
+``git gc --auto`` as a part of some commands to do quick maintenance.
+Users are recommended to run ``git gc --aggressive`` from time to
+time; ``git help gc`` recommends to run it  every few hundred
+changesets; for more intensive projects it should be something like
+once a week and less frequently (biweekly or monthly) for lesser
+active projects.
 
 ``git gc --aggressive`` not only removes dangling objects, it also
-repacks object database into indexed and better optimized pack(s).
-Another way to do it is to run ``git repack``.
+repacks object database into indexed and better optimized pack(s); it
+also packs symbolic references (branches and tags). Another way to do
+it is to run ``git repack``.
 
 There is a well-known `message
 <https://gcc.gnu.org/ml/gcc/2007-12/msg00165.html>`_ from Linus
@@ -708,7 +710,8 @@ the recommended parameters are ``git repack -a -d -f --depth=20
 for explanation on the effects of these parameters.
 
 From time to time run ``git fsck [--strict]`` to verify integrity of
-the database.
+the database. ``git fsck`` could report dangling objects; that's not
+an error, just a reminder to perform regular maintenance.
 
 
 Tips and tricks