diff options
| author | Junio C Hamano <gitster@pobox.com> | 2019-02-06 22:05:28 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-02-06 22:05:28 -0800 |
| commit | 7a15479286f4384df24dd34c38606a3d0625bff8 (patch) | |
| tree | fbf996853b9d123923292155920acb0eb60cb3b8 | |
| parent | 3a14fdec88125c4fd093f938cf406231b932e3a2 (diff) | |
| parent | 5cfd4a9d108fa739c96beaa2dbcee3d7911db2a9 (diff) | |
| download | git-7a15479286f4384df24dd34c38606a3d0625bff8.tar.gz | |
Merge branch 'nd/commit-doc'
Doc update.
* nd/commit-doc:
git-commit.txt: better description what it does
| -rw-r--r-- | Documentation/git-commit.txt | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index f970a43422..a85c2c2a4c 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -17,16 +17,20 @@ SYNOPSIS DESCRIPTION ----------- -Stores the current contents of the index in a new commit along -with a log message from the user describing the changes. +Create a new commit containing the current contents of the index and +the given log message describing the changes. The new commit is a +direct child of HEAD, usually the tip of the current branch, and the +branch is updated to point to it (unless no branch is associated with +the working tree, in which case HEAD is "detached" as described in +linkgit:git-checkout[1]). -The content to be added can be specified in several ways: +The content to be committed can be specified in several ways: -1. by using 'git add' to incrementally "add" changes to the - index before using the 'commit' command (Note: even modified - files must be "added"); +1. by using linkgit:git-add[1] to incrementally "add" changes to the + index before using the 'commit' command (Note: even modified files + must be "added"); -2. by using 'git rm' to remove files from the working tree +2. by using linkgit:git-rm[1] to remove files from the working tree and the index, again before using the 'commit' command; 3. by listing files as arguments to the 'commit' command |