aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2007-01-18 22:32:38 -0800
committerJunio C Hamano <junkio@cox.net>2007-01-19 17:53:39 -0800
commit89bf207758530fd151895680f7236ce626feea9c (patch)
treeabae46c6658f66e7e3532d66469acb3af02f2de4 /Documentation/git.txt
parentbe93fc088f3c6f78c3dd1b10544287129d066512 (diff)
downloadgit-89bf207758530fd151895680f7236ce626feea9c.tar.gz
git-89bf207758530fd151895680f7236ce626feea9c.tar.xz
Documentation/git.txt: command re-classification
This adds two new classes (pure-helpers and "Interacting with Others") to the command list in the main manual page. The latter class is primarily about foreign SCM interface and is placed before low-level (plumbing) commands. Also it promotes a handful commands to mainporcelain category while demoting some others. Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git.txt')
-rw-r--r--Documentation/git.txt35
1 files changed, 34 insertions, 1 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt
index ac222060e..9761de36b 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -93,6 +93,16 @@ Interrogators:
include::cmds-ancillaryinterrogators.txt[]
+
+Interacting with Others
+~~~~~~~~~~~~~~~~~~~~~~~
+
+These commands are to interact with foreign SCM and with other
+people via patch over e-mail.
+
+include::cmds-foreignscminterface.txt[]
+
+
Low-level commands (plumbing)
-----------------------------
@@ -102,11 +112,20 @@ development of alternative porcelains. Developers of such porcelains
might start by reading about gitlink:git-update-index[1] and
gitlink:git-read-tree[1].
-We divide the low-level commands into commands that manipulate objects (in
+The interface (input, output, set of options and the semantics)
+to these low-level commands are meant to be a lot more stable
+than Porcelain level commands, because these commands are
+primarily for scripted use. The interface to Porcelain commands
+on the other hand are subject to change in order to improve the
+end user experience.
+
+The following description divides
+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
~~~~~~~~~~~~~~~~~~~~~
@@ -127,6 +146,20 @@ Synching repositories
include::cmds-synchingrepositories.txt[]
+The following are helper programs used by the above; end users
+typically do not use them directly.
+
+include::cmds-synchelpers.txt[]
+
+
+Internal helper commands
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+These are internal helper commands used by other commands; end
+users typically do not use them directly.
+
+include::cmds-purehelpers.txt[]
+
Configuration Mechanism
-----------------------