Skip to content

Commit

Permalink
Document the push refspec format
Browse files Browse the repository at this point in the history
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)).
  • Loading branch information
tjamet committed Oct 28, 2021
1 parent 617ae9f commit 21d8d7e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions options.go
Expand Up @@ -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
Expand Down

0 comments on commit 21d8d7e

Please sign in to comment.