Skip to content

Commit d88c338

Browse files
committed
docs: Point people to git-branch-stash
Before, git-branch-stash was bundled with git-stack. We've separated them, so we need to tell the user where to get it. Fixes #221
1 parent de5b2b6 commit d88c338

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,13 @@ Or use rust to install:
9595
$ cargo install git-stack
9696
```
9797

98+
We also recommend installing
99+
[`git-branch-stash`](https://github.com/gitext-rs/git-branch-stash) for easily
100+
undoing `git stack` operations:
101+
```console
102+
$ cargo install git-branch-stash-cli
103+
```
104+
98105
### Uninstall
99106

100107
See the uninstall method for your installer.
@@ -204,6 +211,14 @@ If a commit summary is only `WIP` or is prefixed by:
204211

205212
*This includes the prefixes used by [Gitlab](https://docs.gitlab.com/ee/user/project/merge_requests/drafts.html)*
206213

214+
### What is `git branch-staash`
215+
216+
[`git-branch-stash`](https://github.com/gitext-rs/git-branch-stash) is a
217+
separate utility that is like `git stash` for instead of your working tree, it
218+
stashes what commit each of your branches points to. `git stack` backs up
219+
using `git branch-stash`s file format to lower the risk of trying things out
220+
with `git stack`.
221+
207222
### Why don't you just ...?
208223

209224
Have an idea, we'd love to [hear it](https://github.com/gitext-rs/git-stack/discussions)!

docs/reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,9 @@ Why not `git push --set-upstream --force-with-lease origin <branch>`?
104104

105105
### `git branch-stash`
106106

107-
While `git stash` backs up and restores your working tree, `git branch-stash` backs up and restores the state of all of your branches.
107+
While `git stash` backs up and restores your working tree,
108+
[`git branch-stash`](https://github.com/gitext-rs/git-branch-stash) backs up
109+
and restores the state of all of your branches.
108110

109111
`git-stack` implicitly does a `git branch-stash` whenever modifying the tree.
110112

0 commit comments

Comments
 (0)