From 3401b89cf017a99031f40be8d2ccadb4b66b7fad Mon Sep 17 00:00:00 2001 From: Arlo Siemsen Date: Wed, 20 Sep 2023 00:48:55 -0500 Subject: [PATCH] fix: typos in registry-authentication documentation --- src/doc/src/reference/credential-provider-protocol.md | 6 +++--- src/doc/src/reference/registry-authentication.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/doc/src/reference/credential-provider-protocol.md b/src/doc/src/reference/credential-provider-protocol.md index b577493ee76..31006abee00 100644 --- a/src/doc/src/reference/credential-provider-protocol.md +++ b/src/doc/src/reference/credential-provider-protocol.md @@ -60,7 +60,7 @@ Not a message by itself. Included in all messages sent by Cargo as the `registry } ``` -If the `token` field is set, than the credential provider should use the token provided. If +If the `token` field is set, then the credential provider should use the token provided. If the `token` is not set, then the credential provider should prompt the user for a token. In addition to the arguments that may be passed to the credential provider in @@ -134,7 +134,7 @@ in the `args` field after any args from Cargo configuration. The `token` will be sent to the registry as the value of the `Authorization` HTTP header. `operation_independent` indicates whether the token can be cached across different -operations (such as publishing or fetching). In general this should be `true` unless +operations (such as publishing or fetching). In general, this should be `true` unless the provider wants to generate tokens that are scoped to specific operations. ### Login success response @@ -166,7 +166,7 @@ the provider wants to generate tokens that are scoped to specific operations. }} ``` Sent if the credential provider is designed -to only handle specific registry URLs, and the given URL +to only handle specific registry URLs and the given URL is not supported. Cargo will attempt another provider if available. diff --git a/src/doc/src/reference/registry-authentication.md b/src/doc/src/reference/registry-authentication.md index 7da33c590e6..9f8f7e9796b 100644 --- a/src/doc/src/reference/registry-authentication.md +++ b/src/doc/src/reference/registry-authentication.md @@ -1,11 +1,11 @@ # Registry Authentication -Cargo authenticates to registries with through credential providers. These +Cargo authenticates to registries with credential providers. These credential providers are external executables or built-in providers that Cargo uses to store and retrieve credentials. Using alternative registries with authentication *requires* a credential provider to be configured -to avoid unknowningly storing unecrypted credentials on disk. For historical reasons, public -(non-authenticated) registres do not require credential provider configuration and the `cargo:token` +to avoid unknowingly storing unencrypted credentials on disk. For historical reasons, public +(non-authenticated) registries do not require credential provider configuration, and the `cargo:token` provider is used if no providers are configured. Cargo also includes platform-specific providers that use the operating system to securely store @@ -106,6 +106,6 @@ In the config, add to (or create) `registry.global-credential-providers`: global-credential-providers = ["cargo:token", "cargo-credential-1password --email you@example.com"] ``` -The values in `global-credential-providers` are split on spaces to into path and command-line arguments. To +The values in `global-credential-providers` are split on spaces into path and command-line arguments. To define a global credential provider where the path or arguments contain spaces, use the [`[credential-alias]` table](config.md#credential-alias).