Add repository-layout document.
[git] / Documentation / git-commit-script.txt
1 git-commit-script(1)
2 ====================
3 v0.99.4, Aug 2005
4
5 NAME
6 ----
7 git-commit-script - Record your changes
8
9 SYNOPSIS
10 --------
11 'git commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] <file>...
12
13 DESCRIPTION
14 -----------
15 Updates the index file for given paths, or all modified files if
16 '-a' is specified, and makes a commit object.  The command
17 VISUAL and EDITOR environment variables to edit the commit log
18 message.
19
20 OPTIONS
21 -------
22 -a::
23         Update all paths in the index file.
24
25 -c or -C <commit>::
26         Take existing commit object, and reuse the log message
27         and the authorship information (including the timestamp)
28         when creating the commit.  With '-C', the editor is not
29         invoked; with '-c' the user can further edit the commit
30         message.
31
32 -F <file>::
33         Take the commit message from the given file.  Use '-' to
34         read the message from the standard input.
35
36 -m <msg>::
37         Use the given <msg> as the commit message.
38
39 -s::
40         Add Signed-off-by line at the end of the commit message.
41
42 -v::
43         Look for suspicious lines the commit introduces, and
44         abort committing if there is one.  The definition of
45         'suspicious lines' is currently the lines that has
46         trailing whitespaces, and the lines whose indentation
47         has a SP character immediately followed by a TAB
48         character.
49
50 <file>...::
51         Update specified paths in the index file.
52
53
54 Author
55 ------
56 Written by Linus Torvalds <torvalds@osdl.org> and
57 Junio C Hamano <junkio@cox.net>
58
59
60 GIT
61 ---
62 Part of the link:git.html[git] suite