mirror of
https://github.com/tj/git-extras.git
synced 2026-09-10 07:26:17 -04:00
delete-squashed-branches: Make side-effect clear in docs
This commit is contained in:
parent
fb1e5db6d7
commit
bebcbd11ca
|
|
@ -854,12 +854,13 @@ Deleted feature/dashboard (was 923befa).
|
|||
|
||||
## git delete-squashed-branches
|
||||
|
||||
Deletes branches that have been "squashed-merged" into a specified branch
|
||||
Deletes branches that have been "squashed-merged" into a specified branch; this branch will be checked out as a side-effect. If no branch is specified, then it will default to the current checked out branch.
|
||||
|
||||
```bash
|
||||
$ git delete-squashed-branches main
|
||||
$ (feature-branch) git delete-squashed-branches main
|
||||
Deleted branch dependabot/bundler/kramdown-2.3.1 (was 1d3fb00).
|
||||
Deleted branch dependabot/bundler/rexml-3.2.5 (was a7e4052).
|
||||
$ (main) git ...
|
||||
```
|
||||
|
||||
## git fresh-branch
|
||||
|
|
|
|||
|
|
@ -7,16 +7,16 @@
|
|||
\fBgit\-delete\-squashed\-branches\fR \- Delete branches that were squashed
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
\fBgit\-delete\-squashed\-branches\fR [<target\-branch>]
|
||||
\fBgit\-delete\-squashed\-branches\fR [<branch\-name>]
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
Deletes all git branches that have been "squash\-merged" into \fBtarget\-branch\fR\.
|
||||
Deletes all git branches that have been "squash\-merged" into \fBbranch\-name\fR\.
|
||||
.
|
||||
.SH "OPTIONS"
|
||||
<target\-branch>
|
||||
<branch\-name>
|
||||
.
|
||||
.P
|
||||
The target branch were the "squashed\-merged" branches were committed to\.
|
||||
The target branch were the "squashed\-merged" branches were committed to\. If no value is given, then the current checked out branch will be used\.
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Delete all branches that were "squash\-merged" into the current checked out branch\.
|
||||
|
|
|
|||
|
|
@ -76,17 +76,17 @@
|
|||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<p><code>git-delete-squashed-branches</code> [<target-branch>]</p>
|
||||
<p><code>git-delete-squashed-branches</code> [<branch-name>]</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<p>Deletes all git branches that have been "squash-merged" into <code>target-branch</code>.</p>
|
||||
<p>Deletes all git branches that have been "squash-merged" into <code>branch-name</code>.</p>
|
||||
|
||||
<h2 id="OPTIONS">OPTIONS</h2>
|
||||
|
||||
<p> <target-branch></p>
|
||||
<p> <branch-name></p>
|
||||
|
||||
<p> The target branch were the "squashed-merged" branches were committed to.</p>
|
||||
<p> The target branch were the "squashed-merged" branches were committed to. If no value is given, then the current checked out branch will be used.</p>
|
||||
|
||||
<h2 id="EXAMPLES">EXAMPLES</h2>
|
||||
|
||||
|
|
@ -102,7 +102,7 @@
|
|||
|
||||
<h2 id="AUTHOR">AUTHOR</h2>
|
||||
|
||||
<p>Written by Teddy Katz <<a href="mailto:teddy.katz@gmail.com" data-bare-link="true">teddy.katz@gmail.com</a>> and Vladimir Jimenez <<a href="mailto:me@allejo.io" data-bare-link="true">me@allejo.io</a>></p>
|
||||
<p>Written by Teddy Katz <<a href="mailto:teddy.katz@gmail.com" data-bare-link="true">teddy.katz@gmail.com</a>> and Vladimir Jimenez <<a href="mailto:me@allejo.io" data-bare-link="true">me@allejo.io</a>></p>
|
||||
|
||||
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Deletes all git branches that have been "squash-merged" into `branch-name`.
|
|||
|
||||
<branch-name>
|
||||
|
||||
The target branch were the "squashed-merged" branches were committed to.
|
||||
The target branch were the "squashed-merged" branches were committed to. If no value is given, then the current checked out branch will be used.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue