From: Junio C Hamano Date: Mon, 3 Apr 2006 05:34:17 +0000 (+0000) Subject: Autogenerated man pages for v1.3.0-rc1-g40e9 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=b2db662fa6ea8fbd048f1b071b3dbb90d7a71d3f;p=git.git Autogenerated man pages for v1.3.0-rc1-g40e9 --- diff --git a/man7/git.7 b/man7/git.7 index 9976802ca..4db9e3992 100755 --- a/man7/git.7 +++ b/man7/git.7 @@ -28,7 +28,10 @@ git \- the stupid content tracker .SH "DESCRIPTION" -\fIgit\fR is both a program and a directory content tracker system\&. The program \fIgit\fR 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 tutorial: \fItutorial.html\fR to get started, then see Everyday Git: \fIeveryday.html\fR for a useful minimum set of commands, and "man git\-commandname" for documentation of each command\&. CVS users may also want to read CVS migration: \fIcvs-migration.html\fR\&. .SH "OPTIONS" @@ -44,38 +47,29 @@ Prints the synopsis and a list of the most commonly used commands\&. If a git co \-\-exec\-path Path to wherever your core git programs are installed\&. This can also be controlled by setting the GIT_EXEC_PATH environment variable\&. If no path is given \fIgit\fR will print the current setting and then exit\&. -.SH "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 [xref to anchor] section below contains much useful definition and clarification \- read that first\&. - - -If you are interested in using git to manage (version control) projects, use The Tutorial: \fItutorial.html\fR to get you started, and then Everyday GIT: \fIeveryday.html\fR 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\&. +.SH "FURTHER DOCUMENTATION" -The Core tutorial: \fIcore-tutorial.html\fR document covers how things internally work\&. +See the references above to get started using git\&. The following is probably more detail than necessary for a first\-time user\&. -If you are migrating from CVS, cvs migration: \fIcvs-migration.html\fR document may be helpful after you finish the tutorial\&. +The Discussion section below and the Core tutorial: \fIcore-tutorial.html\fR both provide introductions to the underlying git architecture\&. -After you get the general feel from the tutorial and this overview page, you may want to take a look at the howto: \fIhowto-index.html\fR documents\&. +See also the howto: \fIhowto-index.html\fR documents for some useful examples\&. -.SH "CORE GIT COMMANDS" +.SH "GIT COMMANDS" -If you are writing your own Porcelain, you need to be familiar with most of the low level commands \-\-\- I suggest starting from \fBgit\-update\-index\fR(1) and \fBgit\-read\-tree\fR(1)\&. +We divide git into high level ("porcelain") commands and low level ("plumbing") commands\&. -.SH "COMMANDS OVERVIEW" +.SH "LOW-LEVEL COMMANDS (PLUMBING)" -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\&. +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 \fBgit\-update\-index\fR(1) and \fBgit\-read\-tree\fR(1)\&. -In addition, git itself comes with a spartan set of porcelain commands\&. They are usable but are not meant to compete with real Porcelains\&. - - -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\&. .SS "Manipulation commands" @@ -270,7 +264,12 @@ Updates auxiliary information on a dumb server to help clients discover referenc \fBgit\-upload\-pack\fR(1) Invoked by \fIgit\-clone\-pack\fR and \fIgit\-fetch\-pack\fR to push what are asked for\&. -.SH "PORCELAIN-ISH COMMANDS" +.SH "HIGH-LEVEL COMMANDS (PORCELAIN)" + + +We separate the porcelain commands into the main commands and some ancillary user utilities\&. + +.SS "Main porcelain commands" .TP \fBgit\-add\fR(1) @@ -396,7 +395,7 @@ Check the GPG signature of tag\&. \fBgit\-whatchanged\fR(1) Shows commit logs and differences they introduce\&. -.SH "ANCILLARY COMMANDS" +.SS "Ancillary Commands" Manipulators: