diff options
| author | Jonathan Nieder <jrnieder@uchicago.edu> | 2008-06-30 01:09:04 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-07-01 17:20:15 -0700 |
| commit | b1889c36d85514e5e70462294c561a02c2edfe2b (patch) | |
| tree | 9a171d7e3fb8063c239a2c9c4dcec744a202de07 /Documentation/git-stash.txt | |
| parent | 46e56e81b3bc91af7071809fbda8dcdec22c4cb1 (diff) | |
| download | git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.gz | |
Documentation: be consistent about "git-" versus "git "
Since the git-* commands are not installed in $(bindir), using
"git-command <parameters>" in examples in the documentation is
not a good idea. On the other hand, it is nice to be able to
refer to each command using one hyphenated word. (There is no
escaping it, anyway: man page names cannot have spaces in them.)
This patch retains the dash in naming an operation, command,
program, process, or action. Complete command lines that can
be entered at a shell (i.e., without options omitted) are
made to use the dashless form.
The changes consist only of replacing some spaces with hyphens
and vice versa. After a "s/ /-/g", the unpatched and patched
versions are identical.
Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-stash.txt')
| -rw-r--r-- | Documentation/git-stash.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index baa4f55b48..f994679d95 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -8,13 +8,13 @@ git-stash - Stash the changes in a dirty working directory away SYNOPSIS -------- [verse] -'git-stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) -'git-stash' [save [<message>]] +'git stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) +'git stash' [save [<message>]] DESCRIPTION ----------- -Use 'git-stash' when you want to record the current state of the +Use 'git stash' when you want to record the current state of the working directory and the index, but want to go back to a clean working directory. The command saves your local modifications away and reverts the working directory to match the `HEAD` commit. @@ -22,7 +22,7 @@ and reverts the working directory to match the `HEAD` commit. The modifications stashed away by this command can be listed with `git-stash list`, inspected with `git-stash show`, and restored (potentially on top of a different commit) with `git-stash apply`. -Calling git-stash without any arguments is equivalent to `git-stash +Calling git stash without any arguments is equivalent to `git stash save`. A stash is by default listed as "WIP on 'branchname' ...", but you can give a more descriptive message on the command line when you create one. @@ -38,7 +38,7 @@ OPTIONS save [<message>]:: - Save your local modifications to a new 'stash', and run `git-reset + Save your local modifications to a new 'stash', and run `git reset --hard` to revert them. This is the default action when no subcommand is given. The <message> part is optional and gives the description along with the stashed state. @@ -64,7 +64,7 @@ show [<stash>]:: Show the changes recorded in the stash as a diff between the stashed state and its original parent. When no `<stash>` is given, shows the latest one. By default, the command shows the diffstat, but - it will accept any format known to `git-diff` (e.g., `git-stash show + it will accept any format known to `git-diff` (e.g., `git stash show -p stash@\{1}` to view the second most recent stash in patch form). apply [--index] [<stash>]:: |