holm/ohmyzsh
1
1
Fork 0
forked from extern/ohmyzsh
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(git): add missing entries and run formatter

Browse Source
This commit is contained in:
Romain Janvier 2023-01-12 13:56:26 +01:00 committed by Carlo Sala
parent 35454190f6
commit 6dc6646d52
No known key found for this signature in database
GPG Key ID: DA6FB450C1A4FE9A
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
plugins/git/README.md
View File

@ -60,6 +60,8 @@ plugins=(... git)
| gcpa | git cherry-pick --abort | | gcpa | git cherry-pick --abort |
| gcpc | git cherry-pick --continue | | gcpc | git cherry-pick --continue |
| gcs | git commit -S | | gcs | git commit -S |
| gcss | git commit -S -s |
| gcssm | git commit -S -s -m |
| gd | git diff | | gd | git diff |
| gdca | git diff --cached | | gdca | git diff --cached |
| gdcw | git diff --cached --word-diff | | gdcw | git diff --cached --word-diff |
@ -157,8 +159,8 @@ plugins=(... git)
| gsr | git svn rebase | | gsr | git svn rebase |
| gss | git status --short | | gss | git status --short |
| gst | git status | | gst | git status |
| gsta | git stash push | | gsta | git stash push (git version >= 2.13) |
| gsta | git stash save | | gsta | git stash save (git version < 2.13) |
| gstaa | git stash apply | | gstaa | git stash apply |
| gstc | git stash clear | | gstc | git stash clear |
| gstd | git stash drop | | gstd | git stash drop |
@ -176,7 +178,7 @@ plugins=(... git)
| gtv | git tag \| sort -V | | gtv | git tag \| sort -V |
| gtl | gtl(){ git tag --sort=-v:refname -n --list ${1}\* }; noglob gtl | | gtl | gtl(){ git tag --sort=-v:refname -n --list ${1}\* }; noglob gtl |
| gunignore | git update-index --no-assume-unchanged | | gunignore | git update-index --no-assume-unchanged |
| gunwip | git log --max-count=1 \| grep -q -c "\-\-wip\-\-" && git reset HEAD~1 | | gunwip | git log --max-count=1 \| grep -q -c "\-\-wip\-\-" && git reset HEAD~1 |
| gup | git pull --rebase | | gup | git pull --rebase |
| gupv | git pull --rebase --verbose | | gupv | git pull --rebase --verbose |
| gupa | git pull --rebase --autostash | | gupa | git pull --rebase --autostash |
@ -192,10 +194,10 @@ plugins=(... git)
| gams | git am --skip | | gams | git am --skip |
| gama | git am --abort | | gama | git am --abort |
| gamscp | git am --show-current-patch | | gamscp | git am --show-current-patch |
| gwt | git worktree | | gwt | git worktree |
| gwtls | git worktree list | | gwtls | git worktree list |
| gwtmv | git worktree move | | gwtmv | git worktree move |
| gwtrm | git worktree remove | | gwtrm | git worktree remove |
### Main branch preference ### Main branch preference
@ -227,7 +229,7 @@ These are aliases that have been removed, renamed, or otherwise modified in a wa
### Current ### Current
| Command | Description | | Command | Description |
|:-----------------------|:---------------------------------------------------------------------------------------------------------| | :--------------------- | :------------------------------------------------------------------------------------------------------- |
| `grename <old> <new>` | Rename `old` branch to `new`, including in origin remote | | `grename <old> <new>` | Rename `old` branch to `new`, including in origin remote |
| current_branch | Return the name of the current branch | | current_branch | Return the name of the current branch |
| git_current_user_name | Returns the `user.name` config value | | git_current_user_name | Returns the `user.name` config value |
@ -240,13 +242,13 @@ These are aliases that have been removed, renamed, or otherwise modified in a wa
These features allow to pause a branch development and switch to another one (_"Work in Progress"_, or wip). When you want to go back to work, just unwip it. These features allow to pause a branch development and switch to another one (_"Work in Progress"_, or wip). When you want to go back to work, just unwip it.
| Command | Description | | Command | Description |
|:-----------------|:------------------------------------------------| | :--------------- | :---------------------------------------------- |
| work_in_progress | Echoes a warning if the current branch is a wip | | work_in_progress | Echoes a warning if the current branch is a wip |
| gwip | Commit wip branch | | gwip | Commit wip branch |
| gunwip | Uncommit wip branch | | gunwip | Uncommit wip branch |
### Deprecated functions ### Deprecated functions
| Command | Description | Reason | | Command | Description | Reason |
|:-----------------------|:----------------------------------------|:----------------------------------------------------------------| | :----------------- | :-------------------------------------- | :-------------------------------------------------------------- |
| current_repository | Return the names of the current remotes | Didn't work properly. Use `git remote -v` instead (`grv` alias) | | current_repository | Return the names of the current remotes | Didn't work properly. Use `git remote -v` instead (`grv` alias) |