mirror of
https://github.com/git/git
synced 2024-11-05 18:59:29 +00:00
8278ac2f4a
Minor copyediting of recent additions to git-commit and git-reset documentation. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
85 lines
2.2 KiB
Text
85 lines
2.2 KiB
Text
git-commit(1)
|
|
=============
|
|
|
|
NAME
|
|
----
|
|
git-commit - Record your changes
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>]
|
|
[-e] [--] <file>...
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
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.
|
|
|
|
This command can run `commit-msg`, `pre-commit`, and
|
|
`post-commit` hooks. See link:hooks.html[hooks] for more
|
|
information.
|
|
|
|
OPTIONS
|
|
-------
|
|
-a|--all::
|
|
Update all paths in the index file. This flag notices
|
|
files that have been modified and deleted, but new files
|
|
you have not told git about are not affected.
|
|
|
|
-c or -C <commit>::
|
|
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.
|
|
|
|
-F <file>::
|
|
Take the commit message from the given file. Use '-' to
|
|
read the message from the standard input.
|
|
|
|
-m <msg>::
|
|
Use the given <msg> as the commit message.
|
|
|
|
-s|--signoff::
|
|
Add Signed-off-by line at the end of the commit message.
|
|
|
|
-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. This is the default.
|
|
|
|
-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.
|
|
|
|
<file>...::
|
|
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 <torvalds@osdl.org> and
|
|
Junio C Hamano <junkio@cox.net>
|
|
|
|
|
|
GIT
|
|
---
|
|
Part of the gitlink:git[7] suite
|