Document "git commit"
authorJunio C Hamano <junkio@cox.net>
Tue, 9 Aug 2005 00:39:18 +0000 (17:39 -0700)
committerJunio C Hamano <junkio@cox.net>
Wed, 10 Aug 2005 05:28:23 +0000 (22:28 -0700)
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-commit-script.txt [new file with mode: 0644]
Documentation/git.txt

diff --git a/Documentation/git-commit-script.txt b/Documentation/git-commit-script.txt
new file mode 100644 (file)
index 0000000..bb559d7
--- /dev/null
@@ -0,0 +1,49 @@
+git-commit-script(1)
+====================
+v0.99.4, Aug 2005
+
+NAME
+----
+git-commit-script - Record your changes
+
+SYNOPSIS
+--------
+'git commit' [-a] [(-c | -C) <commit> | -F <file> | -m <msg>] <file>...
+
+DESCRIPTION
+-----------
+Updates the index file for given paths, or all modified files if
+'-a' is specified, and makes a commit object.  The command
+VISUAL and EDITOR environment variables to edit the commit log
+message.
+
+OPTIONS
+-------
+-a::
+       Update all paths in the index file.
+
+-c or -C <commit>::
+       Take existing commit object, and reuse the log message
+       and the authorship information (including the timestamp)
+       when creating the commit.  With '-C', the editor is not
+       invoked; with '-c' the user can further edit the commit
+       message.
+
+-F <file>::
+       Take the commit message from the given file.  Use '-' to
+       read the message from the standard input.
+
+-m <msg>::
+       Use the given <msg> as the commit message.
+
+<file>...::
+       Update specified paths in the index file.
+
+
+Author
+------
+Written by Linus Torvalds <torvalds@osdl.org>
+
+GIT
+---
+Part of the link:git.html[git] suite
index d18cf5e..1308eb6 100644 (file)
@@ -34,6 +34,10 @@ the repository, the cache and the working fileset, those that
 interrogate and compare them, and those that moves objects and
 references between repositories.
 
+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 ancilliary 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.
@@ -128,14 +132,6 @@ link:git-clone-pack.html[git-clone-pack]::
        Clones a repository into the current repository (engine
        for ssh and local transport)
 
-link:git-fetch-script.html[git-fetch-script]::
-       Download from a remote repository via various protocols
-       (user interface).
-
-link:git-pull-script.html[git-pull-script]::
-       Fetch from and merge with a remote repository via
-       various protocols (user interface).
-
 link:git-http-pull.html[git-http-pull]::
        Downloads a remote GIT repository via HTTP
 
@@ -169,6 +165,18 @@ link:git-update-server-info.html[git-update-server-info]::
        clients discover references and packs on it.
 
 
+Porcelainish Commands
+---------------------
+link:git-fetch-script.html[git-fetch-script]::
+       Download from a remote repository via various protocols.
+
+link:git-pull-script.html[git-pull-script]::
+       Fetch from and merge with a remote repository.
+
+link:git-commit-script.html[git-commit-script]::
+       Record changes to the repository.
+
+
 Ancilliary Commands
 -------------------
 Manipulators: