projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| 215a7ad1 JH |
1 | git-commit(1) |
| 2 | ============= | |
| 62033318 JH |
3 | |
| 4 | NAME | |
| 5 | ---- | |
| 215a7ad1 | 6 | git-commit - Record your changes |
| 62033318 JH |
7 | |
| 8 | SYNOPSIS | |
| 9 | -------- | |
| cc1621e2 | 10 | 'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] <file>... |
| 62033318 JH |
11 | |
| 12 | DESCRIPTION | |
| 13 | ----------- | |
| 14 | Updates the index file for given paths, or all modified files if | |
| 15 | '-a' is specified, and makes a commit object. The command | |
| 16 | VISUAL and EDITOR environment variables to edit the commit log | |
| 17 | message. | |
| 18 | ||
| 6d35cc76 JH |
19 | This command can run `commit-msg`, `pre-commit`, and |
| 20 | `post-commit` hooks. See link:hooks.html[hooks] for more | |
| 21 | information. | |
| 22 | ||
| 62033318 JH |
23 | OPTIONS |
| 24 | ------- | |
| 25 | -a:: | |
| 26 | Update all paths in the index file. | |
| 27 | ||
| 28 | -c or -C <commit>:: | |
| 29 | Take existing commit object, and reuse the log message | |
| 30 | and the authorship information (including the timestamp) | |
| 31 | when creating the commit. With '-C', the editor is not | |
| 32 | invoked; with '-c' the user can further edit the commit | |
| 33 | message. | |
| 34 | ||
| 35 | -F <file>:: | |
| 36 | Take the commit message from the given file. Use '-' to | |
| 37 | read the message from the standard input. | |
| 38 | ||
| 39 | -m <msg>:: | |
| 40 | Use the given <msg> as the commit message. | |
| 41 | ||
| 3f971fc4 JH |
42 | -s:: |
| 43 | Add Signed-off-by line at the end of the commit message. | |
| 44 | ||
| 45 | -v:: | |
| 46 | Look for suspicious lines the commit introduces, and | |
| 47 | abort committing if there is one. The definition of | |
| 48 | 'suspicious lines' is currently the lines that has | |
| 49 | trailing whitespaces, and the lines whose indentation | |
| 50 | has a SP character immediately followed by a TAB | |
| 51 | character. | |
| 52 | ||
| 6d35cc76 JH |
53 | -e:: |
| 54 | The message taken from file with `-F`, command line with | |
| 55 | `-m`, and from file with `-C` are usually used as the | |
| 56 | commit log message unmodified. This option lets you | |
| 57 | further edit the message taken from these sources. | |
| 58 | ||
| 62033318 | 59 | <file>...:: |
| 6d35cc76 | 60 | Update specified paths in the index file before committing. |
| 62033318 JH |
61 | |
| 62 | ||
| 63 | Author | |
| 64 | ------ | |
| 3f971fc4 JH |
65 | Written by Linus Torvalds <torvalds@osdl.org> and |
| 66 | Junio C Hamano <junkio@cox.net> | |
| 67 | ||
| 62033318 JH |
68 | |
| 69 | GIT | |
| 70 | --- | |
| a7154e91 | 71 | Part of the gitlink:git[7] suite |