From 8c466d15811d3ab348cda426f01fba65957d46a2 Mon Sep 17 00:00:00 2001 From: Curtis Vogt Date: Tue, 29 Aug 2017 18:42:52 -0500 Subject: [PATCH] Add comments for CredentialPayload allow fields --- base/libgit2/types.jl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/base/libgit2/types.jl b/base/libgit2/types.jl index 15be95a02f583..22de29a1ac825 100644 --- a/base/libgit2/types.jl +++ b/base/libgit2/types.jl @@ -1147,15 +1147,15 @@ end """ LibGit2.CredentialPayload -Retains state between multiple calls to the credential callback. A single -`CredentialPayload` instance will be used when authentication fails for a URL but different -instances will be used when the URL has changed. +Retains the state between multiple calls to the credential callback for the same URL. +A `CredentialPayload` instance is expected to be `reset!` whenever it will be used with a +different URL. """ mutable struct CredentialPayload <: Payload explicit::Nullable{AbstractCredentials} cache::Nullable{CachedCredentials} - allow_ssh_agent::Bool - allow_prompt::Bool + allow_ssh_agent::Bool # Allow the use of the SSH agent to get credentials + allow_prompt::Bool # Allow prompting the user for credentials # Ephemeral state fields credential::Nullable{AbstractCredentials}