储藏与清理 | MRCODE-BOOK

# 储藏与清理

有时，当你在项目的一部分上 已经工作一段时间后，所有东西都进入了混乱的状态，而 这时你想要切换到另一个分支做一点别的事情。问题是，你不想仅仅因为过会儿回到这一点而为做了一半的工作创建一次提交。针对这个问题的答案是 git stash 命令。

储藏会处理工作目录的脏的状态 – 即，修改的跟踪文件 与 暂存改动 – 然后将未完成的修改 保存到一个栈上，而你可以在任何时候重新应用这些改动。

注意：储藏的是 被跟踪的文件，也就是说，你的文件状态是新增的未被跟踪的文件是不会被储藏的，如下面这样的

$ git status
On branch master
Your branch and 'origin/master' have diverged,
and have 2 and 1 different commits each, respectively.
  (use "git pull" to merge the remote branch into yours)

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        modified:   1.txt		# 这个修改的文件会被储藏

Untracked files: # 未跟踪的文件
  (use "git add <file>..." to include in what will be committed)
        3.txt				# 这个文件是新增的，这样的是不会被 stash 储藏的

1
2
3
4
5
6
7
8
9
10
11
12
13
14

这个是不带参数的储藏，后面讲解带参数的储藏，就会改变这种默认的作用

# 储藏工作

为了演示，进入项目并改动几个文件，然后 可能暂存其中的一个改动。如果运行 git status，可以看到有改动的状态：

$ git status
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

	modified:   index.html

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   lib/simplegit.rb

1
2
3
4
5
6
7
8
9
10
11

现在想要切换分支，但是还不想要提交之前的工作；所以储藏修改。将新的储藏推送到栈上，运行 git stash 或 git stash save：

$ git stash
Saved working directory and index state \
  "WIP on master: 049d078 added the index file"
HEAD is now at 049d078 added the index file
(To restore them type "git stash apply")

1
2
3
4
5

工作目录是干净的了：

$ git status
# On branch master
nothing to commit, working directory clean

1
2
3

在这时，你能够轻易地切换分支并在其他地方工作；你的修改被存储在栈上。要查看储藏的东西，可以使用 git stash list：

$ git stash list
stash@{0}: WIP on master: 049d078 added the index file
stash@{1}: WIP on master: c264051 Revert "added file_size"
stash@{2}: WIP on master: 21d80a5 added number to log

1
2
3
4

在本例中，有两个之前做的储藏，所以你接触到了三个不同的储藏工作。可以通过原来 stash 命令的帮助提示中的命令将你刚刚储藏的工作重新应用：git stash apply。如果想要应用其中一个更旧的储藏，可以通过名字指定它，像这样：git stash apply stash@{2}。 如果不指定一个储藏，Git 认为指定的是最近的储藏：

$ git stash apply
On branch master
Changed but not updated:
   (use "git add <file>..." to update what will be committed)

      modified:   index.html	# 注意看这里， stash 前是被 add 暂存了的，这里变成了未暂存
      modified:   lib/simplegit.rb

1
2
3
4
5
6
7
8

可以看到 Git 重新修改了当你保存储藏时撤消的文件。在本例中，当尝试应用储藏时有一个干净的工作目录，并且尝试将它应用在保存它时所在的分支；但是有一个干净的工作目录与应用在同一分支并不是成功应用储藏的充分必要条件。 可以在一个分支上保存一个储藏，切换到另一个分支，然后尝试重新应用这些修改。当应用储藏时工作目录中也可以有修改与未提交的文件 – 如果有任何东西不能干净地应用，Git 会产生合并冲突。

文件的改动被重新应用了，但是之前暂存的文件却没有重新暂存。想要那样的话，必须使用 –index 选项来运行 git stash apply 命令，来尝试重新应用暂存的修改。如果已经那样做了，那么你将回到原来的位置：

$ git stash apply --index		# 在应用暂存的时候，使用 --index 命令尝试重新应用暂存的修改
 On branch master
 Changes to be committed:
   (use "git reset HEAD <file>..." to unstage)

      modified:   index.html		# 注意看这里，与不加 --index 参数的命令不一致的表现

 Changed but not updated:
   (use "git add <file>..." to update what will be committed)

      modified:   lib/simplegit.rb

1
2
3
4
5
6
7
8
9
10
11

应用选项只会尝试应用暂存的工作 – 在堆栈上还有它。可以运行 git stash drop 加上将要移除的储藏的名字来移除它：

$ git stash list
stash@{0}: WIP on master: 049d078 added the index file
stash@{1}: WIP on master: c264051 Revert "added file_size"
stash@{2}: WIP on master: 21d80a5 added number to log
$ git stash drop stash@{0}
Dropped stash@{0} (364e91f3f268f0900bc3ee613f9f733e82aaed43)

1
2
3
4
5
6

也可以运行 git stash pop 来应用储藏然后立即从栈上扔掉它。

# 小结

stash 或 stash save：储藏工作目录中 修改的跟踪文件 与 暂存改动
stash list：查看储藏列表
stash apply：应用最近一个储藏或指定储藏
stash drop：删除一个储藏
stash pop：应用并删除一个储藏

# 创造性的储藏

有几个储藏的变种可能也很有用。第一个非常流行的选项是 stash save 命令的 –keep-index 选项。它 告诉 Git 不要储藏任何你通过 git add 命令已暂存的东西。

当你做了几个改动并只想提交其中的一部分，过一会儿再回来处理剩余改动时，这个功能会很有用。

$ git status -s
M  index.html
 M lib/simplegit.rb

$ git stash --keep-index
Saved working directory and index state WIP on master: 1b65b17 added the index file
HEAD is now at 1b65b17 added the index file

$ git status -s
M  index.html

1
2
3
4
5
6
7
8
9
10

另一个经常使用储藏来做的事情是 像储藏跟踪文件一样储藏未跟踪文件。默认情况下，git stash 只会储藏已经在索引中的文件。如果指定 –include-untracked 或 -u 标记，Git 也会储藏任何创建的未跟踪文件。

$ git status -s
M  index.html
 M lib/simplegit.rb
?? new-file.txt

$ git stash -u
Saved working directory and index state WIP on master: 1b65b17 added the index file
HEAD is now at 1b65b17 added the index file

$ git status -s
$

1
2
3
4
5
6
7
8
9
10
11

最终，如果指定了 –patch 标记，Git 不会储藏所有修改过的任何东西，但是会交互式地提示哪些改动想要储藏、哪些改动需要保存在工作目录中。

$ git stash --patch
diff --git a/lib/simplegit.rb b/lib/simplegit.rb
index 66d332e..8bb5674 100644
--- a/lib/simplegit.rb
+++ b/lib/simplegit.rb
@@ -16,6 +16,10 @@ class SimpleGit
         return `#{git_cmd} 2>&1`.chomp
       end
     end
+
+    def show(treeish = 'master')
+      command("git show #{treeish}")
+    end

 end
 test
Stash this hunk [y,n,q,a,d,/,e,?]? y

Saved working directory and index state WIP on master: 1b65b17 added the index file

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 小结

stash --keep-index：跳过暂存的东西

不要储藏任何你通过 git add 命令已暂存的东西
stash --include-untracked 或 stash -u：储藏时把未跟踪的文件也一起储藏
stash --patch

Git 不会储藏所有修改过的任何东西**，**但是会交互式地提示哪些改动想要储藏、哪些改动需要保存在工作目录中

# 从储藏创建一个分支

如果 储藏了一些工作，将它留在那儿了一会儿，然后 继续在储藏的分支上工作，在重新应用工作时可能会有问题。如果应用尝试修改刚刚修改的文件，你会得到一个合并冲突并不得不解决它。如果想要一个轻松的方式来再次测试储藏的改动，可以运行 git stash branch 创建一个新分支，检出储藏工作时所在的提交，重新在那应用工作，然后在应用成功后扔掉储藏：

可以如下炮制这个场景：

vim 1.txt		# 修改其中第 2 行
# 储藏起来
$ git stash
Saved working directory and index state WIP on testc: e3ec771 u1

# 现在工作目录是干净的了
$ git status
On branch testc
nothing to commit, working tree clean

vim 1.txt		# 修改其中第 2 行内容

# 尝试应用储藏 e3ec771 
$ git stash pop
	# 您对以下文件的本地更改将被合并覆盖。
error: Your local changes to the following files would be overwritten by merge:
        1.txt
    # 请在合并前提交您的修改或将其储藏起来。 
Please commit your changes or stash them before you merge.
Aborting  # 此次应用储藏被终止
The stash entry is kept in case you need it again. 

# 那么我们就先将修改的提交
$ git commit -am 'u2'
[testc 294f1db] u2
 1 file changed, 1 insertion(+), 1 deletion(-)

# 工作目录是干净的了
$ git status
On branch testc
nothing to commit, working tree clean

# 再次尝试应用储藏
$ git stash pop
Auto-merging 1.txt		# 自动合并 1.txt 文件
CONFLICT (content): Merge conflict in 1.txt # 但是合并失败了
The stash entry is kept in case you need it again. # 储藏没有被删除，被保留了起来

# 现在需要手动的处理这个冲突
vim 1.txt

x

ruby-client

<<<<<<< Updated upstream   # 手动处理这个冲突
1233
=======
1
>>>>>>> Stashed changes

# 处理冲突后，再暂存起来
$ git add 1.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

可以看到如上的储藏应用，太麻烦了

vim 1.txt		# 修改其中第 2 行
# 储藏起来
$ git stash
Saved working directory and index state WIP on testc: e3ec771 u1

# 现在工作目录是干净的了
$ git status
On branch testc
nothing to commit, working tree clean

vim 1.txt		# 修改其中第 2 行内容

#============================= 在这之前都是来炮制一个这样的场景

# 接下来，需要先提交我们后来的这次改动
$ git commit -am 'u3'
[master 854b9a4] u3
 1 file changed, 1 insertion(+), 1 deletion(-)
 
# 然后从储藏中创建一个分支进行应用，这样就不会导致和我们之前的 U3 改动进行冲突
$ git stash branch testchanges
Switched to a new branch 'testchanges'
On branch testchanges
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   1.txt

no changes added to commit (use "git add" and/or "git commit -a")
Dropped refs/stash@{0} (e22d04bfd0b34518550d7ca2286690b32b1f181c)

$ git branch
  master
* testchanges		# 可以看到在新的分支上了

# 如果还想要这个储藏的改动，就需要先提交，再合并会原来的分支
$ git commit -am 'u2'
[testchanges ee3861b] u2
 1 file changed, 1 insertion(+), 1 deletion(-)

$ git checkout master
Switched to branch 'master'
Your branch and 'origin/master' have diverged,
and have 3 and 1 different commits each, respectively.
  (use "git pull" to merge the remote branch into yours)

# 不过在合并的时候还是会产生冲突，还是需要自己手动合并
$ git merge testchanges
Auto-merging 1.txt
CONFLICT (content): Merge conflict in 1.txt
Automatic merge failed; fix conflicts and then commit the result.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

但是对于恢复储藏来说，这是在新分支轻松恢复储藏工作并继续工作的一个很不错的途径。

# 清理工作目录

对于工作目录中一些工作或文件，你想做的也许不是储藏而是移除。 git clean 命令会帮你做这些事。

有一些通用的原因比如说 为了移除由合并或外部工具生成的东西，或是 为了运行一个干净的构建而移除之前构建的残留。

你需要谨慎地使用这个命令，因为它 被设计为从工作目录中移除未被追踪的文件。如果你改变主意了，你也不一定能找回来那些文件的内容。一个更安全的选项是运行 git stash –all 来移除每一样东西并存放在栈中。

你可以使用 git clean 命令去除冗余文件或者清理工作目录。使用 git clean -f -d 命令来移除工作目录中所有未追踪的文件以及空的子目录。-f 意味着强制或 “确定移除” 。

如果只是想要看看它会做什么，可以使用 -n 选项来运行命令，这意味着「做一次演习然后告诉你将要移除什么」。

$ git clean -d -n
Would remove test.o
Would remove tmp/

1
2
3

默认情况下，git clean 命令只会移除没有忽略的未跟踪文件。任何与 .gitiignore 或其他忽略文件中的模式匹配的文件都不会被移除。如果你也想要移除那些文件，例如为了做一次完全干净的构建而移除所有由构建生成的 .o 文件，可以给 clean 命令增加一个 -x 选项。

$ git status -s
 M lib/simplegit.rb
?? build.TMP		# 未被跟踪的文件
?? tmp/

$ git clean -n -d
Would remove build.TMP
Would remove tmp/

$ git clean -n -d -x
Would remove build.TMP
Would remove test.o # 这个文件是 gitiignore 忽略的文件，使用 -x 也可以删除掉
Would remove tmp/

1
2
3
4
5
6
7
8
9
10
11
12
13

如果不知道 git clean 命令将会做什么，在将 -n 改为 -f 来真正做之前总是先用 -n 来运行它做双重检查。另一个小心处理过程的方式是使用 -i 或 interactive 标记来运行它。

这将会以交互模式运行 clean 命令。

$ git clean -x -i
Would remove the following items:
  build.TMP  test.o
*** Commands ***
    1: clean                2: filter by pattern    3: select by numbers    4: ask each             5: quit
    6: help
What now>

1
2
3
4
5
6
7

这种方式下可以分别地检查每一个文件或者交互地指定删除的模式。

← 交互式暂存签署工作 →