aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThibault Jamet <tjamet@users.noreply.github.com>2021-06-01 23:33:46 +0200
committerThibault Jamet <tjamet@users.noreply.github.com>2021-10-28 21:49:27 +0200
commit21d8d7e95144eca38e93120b575c0ebd436e0e24 (patch)
treebf8e7dd35e67108155bc868e1f10214fe11538cf
parent617ae9f34f46b440f59979cdfc8a399e36decc32 (diff)
downloadgo-git-21d8d7e95144eca38e93120b575c0ebd436e0e24.tar.gz
Document the push refspec format
Taken from `git help push` and adapted to match the supported features only. Future iterations of this feature may include better support for git "SHA-1 expression", documented in `git help push` as: > any arbitrary "SHA-1 expression", such as master~4 or HEAD (see gitrevisions(7)).
-rw-r--r--options.go10
1 files changed, 8 insertions, 2 deletions
diff --git a/options.go b/options.go
index 3bd6876..b71299b 100644
--- a/options.go
+++ b/options.go
@@ -198,8 +198,14 @@ type PushOptions struct {
RemoteName string
// RemoteURL overrides the remote repo address with a custom URL
RemoteURL string
- // RefSpecs specify what destination ref to update with what source
- // object. A refspec with empty src can be used to delete a reference.
+ // RefSpecs specify what destination ref to update with what source object.
+ //
+ // The format of a <refspec> parameter is an optional plus +, followed by
+ // the source object <src>, followed by a colon :, followed by the destination ref <dst>.
+ // The <src> is often the name of the branch you would want to push, but it can be a SHA-1.
+ // The <dst> tells which ref on the remote side is updated with this push.
+ //
+ // A refspec with empty src can be used to delete a reference.
RefSpecs []config.RefSpec
// Auth credentials, if required, to use with the remote repository.
Auth transport.AuthMethod