From 6afb69cebb5f24b648b44b2c5d7bc0ec38d5ed4c Mon Sep 17 00:00:00 2001 From: lhchavez Date: Fri, 3 Sep 2021 06:50:55 -0700 Subject: [PATCH] Prepare for the v1.2.0 release This change adds a few more deprecation messages just before we remove them. --- deprecated.go | 200 ++++++++++++++++++++++++++++++++------------------ remote.go | 6 +- 2 files changed, 131 insertions(+), 75 deletions(-) diff --git a/deprecated.go b/deprecated.go index c948808..64f18e0 100644 --- a/deprecated.go +++ b/deprecated.go @@ -13,10 +13,10 @@ import ( // blob.go -// BlobChunkCallback is not used. +// Deprecated: BlobChunkCallback is not used. type BlobChunkCallback func(maxLen int) ([]byte, error) -// BlobCallbackData is not used. +// Deprecated: BlobCallbackData is not used. type BlobCallbackData struct { Callback BlobChunkCallback Error error @@ -24,12 +24,12 @@ type BlobCallbackData struct { // checkout.go -// CheckoutOpts is a deprecated alias of CheckoutOptions. +// Deprecated: CheckoutOpts is a deprecated alias of CheckoutOptions. type CheckoutOpts = CheckoutOptions // credentials.go -// CredType is a deprecated alias of CredentialType +// Deprecated: CredType is a deprecated alias of CredentialType type CredType = CredentialType const ( @@ -39,35 +39,35 @@ const ( CredTypeDefault = CredentialTypeDefault ) -// Cred is a deprecated alias of Credential +// Deprecated: Cred is a deprecated alias of Credential type Cred = Credential -// NewCredUsername is a deprecated alias of NewCredentialUsername. +// Deprecated: NewCredUsername is a deprecated alias of NewCredentialUsername. func NewCredUsername(username string) (*Cred, error) { return NewCredentialUsername(username) } -// NewCredUserpassPlaintext is a deprecated alias of NewCredentialUserpassPlaintext. +// Deprecated: NewCredUserpassPlaintext is a deprecated alias of NewCredentialUserpassPlaintext. func NewCredUserpassPlaintext(username string, password string) (*Cred, error) { return NewCredentialUserpassPlaintext(username, password) } -// NewCredSshKey is a deprecated alias of NewCredentialSshKey. +// Deprecated: NewCredSshKey is a deprecated alias of NewCredentialSshKey. func NewCredSshKey(username string, publicKeyPath string, privateKeyPath string, passphrase string) (*Cred, error) { return NewCredentialSSHKey(username, publicKeyPath, privateKeyPath, passphrase) } -// NewCredSshKeyFromMemory is a deprecated alias of NewCredentialSSHKeyFromMemory. +// Deprecated: NewCredSshKeyFromMemory is a deprecated alias of NewCredentialSSHKeyFromMemory. func NewCredSshKeyFromMemory(username string, publicKey string, privateKey string, passphrase string) (*Cred, error) { return NewCredentialSSHKeyFromMemory(username, publicKey, privateKey, passphrase) } -// NewCredSshKeyFromAgent is a deprecated alias of NewCredentialSSHFromAgent. +// Deprecated: NewCredSshKeyFromAgent is a deprecated alias of NewCredentialSSHFromAgent. func NewCredSshKeyFromAgent(username string) (*Cred, error) { return NewCredentialSSHKeyFromAgent(username) } -// NewCredDefault is a deprecated alias fof NewCredentialDefault. +// Deprecated: NewCredDefault is a deprecated alias fof NewCredentialDefault. func NewCredDefault() (*Cred, error) { return NewCredentialDefault() } @@ -82,91 +82,147 @@ const ( // features.go const ( - // FeatureHttps is a deprecated alias of FeatureHTTPS. + // Deprecated: FeatureHttps is a deprecated alias of FeatureHTTPS. FeatureHttps = FeatureHTTPS - // FeatureSsh is a deprecated alias of FeatureSSH. + // Deprecated: FeatureSsh is a deprecated alias of FeatureSSH. FeatureSsh = FeatureSSH ) // git.go const ( - ErrClassNone = ErrorClassNone - ErrClassNoMemory = ErrorClassNoMemory - ErrClassOs = ErrorClassOS - ErrClassInvalid = ErrorClassInvalid - ErrClassReference = ErrorClassReference - ErrClassZlib = ErrorClassZlib + // Deprecated: ErrClassNone is a deprecated alias of ErrorClassNone. + ErrClassNone = ErrorClassNone + // Deprecated: ErrClassNoMemory is a deprecated alias of ErrorClassNoMemory. + ErrClassNoMemory = ErrorClassNoMemory + // Deprecated: ErrClassOs is a deprecated alias of ErrorClassOS. + ErrClassOs = ErrorClassOS + // Deprecated: ErrClassInvalid is a deprecated alias of ErrorClassInvalid. + ErrClassInvalid = ErrorClassInvalid + // Deprecated: ErrClassReference is a deprecated alias of ErrorClassReference. + ErrClassReference = ErrorClassReference + // Deprecated: ErrClassZlib is a deprecated alias of ErrorClassZlib. + ErrClassZlib = ErrorClassZlib + // Deprecated: ErrClassRepository is a deprecated alias of ErrorClassRepository. ErrClassRepository = ErrorClassRepository - ErrClassConfig = ErrorClassConfig - ErrClassRegex = ErrorClassRegex - ErrClassOdb = ErrorClassOdb - ErrClassIndex = ErrorClassIndex - ErrClassObject = ErrorClassObject - ErrClassNet = ErrorClassNet - ErrClassTag = ErrorClassTag - ErrClassTree = ErrorClassTree - ErrClassIndexer = ErrorClassIndexer - ErrClassSSL = ErrorClassSSL - ErrClassSubmodule = ErrorClassSubmodule - ErrClassThread = ErrorClassThread - ErrClassStash = ErrorClassStash - ErrClassCheckout = ErrorClassCheckout - ErrClassFetchHead = ErrorClassFetchHead - ErrClassMerge = ErrorClassMerge - ErrClassSsh = ErrorClassSSH - ErrClassFilter = ErrorClassFilter - ErrClassRevert = ErrorClassRevert - ErrClassCallback = ErrorClassCallback - ErrClassRebase = ErrorClassRebase - ErrClassPatch = ErrorClassPatch + // Deprecated: ErrClassConfig is a deprecated alias of ErrorClassConfig. + ErrClassConfig = ErrorClassConfig + // Deprecated: ErrClassRegex is a deprecated alias of ErrorClassRegex. + ErrClassRegex = ErrorClassRegex + // Deprecated: ErrClassOdb is a deprecated alias of ErrorClassOdb. + ErrClassOdb = ErrorClassOdb + // Deprecated: ErrClassIndex is a deprecated alias of ErrorClassIndex. + ErrClassIndex = ErrorClassIndex + // Deprecated: ErrClassObject is a deprecated alias of ErrorClassObject. + ErrClassObject = ErrorClassObject + // Deprecated: ErrClassNet is a deprecated alias of ErrorClassNet. + ErrClassNet = ErrorClassNet + // Deprecated: ErrClassTag is a deprecated alias of ErrorClassTag. + ErrClassTag = ErrorClassTag + // Deprecated: ErrClassTree is a deprecated alias of ErrorClassTree. + ErrClassTree = ErrorClassTree + // Deprecated: ErrClassIndexer is a deprecated alias of ErrorClassIndexer. + ErrClassIndexer = ErrorClassIndexer + // Deprecated: ErrClassSSL is a deprecated alias of ErrorClassSSL. + ErrClassSSL = ErrorClassSSL + // Deprecated: ErrClassSubmodule is a deprecated alias of ErrorClassSubmodule. + ErrClassSubmodule = ErrorClassSubmodule + // Deprecated: ErrClassThread is a deprecated alias of ErrorClassThread. + ErrClassThread = ErrorClassThread + // Deprecated: ErrClassStash is a deprecated alias of ErrorClassStash. + ErrClassStash = ErrorClassStash + // Deprecated: ErrClassCheckout is a deprecated alias of ErrorClassCheckout. + ErrClassCheckout = ErrorClassCheckout + // Deprecated: ErrClassFetchHead is a deprecated alias of ErrorClassFetchHead. + ErrClassFetchHead = ErrorClassFetchHead + // Deprecated: ErrClassMerge is a deprecated alias of ErrorClassMerge. + ErrClassMerge = ErrorClassMerge + // Deprecated: ErrClassSsh is a deprecated alias of ErrorClassSSH. + ErrClassSsh = ErrorClassSSH + // Deprecated: ErrClassFilter is a deprecated alias of ErrorClassFilter. + ErrClassFilter = ErrorClassFilter + // Deprecated: ErrClassRevert is a deprecated alias of ErrorClassRevert. + ErrClassRevert = ErrorClassRevert + // Deprecated: ErrClassCallback is a deprecated alias of ErrorClassCallback. + ErrClassCallback = ErrorClassCallback + // Deprecated: ErrClassRebase is a deprecated alias of ErrorClassRebase. + ErrClassRebase = ErrorClassRebase + // Deprecated: ErrClassPatch is a deprecated alias of ErrorClassPatch. + ErrClassPatch = ErrorClassPatch ) const ( - ErrOk = ErrorCodeOK - ErrGeneric = ErrorCodeGeneric - ErrNotFound = ErrorCodeNotFound - ErrExists = ErrorCodeExists - ErrAmbiguous = ErrorCodeAmbiguous - ErrAmbigious = ErrorCodeAmbiguous - ErrBuffs = ErrorCodeBuffs - ErrUser = ErrorCodeUser - ErrBareRepo = ErrorCodeBareRepo - ErrUnbornBranch = ErrorCodeUnbornBranch - ErrUnmerged = ErrorCodeUnmerged + // Deprecated: ErrOk is a deprecated alias of ErrorCodeOK. + ErrOk = ErrorCodeOK + // Deprecated: ErrGeneric is a deprecated alias of ErrorCodeGeneric. + ErrGeneric = ErrorCodeGeneric + // Deprecated: ErrNotFound is a deprecated alias of ErrorCodeNotFound. + ErrNotFound = ErrorCodeNotFound + // Deprecated: ErrExists is a deprecated alias of ErrorCodeExists. + ErrExists = ErrorCodeExists + // Deprecated: ErrAmbiguous is a deprecated alias of ErrorCodeAmbiguous. + ErrAmbiguous = ErrorCodeAmbiguous + // Deprecated: ErrAmbigious is a deprecated alias of ErrorCodeAmbiguous. + ErrAmbigious = ErrorCodeAmbiguous + // Deprecated: ErrBuffs is a deprecated alias of ErrorCodeBuffs. + ErrBuffs = ErrorCodeBuffs + // Deprecated: ErrUser is a deprecated alias of ErrorCodeUser. + ErrUser = ErrorCodeUser + // Deprecated: ErrBareRepo is a deprecated alias of ErrorCodeBareRepo. + ErrBareRepo = ErrorCodeBareRepo + // Deprecated: ErrUnbornBranch is a deprecated alias of ErrorCodeUnbornBranch. + ErrUnbornBranch = ErrorCodeUnbornBranch + // Deprecated: ErrUnmerged is a deprecated alias of ErrorCodeUnmerged. + ErrUnmerged = ErrorCodeUnmerged + // Deprecated: ErrNonFastForward is a deprecated alias of ErrorCodeNonFastForward. ErrNonFastForward = ErrorCodeNonFastForward - ErrInvalidSpec = ErrorCodeInvalidSpec - ErrConflict = ErrorCodeConflict - ErrLocked = ErrorCodeLocked - ErrModified = ErrorCodeModified - ErrAuth = ErrorCodeAuth - ErrCertificate = ErrorCodeCertificate - ErrApplied = ErrorCodeApplied - ErrPeel = ErrorCodePeel - ErrEOF = ErrorCodeEOF - ErrUncommitted = ErrorCodeUncommitted - ErrDirectory = ErrorCodeDirectory - ErrMergeConflict = ErrorCodeMergeConflict - ErrPassthrough = ErrorCodePassthrough - ErrIterOver = ErrorCodeIterOver - ErrApplyFail = ErrorCodeApplyFail + // Deprecated: ErrInvalidSpec is a deprecated alias of ErrorCodeInvalidSpec. + ErrInvalidSpec = ErrorCodeInvalidSpec + // Deprecated: ErrConflict is a deprecated alias of ErrorCodeConflict. + ErrConflict = ErrorCodeConflict + // Deprecated: ErrLocked is a deprecated alias of ErrorCodeLocked. + ErrLocked = ErrorCodeLocked + // Deprecated: ErrModified is a deprecated alias of ErrorCodeModified. + ErrModified = ErrorCodeModified + // Deprecated: ErrAuth is a deprecated alias of ErrorCodeAuth. + ErrAuth = ErrorCodeAuth + // Deprecated: ErrCertificate is a deprecated alias of ErrorCodeCertificate. + ErrCertificate = ErrorCodeCertificate + // Deprecated: ErrApplied is a deprecated alias of ErrorCodeApplied. + ErrApplied = ErrorCodeApplied + // Deprecated: ErrPeel is a deprecated alias of ErrorCodePeel. + ErrPeel = ErrorCodePeel + // Deprecated: ErrEOF is a deprecated alias of ErrorCodeEOF. + ErrEOF = ErrorCodeEOF + // Deprecated: ErrUncommitted is a deprecated alias of ErrorCodeUncommitted. + ErrUncommitted = ErrorCodeUncommitted + // Deprecated: ErrDirectory is a deprecated alias of ErrorCodeDirectory. + ErrDirectory = ErrorCodeDirectory + // Deprecated: ErrMergeConflict is a deprecated alias of ErrorCodeMergeConflict. + ErrMergeConflict = ErrorCodeMergeConflict + // Deprecated: ErrPassthrough is a deprecated alias of ErrorCodePassthrough. + ErrPassthrough = ErrorCodePassthrough + // Deprecated: ErrIterOver is a deprecated alias of ErrorCodeIterOver. + ErrIterOver = ErrorCodeIterOver + // Deprecated: ErrApplyFail is a deprecated alias of ErrorCodeApplyFail. + ErrApplyFail = ErrorCodeApplyFail ) // index.go -// IndexAddOpts is a deprecated alias of IndexAddOption. +// Deprecated: IndexAddOpts is a deprecated alias of IndexAddOption. type IndexAddOpts = IndexAddOption -// IndexStageOpts is a deprecated alias of IndexStageState. +// Deprecated: IndexStageOpts is a deprecated alias of IndexStageState. type IndexStageOpts = IndexStageState // submodule.go -// SubmoduleCbk is a deprecated alias of SubmoduleCallback. +// Deprecated: SubmoduleCbk is a deprecated alias of SubmoduleCallback. type SubmoduleCbk = SubmoduleCallback -// SubmoduleVisitor is not used. +// Deprecated: SubmoduleVisitor is not used. func SubmoduleVisitor(csub unsafe.Pointer, name *C.char, handle unsafe.Pointer) C.int { sub := &Submodule{(*C.git_submodule)(csub), nil} @@ -179,7 +235,7 @@ func SubmoduleVisitor(csub unsafe.Pointer, name *C.char, handle unsafe.Pointer) // tree.go -// CallbackGitTreeWalk is not used. +// Deprecated: CallbackGitTreeWalk is not used. func CallbackGitTreeWalk(_root *C.char, entry *C.git_tree_entry, ptr unsafe.Pointer) C.int { root := C.GoString(_root) diff --git a/remote.go b/remote.go index 08d8414..d954766 100644 --- a/remote.go +++ b/remote.go @@ -30,9 +30,9 @@ const ( // RemoteCreateOptions contains options for creating a remote type RemoteCreateOptions struct { - Name string - FetchSpec string - Flags RemoteCreateOptionsFlag + Name string + FetchSpec string + Flags RemoteCreateOptionsFlag } type TransferProgress struct {