Autogenerated HTML docs for v1.5.0-rc0-g7c20b
authorJunio C Hamano <junio@hera.kernel.org>
Thu, 28 Dec 2006 00:59:38 +0000 (00:59 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Thu, 28 Dec 2006 00:59:38 +0000 (00:59 +0000)
everyday.html
everyday.txt
git-gc.html [new file with mode: 0644]
git-gc.txt [new file with mode: 0644]
git.html
git.txt

index c2562a7c676556386b8552f43a42252c257d7bab..c36c9357f1ab4d7927d05669a2160f35261c3648 100644 (file)
@@ -303,6 +303,12 @@ of git repositories.</p>
 <a href="git-repack.html">git-repack(1)</a> to pack loose objects for efficiency.\r
 </p>\r
 </li>\r
+<li>\r
+<p>\r
+<a href="git-gc.html">git-gc(1)</a> to do common housekeeping tasks such as\r
+    repack and prune.\r
+</p>\r
+</li>\r
 </ul>\r
 <h3>Examples</h3>\r
 <dl>\r
@@ -313,10 +319,9 @@ Check health and remove cruft.
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>$ git fsck-objects <b>(1)</b>\r
-$ git prune\r
 $ git count-objects <b>(2)</b>\r
 $ git repack <b>(3)</b>\r
-$ git prune <b>(4)</b></tt></pre>\r
+$ git gc <b>(4)</b></tt></pre>\r
 </div></div>\r
 <ol>\r
 <li>\r
@@ -339,7 +344,8 @@ of loose objects accumulation may be a good rule of thumb.
 </li>\r
 <li>\r
 <p>\r
-after repack, prune removes the duplicate loose objects.\r
+it is easier to use <tt>git gc</tt> than individual housekeeping commands\r
+such as <tt>prune</tt> and <tt>repack</tt>.  This runs <tt>repack -a -d</tt>.\r
 </p>\r
 </li>\r
 </ol>\r
@@ -1064,7 +1070,7 @@ upload to public HTTP server hosted by your ISP.
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 27-Dec-2006 10:59:46 UTC\r
+Last updated 28-Dec-2006 00:59:31 UTC\r
 </div>\r
 </div>\r
 </body>\r
index 5d17ace721d1ec4c031a4a1f96374559002a93c9..2105a3d2e7337105263c8a9fef466609c63fc163 100644 (file)
@@ -34,6 +34,9 @@ Everybody uses these commands to maintain git repositories.
 
   * gitlink:git-repack[1] to pack loose objects for efficiency.
 
+  * gitlink:git-gc[1] to do common housekeeping tasks such as
+    repack and prune.
+
 Examples
 ~~~~~~~~
 
@@ -41,10 +44,9 @@ Check health and remove cruft.::
 +
 ------------
 $ git fsck-objects <1>
-$ git prune
 $ git count-objects <2>
 $ git repack <3>
-$ git prune <4>
+$ git gc <4>
 ------------
 +
 <1> running without `\--full` is usually cheap and assures the
@@ -53,7 +55,8 @@ repository health reasonably well.
 disk space is wasted by not repacking.
 <3> without `-a` repacks incrementally.  repacking every 4-5MB
 of loose objects accumulation may be a good rule of thumb.
-<4> after repack, prune removes the duplicate loose objects.
+<4> it is easier to use `git gc` than individual housekeeping commands
+such as `prune` and `repack`.  This runs `repack -a -d`.
 
 Repack a small project into single pack.::
 +
diff --git a/git-gc.html b/git-gc.html
new file mode 100644 (file)
index 0000000..d98934e
--- /dev/null
@@ -0,0 +1,330 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 7.0.2" />\r
+<style type="text/css">\r
+/* Debug borders */\r
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
+/*\r
+  border: 1px solid red;\r
+*/\r
+}\r
+\r
+body {\r
+  margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a { color: blue; }\r
+a:visited { color: fuchsia; }\r
+\r
+em {\r
+  font-style: italic;\r
+}\r
+\r
+strong {\r
+  font-weight: bold;\r
+}\r
+\r
+tt {\r
+  color: navy;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  margin-top: 1.2em;\r
+  margin-bottom: 0.5em;\r
+  line-height: 1.3;\r
+}\r
+\r
+h1 {\r
+  border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+  border-bottom: 2px solid silver;\r
+  padding-top: 0.5em;\r
+}\r
+\r
+div.sectionbody {\r
+  font-family: serif;\r
+  margin-left: 0;\r
+}\r
+\r
+hr {\r
+  border: 1px solid silver;\r
+}\r
+\r
+p {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+pre {\r
+  padding: 0;\r
+  margin: 0;\r
+}\r
+\r
+span#author {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  font-size: 1.2em;\r
+}\r
+span#email {\r
+}\r
+span#revision {\r
+  font-family: sans-serif;\r
+}\r
+\r
+div#footer {\r
+  font-family: sans-serif;\r
+  font-size: small;\r
+  border-top: 2px solid silver;\r
+  padding-top: 0.5em;\r
+  margin-top: 4.0em;\r
+}\r
+div#footer-text {\r
+  float: left;\r
+  padding-bottom: 0.5em;\r
+}\r
+div#footer-badges {\r
+  float: right;\r
+  padding-bottom: 0.5em;\r
+}\r
+\r
+div#preamble,\r
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+  margin-right: 10%;\r
+  margin-top: 1.5em;\r
+  margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+  margin-top: 2.5em;\r
+  margin-bottom: 2.5em;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+  padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  text-align: left;\r
+  margin-top: 1.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+  margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+  margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock > div.content {\r
+  padding-left: 2.0em;\r
+}\r
+div.quoteblock .attribution {\r
+  text-align: right;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+  vertical-align: top;\r
+  font-size: 1.1em;\r
+  font-weight: bold;\r
+  text-decoration: underline;\r
+  color: #527bbd;\r
+  padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+  padding-left: 0.5em;\r
+  border-left: 2px solid silver;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+  border-left: 2px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.verseblock div.content {\r
+  white-space: pre;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+div.imageblock img { border: 1px solid silver; }\r
+span.image img { border-style: none; }\r
+\r
+dl {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+dt {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0;\r
+  font-style: italic;\r
+}\r
+dd > *:first-child {\r
+  margin-top: 0;\r
+}\r
+\r
+ul, ol {\r
+    list-style-position: outside;\r
+}\r
+ol.olist2 {\r
+  list-style-type: lower-alpha;\r
+}\r
+\r
+div.tableblock > table {\r
+  border-color: #527bbd;\r
+  border-width: 3px;\r
+}\r
+thead {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+}\r
+tfoot {\r
+  font-weight: bold;\r
+}\r
+\r
+div.hlist {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+td.hlist1 {\r
+  vertical-align: top;\r
+  font-style: italic;\r
+  padding-right: 0.8em;\r
+}\r
+td.hlist2 {\r
+  vertical-align: top;\r
+}\r
+\r
+@media print {\r
+  div#footer-badges { display: none; }\r
+}\r
+include::./stylesheets/xhtml11-manpage.css[]\r
+/* Workarounds for IE6's broken and incomplete CSS2. */\r
+\r
+div.sidebar-content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+div.sidebar-title, div.image-title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  margin-top: 0.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+div.listingblock div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock-content {\r
+  padding-left: 2.0em;\r
+}\r
+\r
+div.exampleblock-content {\r
+  border-left: 2px solid silver;\r
+  padding-left: 0.5em;\r
+}\r
+</style>\r
+<title>git-gc(1)</title>\r
+</head>\r
+<body>\r
+<div id="header">\r
+<h1>\r
+git-gc(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>git-gc -\r
+   Cleanup unnecessary files and optimize the local repository\r
+</p>\r
+</div>\r
+</div>\r
+<h2>SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<p><em>git-gc</em></p>\r
+</div>\r
+<h2>DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<p>Runs a number of housekeeping tasks within the current repository,\r
+such as compressing file revisions (to reduce disk space and increase\r
+performance) and removing unreachable objects which may have been\r
+created from prior invocations of <a href="git-add.html">git-add(1)</a>.</p>\r
+<p>Users are encouraged to run this task on a regular basis within\r
+each repository to maintain good disk space utilization and good\r
+operating performance.</p>\r
+</div>\r
+<h2>Configuration</h2>\r
+<div class="sectionbody">\r
+<p>The optional configuration variable <em>gc.reflogExpire</em> can be\r
+set to indicate how long historical entries within each branch's\r
+reflog should remain available in this repository.  The setting is\r
+expressed as a length of time, for example <em>90 days</em> or <em>3 months</em>.\r
+It defaults to <em>90 days</em>.</p>\r
+<p>The optional configuration variable <em>gc.reflogExpireUnreachable</em>\r
+can be set to indicate how long historical reflog entries which\r
+are not part of the current branch should remain available in\r
+this repository.  These types of entries are generally created as\r
+a result of using <tt>git commit --amend</tt> or <tt>git rebase</tt> and are the\r
+commits prior to the amend or rebase occuring.  Since these changes\r
+are not part of the current project most users will want to expire\r
+them sooner.  This option defaults to <em>30 days</em>.</p>\r
+<p>The optional configuration variable <em>gc.rerereresolved</em> indicates\r
+how long records of conflicted merge you resolved earlier are\r
+kept.  This defaults to 60 days.</p>\r
+<p>The optional configuration variable <em>gc.rerereunresolved</em> indicates\r
+how long records of conflicted merge you have not resolved are\r
+kept.  This defaults to 15 days.</p>\r
+</div>\r
+<h2>See Also</h2>\r
+<div class="sectionbody">\r
+<p><a href="git-prune.html">git-prune(1)</a>\r
+<a href="git-reflog.html">git-reflog(1)</a>\r
+<a href="git-repack.html">git-repack(1)</a>\r
+<a href="git-rerere.html">git-rerere(1)</a></p>\r
+</div>\r
+<h2>Author</h2>\r
+<div class="sectionbody">\r
+<p>Written by Shawn O. Pearce &lt;spearce@spearce.org&gt;</p>\r
+</div>\r
+<h2>GIT</h2>\r
+<div class="sectionbody">\r
+<p>Part of the <a href="git.html">git(7)</a> suite</p>\r
+</div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated 28-Dec-2006 00:59:28 UTC\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
diff --git a/git-gc.txt b/git-gc.txt
new file mode 100644 (file)
index 0000000..73d78c1
--- /dev/null
@@ -0,0 +1,64 @@
+git-gc(1)
+=========
+
+NAME
+----
+git-gc - Cleanup unnecessary files and optimize the local repository
+
+
+SYNOPSIS
+--------
+'git-gc'
+
+DESCRIPTION
+-----------
+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 gitlink:git-add[1].
+
+Users are encouraged to run this task on a regular basis within
+each repository to maintain good disk space utilization and good
+operating performance.
+
+Configuration
+-------------
+
+The optional configuration variable 'gc.reflogExpire' can be
+set to indicate how long historical entries within each branch's
+reflog should remain available in this repository.  The setting is
+expressed as a length of time, for example '90 days' or '3 months'.
+It defaults to '90 days'.
+
+The optional configuration variable 'gc.reflogExpireUnreachable'
+can be set to indicate how long historical reflog entries which
+are not part of the current branch should remain available in
+this repository.  These types of entries are generally created as
+a result of using `git commit \--amend` or `git rebase` and are the
+commits prior to the amend or rebase occuring.  Since these changes
+are not part of the current project most users will want to expire
+them sooner.  This option defaults to '30 days'.
+
+The optional configuration variable 'gc.rerereresolved' indicates
+how long records of conflicted merge you resolved earlier are
+kept.  This defaults to 60 days.
+
+The optional configuration variable 'gc.rerereunresolved' indicates
+how long records of conflicted merge you have not resolved are
+kept.  This defaults to 15 days.
+
+
+See Also
+--------
+gitlink:git-prune[1]
+gitlink:git-reflog[1]
+gitlink:git-repack[1]
+gitlink:git-rerere[1]
+
+Author
+------
+Written by Shawn O. Pearce <spearce@spearce.org>
+
+GIT
+---
+Part of the gitlink:git[7] suite
index 55fa6503ccdfd581a3b8be69e0a1ce5fb22f1c58..ecdbbca6729ebe25283cd5c56737d9b9121127a6 100644 (file)
--- a/git.html
+++ b/git.html
@@ -710,6 +710,14 @@ ancillary user utilities.</p>
 </p>\r
 </dd>\r
 <dt>\r
+<a href="git-gc.html">git-gc(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Cleanup unnecessary files and optimize the local repository.\r
+</p>\r
+</dd>\r
+<dt>\r
 <a href="git-lost-found.html">git-lost-found(1)</a>\r
 </dt>\r
 <dd>\r
@@ -2277,7 +2285,7 @@ contributors on the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 27-Dec-2006 10:59:44 UTC\r
+Last updated 28-Dec-2006 00:59:29 UTC\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/git.txt b/git.txt
index 4ed3eed13d383cac4f1fa171b3ab6fb62f63c06a..36b2126d847bf86f9efe5bdb1ce88acef9046633 100644 (file)
--- a/git.txt
+++ b/git.txt
@@ -212,6 +212,9 @@ gitlink:git-cvsexportcommit[1]::
 gitlink:git-cvsserver[1]::
        A CVS server emulator for git.
 
+gitlink:git-gc[1]::
+       Cleanup unnecessary files and optimize the local repository.
+
 gitlink:git-lost-found[1]::
        Recover lost refs that luckily have not yet been pruned.