Autogenerated HTML docs for v1.3.0-rc1-g40e9
authorJunio C Hamano <junio@hera.kernel.org>
Mon, 3 Apr 2006 05:34:10 +0000 (05:34 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Mon, 3 Apr 2006 05:34:10 +0000 (05:34 +0000)
git.html
git.txt

index 0570947..b85f51a 100644 (file)
--- a/git.html
+++ b/git.html
@@ -276,10 +276,13 @@ git(7) Manual Page
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p><em>git</em> is both a program and a directory content tracker system.\r
-The program <em>git</em> is just a wrapper to reach the core git programs\r
-(or a potty if you like, as it's not exactly porcelain but still\r
-brings your stuff to the plumbing).</p>\r
+<p>Git is a fast, scalable, distributed revision control system with an\r
+unusually rich command set that provides both high-level operations\r
+and full access to internals.</p>\r
+<p>See this <a href="tutorial.html">tutorial</a> to get started, then see\r
+<a href="everyday.html">Everyday Git</a> for a useful minimum set of commands, and\r
+"man git-commandname" for documentation of each command.  CVS users may\r
+also want to read <a href="cvs-migration.html">CVS migration</a>.</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -316,45 +319,32 @@ brings your stuff to the plumbing).</p>
 </dd>\r
 </dl>\r
 </div>\r
-<h2>NOT LEARNING CORE GIT COMMANDS</h2>\r
+<h2>FURTHER DOCUMENTATION</h2>\r
 <div class="sectionbody">\r
-<p>This manual is intended to give complete background information\r
-and internal workings of git, which may be too much for most\r
-people.  The <a href="#Discussion">[Discussion]</a> section below contains much useful\r
-definition and clarification - read that first.</p>\r
-<p>If you are interested in using git to manage (version control)\r
-projects, use <a href="tutorial.html">The Tutorial</a> to get you started,\r
-and then <a href="everyday.html">Everyday GIT</a> as a guide to the\r
-minimum set of commands you need to know for day-to-day work.\r
-Most likely, that will get you started, and you can go a long\r
-way without knowing the low level details too much.</p>\r
-<p>The <a href="core-tutorial.html">Core tutorial</a> document covers how things\r
-internally work.</p>\r
-<p>If you are migrating from CVS, <a href="cvs-migration.html">cvs\r
-migration</a> document may be helpful after you finish the\r
-tutorial.</p>\r
-<p>After you get the general feel from the tutorial and this\r
-overview page, you may want to take a look at the\r
-<a href="howto-index.html">howto</a> documents.</p>\r
+<p>See the references above to get started using git.  The following is\r
+probably more detail than necessary for a first-time user.</p>\r
+<p>The <a href="#Discussion">Discussion</a> section below and the\r
+<a href="core-tutorial.html">Core tutorial</a> both provide introductions to the\r
+underlying git architecture.</p>\r
+<p>See also the <a href="howto-index.html">howto</a> documents for some useful\r
+examples.</p>\r
 </div>\r
-<h2>CORE GIT COMMANDS</h2>\r
+<h2>GIT COMMANDS</h2>\r
 <div class="sectionbody">\r
-<p>If you are writing your own Porcelain, you need to be familiar\r
-with most of the low level commands --- I suggest starting from\r
-<a href="git-update-index.html">git-update-index(1)</a> and <a href="git-read-tree.html">git-read-tree(1)</a>.</p>\r
+<p>We divide git into high level ("porcelain") commands and low level\r
+("plumbing") commands.</p>\r
 </div>\r
-<h2>Commands Overview</h2>\r
+<h2>Low-level commands (plumbing)</h2>\r
 <div class="sectionbody">\r
-<p>The git commands can helpfully be split into those that manipulate\r
-the repository, the index and the files in the working tree, those that\r
-interrogate and compare them, and those that moves objects and\r
-references between repositories.</p>\r
-<p>In addition, git itself comes with a spartan set of porcelain\r
-commands.  They are usable but are not meant to compete with real\r
-Porcelains.</p>\r
-<p>There are also some ancillary programs that can be viewed as useful\r
-aids for using the core commands but which are unlikely to be used by\r
-SCMs layered over git.</p>\r
+<p>Although git includes its\r
+own porcelain layer, its low-level commands are sufficient to support\r
+development of alternative porcelains.  Developers of such porcelains\r
+might start by reading about <a href="git-update-index.html">git-update-index(1)</a> and\r
+<a href="git-read-tree.html">git-read-tree(1)</a>.</p>\r
+<p>We divide the low-level commands into commands that manipulate objects (in\r
+the repository, index, and working tree), commands that interrogate and\r
+compare objects, and commands that move objects and references between\r
+repositories.</p>\r
 <h3>Manipulation commands</h3>\r
 <dl>\r
 <dt>\r
@@ -746,8 +736,11 @@ the working tree.</p>
 </dd>\r
 </dl>\r
 </div>\r
-<h2>Porcelain-ish Commands</h2>\r
+<h2>High-level commands (porcelain)</h2>\r
 <div class="sectionbody">\r
+<p>We separate the porcelain commands into the main commands and some\r
+ancillary user utilities.</p>\r
+<h3>Main porcelain commands</h3>\r
 <dl>\r
 <dt>\r
 <a href="git-add.html">git-add(1)</a>\r
@@ -998,9 +991,7 @@ the working tree.</p>
 </p>\r
 </dd>\r
 </dl>\r
-</div>\r
-<h2>Ancillary Commands</h2>\r
-<div class="sectionbody">\r
+<h3>Ancillary Commands</h3>\r
 <p>Manipulators:</p>\r
 <dl>\r
 <dt>\r
@@ -2032,7 +2023,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 26-Mar-2006 01:49:00 UTC\r
+Last updated 03-Apr-2006 05:33:34 UTC\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/git.txt b/git.txt
index fe34f50..06b2e53 100644 (file)
--- a/git.txt
+++ b/git.txt
@@ -12,10 +12,14 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-'git' is both a program and a directory content tracker system.
-The program 'git' is just a wrapper to reach the core git programs
-(or a potty if you like, as it's not exactly porcelain but still
-brings your stuff to the plumbing).
+Git is a fast, scalable, distributed revision control system with an
+unusually rich command set that provides both high-level operations
+and full access to internals.
+
+See this link:tutorial.html[tutorial] to get started, then see
+link:everyday.html[Everyday Git] for a useful minimum set of commands, and
+"man git-commandname" for documentation of each command.  CVS users may
+also want to read link:cvs-migration.html[CVS migration].
 
 OPTIONS
 -------
@@ -35,55 +39,38 @@ OPTIONS
        the current setting and then exit.
 
 
-NOT LEARNING CORE GIT COMMANDS
-------------------------------
-
-This manual is intended to give complete background information
-and internal workings of git, which may be too much for most
-people.  The <<Discussion>> section below contains much useful
-definition and clarification - read that first.
-
-If you are interested in using git to manage (version control)
-projects, use link:tutorial.html[The Tutorial] to get you started,
-and then link:everyday.html[Everyday GIT] as a guide to the
-minimum set of commands you need to know for day-to-day work.
-Most likely, that will get you started, and you can go a long
-way without knowing the low level details too much.
-
-The link:core-tutorial.html[Core tutorial] document covers how things
-internally work.
-
-If you are migrating from CVS, link:cvs-migration.html[cvs
-migration] document may be helpful after you finish the
-tutorial.
+FURTHER DOCUMENTATION
+---------------------
 
-After you get the general feel from the tutorial and this
-overview page, you may want to take a look at the
-link:howto-index.html[howto] documents.
+See the references above to get started using git.  The following is
+probably more detail than necessary for a first-time user.
 
+The <<Discussion,Discussion>> section below and the
+link:core-tutorial.html[Core tutorial] both provide introductions to the
+underlying git architecture.
 
-CORE GIT COMMANDS
------------------
+See also the link:howto-index.html[howto] documents for some useful
+examples.
 
-If you are writing your own Porcelain, you need to be familiar
-with most of the low level commands --- I suggest starting from
-gitlink:git-update-index[1] and gitlink:git-read-tree[1].
+GIT COMMANDS
+------------
 
+We divide git into high level ("porcelain") commands and low level
+("plumbing") commands.
 
-Commands Overview
------------------
-The git commands can helpfully be split into those that manipulate
-the repository, the index and the files in the working tree, those that
-interrogate and compare them, and those that moves objects and
-references between repositories.
+Low-level commands (plumbing)
+-----------------------------
 
-In addition, git itself comes with a spartan set of porcelain
-commands.  They are usable but are not meant to compete with real
-Porcelains.
+Although git includes its
+own porcelain layer, its low-level commands are sufficient to support
+development of alternative porcelains.  Developers of such porcelains
+might start by reading about gitlink:git-update-index[1] and
+gitlink:git-read-tree[1].
 
-There are also some ancillary programs that can be viewed as useful
-aids for using the core commands but which are unlikely to be used by
-SCMs layered over git.
+We divide the low-level commands into commands that manipulate objects (in
+the repository, index, and working tree), commands that interrogate and
+compare objects, and commands that move objects and references between
+repositories.
 
 Manipulation commands
 ~~~~~~~~~~~~~~~~~~~~~
@@ -248,8 +235,14 @@ gitlink:git-upload-pack[1]::
        what are asked for.
 
 
-Porcelain-ish Commands
-----------------------
+High-level commands (porcelain)
+-------------------------------
+
+We separate the porcelain commands into the main commands and some
+ancillary user utilities.
+
+Main porcelain commands
+~~~~~~~~~~~~~~~~~~~~~~~
 
 gitlink:git-add[1]::
        Add paths to the index.
@@ -346,7 +339,7 @@ gitlink:git-whatchanged[1]::
 
 
 Ancillary Commands
-------------------
+~~~~~~~~~~~~~~~~~~
 Manipulators:
 
 gitlink:git-applypatch[1]::