stash: update documentation to use 'stash entry'

Most of the time, a 'stash entry' is called a 'stash'. Lets try to make
this more consistent and use 'stash entry' instead.

Signed-off-by: Liam Beguin <liambeguin@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index f6278a5ae6a1f554ddb8b9861d9067181b928bb5..23b807065d92585c5b0118e9f3e3fc283ee18d24 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -2620,7 +2620,7 @@ rebase.autoSquash::
        If set to true enable `--autosquash` option by default.
 
 rebase.autoStash::
        If set to true enable `--autosquash` option by default.
 
 rebase.autoStash::

-       When set to true, automatically create a temporary stash
+       When set to true, automatically create a temporary stash entry

        before the operation begins, and apply it after the operation
        ends.  This means that you can run rebase on a dirty worktree.
        However, use with care: the final stash application after a
        before the operation begins, and apply it after the operation
        ends.  This means that you can run rebase on a dirty worktree.
        However, use with care: the final stash application after a


@@ -3029,12 +3029,12 @@ status.submoduleSummary::
 
 stash.showPatch::
        If this is set to true, the `git stash show` command without an
 
 stash.showPatch::
        If this is set to true, the `git stash show` command without an

-       option will show the stash in patch form.  Defaults to false.
+       option will show the stash entry in patch form.  Defaults to false.

        See description of 'show' command in linkgit:git-stash[1].
 
 stash.showStat::
        If this is set to true, the `git stash show` command without an
        See description of 'show' command in linkgit:git-stash[1].
 
 stash.showStat::
        If this is set to true, the `git stash show` command without an

-       option will show diffstat of the stash.  Defaults to true.
+       option will show diffstat of the stash entry.  Defaults to true.

        See description of 'show' command in linkgit:git-stash[1].
 
 submodule.<name>.url::
        See description of 'show' command in linkgit:git-stash[1].
 
 submodule.<name>.url::

diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index e414185f5a6a302afa359926c7f8c2c6bf5ac3e7..9db5e08f4a63ae6b15b37ecf7ce96ee728716195 100644 (file)
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -131,7 +131,7 @@ unless you have read linkgit:git-rebase[1] carefully.
 --autostash::
 --no-autostash::
        Before starting rebase, stash local modifications away (see
 --autostash::
 --no-autostash::
        Before starting rebase, stash local modifications away (see

-       linkgit:git-stash[1]) if needed, and apply the stash when
+       linkgit:git-stash[1]) if needed, and apply the stash entry when

        done. `--no-autostash` is useful to override the `rebase.autoStash`
        configuration variable (see linkgit:git-config[1]).
 +
        done. `--no-autostash` is useful to override the `rebase.autoStash`
        configuration variable (see linkgit:git-config[1]).
 +

diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 53f4e144444ae7b30ce2634c0f364400927b27d2..a5afd602d8eb6cf6fdfbb20863e913a5318c354d 100644 (file)
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -446,7 +446,7 @@ used to override and disable this setting.
 
 --autostash::
 --no-autostash::
 
 --autostash::
 --no-autostash::

-       Automatically create a temporary stash before the operation
+       Automatically create a temporary stash entry before the operation

        begins, and apply it after the operation ends.  This means
        that you can run rebase on a dirty worktree.  However, use
        with care: the final stash application after a successful
        begins, and apply it after the operation ends.  This means
        that you can run rebase on a dirty worktree.  However, use
        with care: the final stash application after a successful

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 70191d06b69ed307c6ce1d8f46c158b61eb6545f..00f95fee1faf52138ce014104148c444be89dabe 100644 (file)
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -51,18 +51,18 @@ OPTIONS
 save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
 push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
 
 save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
 push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
 

-       Save your local modifications to a new 'stash' and roll them
+       Save your local modifications to a new 'stash entry' and roll them

        back to HEAD (in the working tree and in the index).
        The <message> part is optional and gives
        the description along with the stashed state.
 +
 For quickly making a snapshot, you can omit "push".  In this mode,
 non-option arguments are not allowed to prevent a misspelled
        back to HEAD (in the working tree and in the index).
        The <message> part is optional and gives
        the description along with the stashed state.
 +
 For quickly making a snapshot, you can omit "push".  In this mode,
 non-option arguments are not allowed to prevent a misspelled

-subcommand from making an unwanted stash.  The two exceptions to this
+subcommand from making an unwanted stash entry.  The two exceptions to this

 are `stash -p` which acts as alias for `stash push -p` and pathspecs,
 which are allowed after a double hyphen `--` for disambiguation.
 +
 are `stash -p` which acts as alias for `stash push -p` and pathspecs,
 which are allowed after a double hyphen `--` for disambiguation.
 +

-When pathspec is given to 'git stash push', the new stash records the
+When pathspec is given to 'git stash push', the new stash entry records the

 modified states only for the files that match the pathspec.  The index
 entries and working tree files are then rolled back to the state in
 HEAD only for these files, too, leaving files that do not match the
 modified states only for the files that match the pathspec.  The index
 entries and working tree files are then rolled back to the state in
 HEAD only for these files, too, leaving files that do not match the


@@ -89,10 +89,10 @@ The `--patch` option implies `--keep-index`.  You can use
 
 list [<options>]::
 
 
 list [<options>]::
 

-       List the stashes that you currently have.  Each 'stash' is listed
-       with its name (e.g. `stash@{0}` is the latest stash, `stash@{1}` is
+       List the stash entries that you currently have.  Each 'stash entry' is
+       listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is

        the one before, etc.), the name of the branch that was current when the
        the one before, etc.), the name of the branch that was current when the

-       stash was made, and a short description of the commit the stash was
+       entry was made, and a short description of the commit the entry was

        based on.
 +
 ----------------------------------------------------------------
        based on.
 +
 ----------------------------------------------------------------


@@ -105,11 +105,12 @@ command to control what is shown and how. See linkgit:git-log[1].
 
 show [<stash>]::
 
 
 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
-       -p stash@{1}` to view the second most recent stash in patch form).
+       Show the changes recorded in the stash entry as a diff between the
+       stashed contents and the commit back when the stash entry was first
+       created. When no `<stash>` is given, it 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 -p stash@{1}`
+       to view the second most recent entry in patch form).

        You can use stash.showStat and/or stash.showPatch config variables
        to change the default behavior.
 
        You can use stash.showStat and/or stash.showPatch config variables
        to change the default behavior.
 


@@ -149,26 +150,27 @@ branch <branchname> [<stash>]::
 +
 This is useful if the branch on which you ran `git stash save` has
 changed enough that `git stash apply` fails due to conflicts. Since
 +
 This is useful if the branch on which you ran `git stash save` has
 changed enough that `git stash apply` fails due to conflicts. Since

-the stash is applied on top of the commit that was HEAD at the time
-`git stash` was run, it restores the originally stashed state with
-no conflicts.
+the stash entry is applied on top of the commit that was HEAD at the
+time `git stash` was run, it restores the originally stashed state
+with no conflicts.

 
 clear::
 
 clear::

-       Remove all the stashed states. Note that those states will then
+       Remove all the stash entries. Note that those entries will then

        be subject to pruning, and may be impossible to recover (see
        'Examples' below for a possible strategy).
 
 drop [-q|--quiet] [<stash>]::
 
        be subject to pruning, and may be impossible to recover (see
        'Examples' below for a possible strategy).
 
 drop [-q|--quiet] [<stash>]::
 

-       Remove a single stashed state from the stash list. When no `<stash>`
-       is given, it removes the latest one. i.e. `stash@{0}`, otherwise
-       `<stash>` must be a valid stash log reference of the form
-       `stash@{<revision>}`.
+       Remove a single stash entry from the list of stash entries.
+       When no `<stash>` is given, it removes the latest one.
+       i.e. `stash@{0}`, otherwise `<stash>` must be a valid stash
+       log reference of the form `stash@{<revision>}`.

 
 create::
 
 
 create::
 

-       Create a stash (which is a regular commit object) and return its
-       object name, without storing it anywhere in the ref namespace.
+       Create a stash entry (which is a regular commit object) and
+       return its object name, without storing it anywhere in the ref
+       namespace.

        This is intended to be useful for scripts.  It is probably not
        the command you want to use; see "save" above.
 
        This is intended to be useful for scripts.  It is probably not
        the command you want to use; see "save" above.
 


@@ -182,10 +184,10 @@ store::
 DISCUSSION
 ----------
 
 DISCUSSION
 ----------
 

-A stash is represented as a commit whose tree records the state of the
-working directory, and its first parent is the commit at `HEAD` when
-the stash was created.  The tree of the second parent records the
-state of the index when the stash is made, and it is made a child of
+A stash entry is represented as a commit whose tree records the state
+of the working directory, and its first parent is the commit at `HEAD`
+when the entry was created.  The tree of the second parent records the
+state of the index when the entry is made, and it is made a child of

 the `HEAD` commit.  The ancestry graph looks like this:
 
             .----W
 the `HEAD` commit.  The ancestry graph looks like this:
 
             .----W


@@ -269,12 +271,12 @@ $ edit/build/test remaining parts
 $ git commit foo -m 'Remaining parts'
 ----------------------------------------------------------------
 
 $ git commit foo -m 'Remaining parts'
 ----------------------------------------------------------------
 

-Recovering stashes that were cleared/dropped erroneously::
+Recovering stash entries that were cleared/dropped erroneously::

 
 

-If you mistakenly drop or clear stashes, they cannot be recovered
+If you mistakenly drop or clear stash entries, they cannot be recovered

 through the normal safety mechanisms.  However, you can try the
 through the normal safety mechanisms.  However, you can try the

-following incantation to get a list of stashes that are still in your
-repository, but not reachable any more:
+following incantation to get a list of stash entries that are still in
+your repository, but not reachable any more:

 +
 ----------------------------------------------------------------
 git fsck --unreachable |
 +
 ----------------------------------------------------------------
 git fsck --unreachable |

diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index dfe7d8372723c7a4970b8a7100764d1becc7f830..9f13266a685176bf142d9e381d7a9d10ea12aa7b 100644 (file)
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -194,7 +194,7 @@ different things.
  * The `--index` option is used to ask a command that
    usually works on files in the working tree to *also*
    affect the index.  For example, `git stash apply` usually
  * The `--index` option is used to ask a command that
    usually works on files in the working tree to *also*
    affect the index.  For example, `git stash apply` usually

-   merges changes recorded in a stash to the working tree,
+   merges changes recorded in a stash entry to the working tree,

    but with the `--index` option, it also merges changes to
    the index as well.
 
    but with the `--index` option, it also merges changes to
    the index as well.
 

diff --git a/git-stash.sh b/git-stash.sh
index 2fb651b2b8d9d91a130b1cbd11c3c2b6b1cf961b..68be4146bd2a9187d68332b51e470593708e0c1f 100755 (executable)
--- a/git-stash.sh
+++ b/git-stash.sh
@@ -481,7 +481,7 @@ parse_flags_and_rev()
 
        case $# in
                0)
 
        case $# in
                0)

-                       have_stash || die "$(gettext "No stash found.")"
+                       have_stash || die "$(gettext "No stash entries found.")"

                        set -- ${ref_stash}@{0}
                ;;
                1)
                        set -- ${ref_stash}@{0}
                ;;
                1)


@@ -573,7 +573,7 @@ apply_stash () {
                GIT_INDEX_FILE="$TMPindex" git-read-tree "$u_tree" &&
                GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
                rm -f "$TMPindex" ||
                GIT_INDEX_FILE="$TMPindex" git-read-tree "$u_tree" &&
                GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
                rm -f "$TMPindex" ||

-               die "$(gettext "Could not restore untracked files from stash")"
+               die "$(gettext "Could not restore untracked files from stash entry")"

        fi
 
        eval "
        fi
 
        eval "


@@ -627,7 +627,7 @@ pop_stash() {
                drop_stash "$@"
        else
                status=$?
                drop_stash "$@"
        else
                status=$?

-               say "$(gettext "The stash is kept in case you need it again.")"
+               say "$(gettext "The stash entry is kept in case you need it again.")"

                exit $status
        fi
 }
                exit $status
        fi
 }