Merge branch 'sg/doc-gc-quote-mismatch-fix'
authorJunio C Hamano <gitster@pobox.com>
Tue, 8 May 2018 06:59:26 +0000 (15:59 +0900)
committerJunio C Hamano <gitster@pobox.com>
Tue, 8 May 2018 06:59:26 +0000 (15:59 +0900)
Doc formatting fix.

* sg/doc-gc-quote-mismatch-fix:
docs/git-gc: fix minor rendering issue

1  2 
Documentation/git-gc.txt
diff --combined Documentation/git-gc.txt
index 3126e0dd002eca7ac420932bb9d1ace63752e8dc,2e159a1ebf512484ec75c2357a231da0602c42d3..7c8a2edd48fcdf8cd4fd8eca5d833983b6ccfbae
@@@ -15,9 -15,8 +15,9 @@@ DESCRIPTIO
  -----------
  Runs a number of housekeeping tasks within the current repository,
  such as compressing file revisions (to reduce disk space and increase
 -performance) and removing unreachable objects which may have been
 -created from prior invocations of 'git add'.
 +performance), removing unreachable objects which may have been
 +created from prior invocations of 'git add', packing refs, pruning
 +reflog, rerere metadata or stale working trees.
  
  Users are encouraged to run this task on a regular basis within
  each repository to maintain good disk space utilization and good
@@@ -46,25 -45,20 +46,25 @@@ OPTION
        With this option, 'git gc' checks whether any housekeeping is
        required; if not, it exits without performing any work.
        Some git commands run `git gc --auto` after performing
 -      operations that could create many loose objects.
 +      operations that could create many loose objects. Housekeeping
 +      is required if there are too many loose objects or too many
 +      packs in the repository.
  +
 -Housekeeping is required if there are too many loose objects or
 -too many packs in the repository. If the number of loose objects
 -exceeds the value of the `gc.auto` configuration variable, then
 -all loose objects are combined into a single pack using
 -`git repack -d -l`.  Setting the value of `gc.auto` to 0
 -disables automatic packing of loose objects.
 +If the number of loose objects exceeds the value of the `gc.auto`
 +configuration variable, then all loose objects are combined into a
 +single pack using `git repack -d -l`.  Setting the value of `gc.auto`
 +to 0 disables automatic packing of loose objects.
  +
  If the number of packs exceeds the value of `gc.autoPackLimit`,
  then existing packs (except those marked with a `.keep` file)
  are consolidated into a single pack by using the `-A` option of
  'git repack'. Setting `gc.autoPackLimit` to 0 disables
  automatic consolidation of packs.
 ++
 +If houskeeping is required due to many loose objects or packs, all
 +other housekeeping tasks (e.g. rerere, working trees, reflog...) will
 +be performed as well.
 +
  
  --prune=<date>::
        Prune loose objects older than date (default is 2 weeks ago,
@@@ -129,7 -123,7 +129,7 @@@ The optional configuration variable `gc
  much time is spent optimizing the delta compression of the objects in
  the repository when the --aggressive option is specified.  The larger
  the value, the more time is spent optimizing the delta compression.  See
- the documentation for the --window' option in linkgit:git-repack[1] for
+ the documentation for the --window option in linkgit:git-repack[1] for
  more details.  This defaults to 250.
  
  Similarly, the optional configuration variable `gc.aggressiveDepth`
@@@ -139,10 -133,6 +139,10 @@@ The optional configuration variable `gc
  the unreferenced loose objects have to be before they are pruned.  The
  default is "2 weeks ago".
  
 +Optional configuration variable `gc.worktreePruneExpire` controls how
 +old a stale working tree should be before `git worktree prune` deletes
 +it. Default is "3 months ago".
 +
  
  Notes
  -----