Documentation updates.

This commit is contained in:
Marius Vollmer 2009-03-01 03:00:23 +02:00
parent e4032c3d17
commit 5c3ac91e0f
2 changed files with 31 additions and 12 deletions

15
NEWS
View file

@ -2,7 +2,7 @@ Changes in magit 0.7:
* Tagging, on 't' and 'T'.
* Stashing, on 'z'.
* Stashing, on 'z' and 'Z'.
* Wazzup, on 'w'. Wazzup gives you an overview over how other
branches relate to the current one.
@ -26,11 +26,20 @@ Changes in magit 0.7:
all sections; without, they work only on sections that are a parent
or child of the current section.
* Typing '+' and '-' will change the size of hunks, via the "-U"
option to git diff. '0' resets hunks to their default size.
* Typing 'k' on the "Untracked files" section title will offer to
delete all untracked files.
* M-x magit-status can also create repositories when given a directory
that is not a Git repository.
* Magit understands a bit of git-svn: the status buffer shows unpushed
and unpulled commits, 'N r' runs git svn rebase, and 'N c' runs git
svn commit.
* Magit now also works when the direcory is accessed via tramp.
* M-x magit-status can also create new repositories when given a
directory that is not a Git repository.
* Magit works better with oldish Gits that don't understand "--graph"
for example.

View file

@ -144,12 +144,15 @@ the diff of the current file, and @kbd{M-2} to collapse all files.
This returns the status buffer to its default setup and is a quick way
to unclutter it after drilling down into the modified files.
Because @kbd{2} and @kbd{M-2} are so common, they are bound to
additional, more mnemonic keys: @kbd{M-h} (hide) and @kbd{M-H} (hide
all).
Because @kbd{2} and @kbd{M-2} are so common in the status buffer, they
are bound to additional, more mnemonic keys: @kbd{M-h} (hide) and
@kbd{M-H} (hide all). Likewise @kbd{4} and @kbd{M-4} are also
available as @kbd{M-s} (show) and @kbd{M-S} (show all).
Likewise @kbd{4} and @kbd{M-4} are also available as @kbd{M-s} (show)
and @kbd{M-S} (show all).
In other buffers than the status buffer, @kbd{M-h}, @kbd{M-H},
@kbd{M-s}, and @kbd{M-S} might work on different levels than on 2 and
4, but they keep their general meaning: @kbd{M-H} hides all detail,
and @kbd{M-S} shows everything.
@node Status
@chapter Status
@ -250,10 +253,14 @@ changes.
Type @kbd{c} to pop up a buffer where you can write your change
description. Once you are happy with the description, type @kbd{C-c
C-c} in that buffer to perform the commit. When your staging area is
unused when you hit @kbd{c}, you will be asked whether to commit all
the unchanged changes. When the staging area is in use, only the
staged changes are committed, of course.
C-c} in that buffer to perform the commit.
Typing @kbd{c} when the staging area is unused is a special situation.
Normally, the next commit would be empty, but you can configure Magit
to do something more useful by customizing the
@code{magit-commit-all-when-nothing-staged} variable. One choice is
to instruct the subsequent @kbd{C-c C-c} to commit all changes.
Another choice is stage everything at the time of hitting @kbd{c}.
You can type @kbd{C-c C-a} in the buffer with the change description
to toggle a flag that determines whether the next commit will
@ -388,6 +395,9 @@ You can create a new stash with @kbd{z}. Your stashes will be listed
in the status buffer, and you can apply them with @kbd{a} and pop them
with @kbd{A}. To drop a stash, use @kbd{k}.
Typing @kbd{Z} will create a stash just like @kbd{z}, but will leave
the changes in your working tree and index.
You can visit and show stashes in the usual way: Typing @kbd{SPC} and
@kbd{DEL} will pop up a buffer with the description of the stash and
scroll it, typing @kbd{RET} will move point into that buffer.