X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-commit.txt;h=e0ff74f648fa57bc1a6d100f886fca424051ce8a;hb=353ce81597e831969ac37d6991346f8c39c1488e;hp=1edc278c64827b47d8b672106433417510342392;hpb=8ac3a61f59173d4a9a328518be83a25df610a5ef;p=git.git diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 1edc278c..e0ff74f6 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -7,7 +7,9 @@ git-commit - Record your changes SYNOPSIS -------- -'git-commit' [-a] [-s] [-v] [(-c | -C) | -F | -m ] [-e] ... +[verse] +'git-commit' [-a] [-s] [-v] [(-c | -C) | -F | -m ] + [-e] [--] ... DESCRIPTION ----------- @@ -22,7 +24,7 @@ information. OPTIONS ------- --a:: +-a|--all:: Update all paths in the index file. -c or -C :: @@ -39,27 +41,37 @@ OPTIONS -m :: Use the given as the commit message. --s:: +-s|--signoff:: Add Signed-off-by line at the end of the commit message. --v:: +-v|--verify:: Look for suspicious lines the commit introduces, and abort committing if there is one. The definition of 'suspicious lines' is currently the lines that has trailing whitespaces, and the lines whose indentation has a SP character immediately followed by a TAB - character. + character. This is the default. --e:: +-n|--no-verify:: + The opposite of `--verify`. + +-e|--edit:: The message taken from file with `-F`, command line with `-m`, and from file with `-C` are usually used as the commit log message unmodified. This option lets you further edit the message taken from these sources. +--:: + Do not interpret any more arguments as options. + ...:: Update specified paths in the index file before committing. +If you make a commit and then found a mistake immediately after +that, you can recover from it with gitlink:git-reset[1]. + + Author ------ Written by Linus Torvalds and