Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Worktree aliases #104

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
656 changes: 0 additions & 656 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
1 change: 1 addition & 0 deletions doc/git-wt/README.md
17 changes: 17 additions & 0 deletions doc/git-wt/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# git wt

## Short for "git worktree"

Git alias:

```git
wt = worktree
```

Example:

```shell
git wt
```

worktree manages multiple workting trees attached to the same repository
1 change: 1 addition & 0 deletions doc/git-wta/README.md
15 changes: 15 additions & 0 deletions doc/git-wta/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# git wta

## worktree add i.e. create a worktree and checkout <commit-ish> into it
joelparkerhenderson marked this conversation as resolved.
Show resolved Hide resolved

Git alias:

```git
wta = worktree add
```

Example:

```shell
git wta foo
```
1 change: 1 addition & 0 deletions doc/git-wtd/README.md
16 changes: 16 additions & 0 deletions doc/git-wtd/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# git wtd

## worktree remove i.e. remove a worktree

Git alias:

```git
wtd = worktree remove
```

Example:

```shell
git wtd foo
```
1 change: 1 addition & 0 deletions doc/git-wtl/README.md
16 changes: 16 additions & 0 deletions doc/git-wtl/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# git wtl

## worktree lock i.e. Lock a worktree to prevent its admin files from being pruned automatically
joelparkerhenderson marked this conversation as resolved.
Show resolved Hide resolved

Git alias:

```git
wtl = worktree lock
```

Example:

```shell
git wtl foo
```
1 change: 1 addition & 0 deletions doc/git-wtls/README.md
16 changes: 16 additions & 0 deletions doc/git-wtls/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# git wtls

## worktree list i.e. List details of each wotktree
joelparkerhenderson marked this conversation as resolved.
Show resolved Hide resolved

Git alias:

```git
wtls = worktree list
```

Example:

```shell
git wtls foo
```
1 change: 1 addition & 0 deletions doc/git-wtm/README.md
16 changes: 16 additions & 0 deletions doc/git-wtm/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# git wtm

## worktree move i.e. move a worktree to a new location

Git alias:

```git
wtm = worktree move
```

Example:

```shell
git wtm foo
```
1 change: 1 addition & 0 deletions doc/git-wtp/README.md
16 changes: 16 additions & 0 deletions doc/git-wtp/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# git wtp

## worktree prune i.e. prune worktree information in ${GIT_DIR}/worktrees
joelparkerhenderson marked this conversation as resolved.
Show resolved Hide resolved

Git alias:

```git
wtp = worktree prune
```

Example:

```shell
igit wtp foo
```
1 change: 1 addition & 0 deletions doc/git-wtr/README.md
16 changes: 16 additions & 0 deletions doc/git-wtr/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# git wtr

## worktree repair i.e. repair worktree admin files if possible

Git alias:

```git
wtr = worktree repair
```

Example:

```shell
git wtr foo
```
1 change: 1 addition & 0 deletions doc/git-wtu/README.md
16 changes: 16 additions & 0 deletions doc/git-wtu/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# git wtu

## worktree unlock i.e. unlock a worktree, allowint it to be pruned, moved, or deleted
joelparkerhenderson marked this conversation as resolved.
Show resolved Hide resolved

Git alias:

```git
wtu = worktree unlock
```

Example:

```shell
git wtu foo
```
12 changes: 12 additions & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,18 @@ git whatchanged:

* [git w](git-w/) = whatchanged

git worktree:

* [git wt](git-wt/) = worktree
* [git wta](git-wta/) = worktree add
* [git wtls](git-wtls/) = worktree list
* [git wtl](git-wtl/) = worktree lock
* [git wtm](git-wtm/) = worktree move
* [git wtp](git-wtp/) = worktree prune
* [git wtd](git-wtd/) = worktree remove
* [git wtr](git-wtr/) = worktree repair
* [git wtu](git-wtu/) = worktree unlock


## Friendly aliases

Expand Down
Loading