X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=Documentation%2Fgit-commit-script.txt;h=faa1870e34dc836683c45644b9470ecdf10c7f8c;hb=78938b0d8a95b09d94af214fdb6b5f053a5edb98;hp=bb559d70a51d92294dad2f2e3a8de9eeb2fabfe0;hpb=62033318abbe648e8be49121b0a3570c07d38a9d;p=git.git diff --git a/Documentation/git-commit-script.txt b/Documentation/git-commit-script.txt index bb559d70..faa1870e 100644 --- a/Documentation/git-commit-script.txt +++ b/Documentation/git-commit-script.txt @@ -8,7 +8,7 @@ git-commit-script - Record your changes SYNOPSIS -------- -'git commit' [-a] [(-c | -C) | -F | -m ] ... +'git commit' [-a] [-s] [-v] [(-c | -C) | -F | -m ] [-e] ... DESCRIPTION ----------- @@ -17,6 +17,10 @@ Updates the index file for given paths, or all modified files if VISUAL and EDITOR environment variables to edit the commit log message. +This command can run `commit-msg`, `pre-commit`, and +`post-commit` hooks. See link:hooks.html[hooks] for more +information. + OPTIONS ------- -a:: @@ -36,13 +40,32 @@ OPTIONS -m :: Use the given as the commit message. +-s:: + Add Signed-off-by line at the end of the commit message. + +-v:: + 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. + +-e:: + 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. + ...:: - Update specified paths in the index file. + Update specified paths in the index file before committing. Author ------ -Written by Linus Torvalds +Written by Linus Torvalds and +Junio C Hamano + GIT ---