From bebcbd11cae38ab1ee3427dda590b96b4579970b Mon Sep 17 00:00:00 2001 From: Vladimir Jimenez Date: Tue, 25 May 2021 01:22:51 -0700 Subject: [PATCH] delete-squashed-branches: Make side-effect clear in docs --- Commands.md | 5 +++-- man/git-delete-squashed-branches.1 | 8 ++++---- man/git-delete-squashed-branches.html | 10 +++++----- man/git-delete-squashed-branches.md | 2 +- 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/Commands.md b/Commands.md index b2f417f..8e4f52a 100644 --- a/Commands.md +++ b/Commands.md @@ -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 diff --git a/man/git-delete-squashed-branches.1 b/man/git-delete-squashed-branches.1 index 7e5296e..45831b1 100644 --- a/man/git-delete-squashed-branches.1 +++ b/man/git-delete-squashed-branches.1 @@ -7,16 +7,16 @@ \fBgit\-delete\-squashed\-branches\fR \- Delete branches that were squashed . .SH "SYNOPSIS" -\fBgit\-delete\-squashed\-branches\fR [] +\fBgit\-delete\-squashed\-branches\fR [] . .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" - + . .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\. diff --git a/man/git-delete-squashed-branches.html b/man/git-delete-squashed-branches.html index a3065e6..a1ab81b 100644 --- a/man/git-delete-squashed-branches.html +++ b/man/git-delete-squashed-branches.html @@ -76,17 +76,17 @@

SYNOPSIS

-

git-delete-squashed-branches [<target-branch>]

+

git-delete-squashed-branches [<branch-name>]

DESCRIPTION

-

Deletes all git branches that have been "squash-merged" into target-branch.

+

Deletes all git branches that have been "squash-merged" into branch-name.

OPTIONS

-

<target-branch>

+

<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

@@ -102,7 +102,7 @@

AUTHOR

-

Written by Teddy Katz <teddy.katz@gmail.com> and Vladimir Jimenez <me@allejo.io>

+

Written by Teddy Katz <teddy.katz@gmail.com> and Vladimir Jimenez <me@allejo.io>

REPORTING BUGS

diff --git a/man/git-delete-squashed-branches.md b/man/git-delete-squashed-branches.md index d989590..e46cd28 100644 --- a/man/git-delete-squashed-branches.md +++ b/man/git-delete-squashed-branches.md @@ -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