add a POD to git-branchmove

1 files changed, 37 insertions, 0 deletions

diff --git a/bin/git-branchmove b/bin/git-branchmove
index 7ed63194..0b928285 100755
--- a/bin/git-branchmove
+++ b/bin/git-branchmove
@@ -28,6 +28,43 @@
 # Some information on the difficulties of getting git to expand these:
 # <https://stackoverflow.com/a/32991784>
 
+=head1 NAME
+
+git-branchmove - move a branch to or from a remote
+
+=head1 SYNOPSIS
+
+B<git-branchmove> [B<--detach>|B<-d>] B<get>|B<put> I<remote> I<pattern>...
+
+=head1 DESCRIPTION
+
+Move branches matching I<pattern> to or from git remote I<remote>.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--detach>|B<-d>
+
+If the move would delete the currently checked out branch in the
+source repository, attempt to detach HEAD first.
+
+Note that in the case of the B<get> operation, the attempt to detach
+HEAD is somewhat fragile.  You will need unrestricted SSH access to
+the remote, and pushInsteadOf git configuration keys will not always
+be expanded, due to limitations in git.
+
+=back
+
+=head1 AUTHOR
+
+This Perl version of B<git-branchmove> was written by Sean Whitton
+<spwhitton@spwhitton.name>, based on an earlier shell script by Ian
+Jackson.  That script made some assumptions that we try to avoid, for
+compatibility with more git remotes and local git configurations.
+
+=cut
+
 use strict;
 use warnings;