aboutsummaryrefslogtreecommitdiff
path: root/Documentation/core-tutorial.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2006-02-05 00:07:44 -0800
committerJunio C Hamano <junkio@cox.net>2006-02-06 23:20:32 -0800
commit130fcca63fe8e7e087e7419907e018cbbaf434a3 (patch)
treeff880b26e448c0f13cfe16af6f47092ce5d957dd /Documentation/core-tutorial.txt
parent8389b52b2a51d5b110b508cc67f0f41f99c30d3f (diff)
downloadgit-130fcca63fe8e7e087e7419907e018cbbaf434a3.tar.gz
git-130fcca63fe8e7e087e7419907e018cbbaf434a3.tar.xz
git-commit: revamp the git-commit semantics.
- "git commit" without _any_ parameter keeps the traditional behaviour. It commits the current index. We commit the whole index even when this form is run from a subdirectory. - "git commit --include paths..." (or "git commit -i paths...") is equivalent to: git update-index --remove paths... git commit - "git commit paths..." acquires a new semantics. This is an incompatible change that needs user training, which I am still a bit reluctant to swallow, but enough people seem to have complained that it is confusing to them. It 1. refuses to run if $GIT_DIR/MERGE_HEAD exists, and reminds trained git users that the traditional semantics now needs -i flag. 2. refuses to run if named paths... are different in HEAD and the index (ditto about reminding). Added paths are OK. 3. reads HEAD commit into a temporary index file. 4. updates named paths... from the working tree in this temporary index. 5. does the same updates of the paths... from the working tree to the real index. 6. makes a commit using the temporary index that has the current HEAD as the parent, and updates the HEAD with this new commit. - "git commit --all" can run from a subdirectory, but it updates the index with all the modified files and does a whole tree commit. - In all cases, when the command decides not to create a new commit, the index is left as it was before the command is run. This means that the two "git diff" in the following sequence: $ git diff $ git commit -a $ git diff would show the same diff if you abort the commit process by making the commit log message empty. This commit also introduces much requested --author option. $ git commit --author 'A U Thor <author@example.com>' Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/core-tutorial.txt')
-rw-r--r--Documentation/core-tutorial.txt6
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt
index c3eaa38b5..4211c8197 100644
--- a/Documentation/core-tutorial.txt
+++ b/Documentation/core-tutorial.txt
@@ -852,7 +852,7 @@ that branch, and do some work there.
------------------------------------------------
$ git checkout mybranch
$ echo "Work, work, work" >>hello
-$ git commit -m 'Some work.' hello
+$ git commit -m 'Some work.' -i hello
------------------------------------------------
Here, we just added another line to `hello`, and we used a shorthand for
@@ -877,7 +877,7 @@ hasn't happened in the `master` branch at all. Then do
------------
$ echo "Play, play, play" >>hello
$ echo "Lots of fun" >>example
-$ git commit -m 'Some fun.' hello example
+$ git commit -m 'Some fun.' -i hello example
------------
since the master branch is obviously in a much better mood.
@@ -942,7 +942,7 @@ Work, work, work
and once you're happy with your manual merge, just do a
------------
-$ git commit hello
+$ git commit -i hello
------------
which will very loudly warn you that you're now committing a merge