man1/git-commit.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-COMMIT" 1 "" "" ""
  21 .SH NAME
  22 git-commit \- Record your changes
  23 .SH "SYNOPSIS"
  24
  25
  26 git\-commit [\-a] [\-s] [\-v] [(\-c | \-C) <commit> | \-F <file> | \-m <msg>] [\-e] [\-\-] <file>...
  27
  28 .SH "DESCRIPTION"
  29
  30
  31 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\&.
  32
  33
  34 This command can run commit\-msg, pre\-commit, and post\-commit hooks\&. See hooks: \fIhooks.html\fR for more information\&.
  35
  36 .SH "OPTIONS"
  37
  38 .TP
  39 \-a|\-\-all
  40 Update all paths in the index file\&.
  41
  42 .TP
  43 \-c or \-C <commit>
  44 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\&.
  45
  46 .TP
  47 \-F <file>
  48 Take the commit message from the given file\&. Use \- to read the message from the standard input\&.
  49
  50 .TP
  51 \-m <msg>
  52 Use the given <msg> as the commit message\&.
  53
  54 .TP
  55 \-s|\-\-signoff
  56 Add Signed\-off\-by line at the end of the commit message\&.
  57
  58 .TP
  59 \-v|\-\-verify
  60 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\&. This is the default\&.
  61
  62 .TP
  63 \-n|\-\-no\-verify
  64 The opposite of \-\-verify\&.
  65
  66 .TP
  67 \-e|\-\-edit
  68 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\&.
  69
  70 .TP
  71 --
  72 Do not interpret any more arguments as options\&.
  73
  74 .TP
  75 <file>...
  76 Update specified paths in the index file before committing\&.
  77
  78
  79 If you make a commit and then found a mistake immediately after that, you can recover from it with \fBgit\-reset\fR(1)\&.
  80
  81 .SH "AUTHOR"
  82
  83
  84 Written by Linus Torvalds <torvalds@osdl\&.org> and Junio C Hamano <junkio@cox\&.net>
  85
  86 .SH "GIT"
  87
  88
  89 Part of the \fBgit\fR(7) suite
  90