[v3] Mention that password could be a personal access token.

Commit Message

M Hickford Nov. 8, 2022, 1:01 p.m. UTC

From: M Hickford <[e-mail]>

Git asks for a "password", but the user might use a
personal access token or OAuth access token instead.

Example:

    Password for 'https://[e-mail]':

Signed-off-by: M Hickford <[e-mail]>
---
    Mention that password could be a personal access token.
    
    These days, the 'password' for a software forge might be personal access
    token or OAuth access token.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1396%2Fhickford%2Fmore-about-credentials-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1396/hickford/more-about-credentials-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1396

Range-diff vs v2:

 1:  0bb69988ad7 ! 1:  7be4a631aca Mention that password could be a personal access token.
     @@ Metadata
       ## Commit message ##
          Mention that password could be a personal access token.
      
     -    These days, the 'password' for a software forge might be personal access
     -    token or OAuth access token. These are popular, so worth clarifying that
     -    Git treats them just the same.
     +    Git asks for a "password", but the user might use a
     +    personal access token or OAuth access token instead.
     +
     +    Example:
     +
     +        Password for 'https://[e-mail]':
      
          Signed-off-by: M Hickford <[e-mail]>
      
       ## Documentation/gitcredentials.txt ##
     -@@ Documentation/gitcredentials.txt: in order to access a remote repository over HTTP. This manual describes
     - the mechanisms Git uses to request these credentials, as well as some
     - features to avoid inputting these credentials repeatedly.
     +@@ Documentation/gitcredentials.txt: DESCRIPTION
     + 
     + Git will sometimes need credentials from the user in order to perform
     + operations; for example, it may need to ask for a username and password
     +-in order to access a remote repository over HTTP. This manual describes
     +-the mechanisms Git uses to request these credentials, as well as some
     +-features to avoid inputting these credentials repeatedly.
     ++in order to access a remote repository over HTTP. Some remotes accept
     ++a personal access token or OAuth access token as a password. This
     ++manual describes the mechanisms Git uses to request these credentials,
     ++as well as some features to avoid inputting these credentials repeatedly.
       
     -+Some repositories accept multiple passwords, including personal access
     -+tokens and OAuth access tokens. Git handles all of these the same.
     -+
       REQUESTING CREDENTIALS
       ----------------------
     - 


 Documentation/gitcredentials.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)


base-commit: 3b08839926fcc7cc48cf4c759737c1a71af430c1

Comments

Taylor Blau Nov. 8, 2022, 9:48 p.m. UTC | #1

On Tue, Nov 08, 2022 at 01:01:27PM +0000, M Hickford via GitGitGadget wrote:
> From: M Hickford <[e-mail]>
>
> Git asks for a "password", but the user might use a
> personal access token or OAuth access token instead.

Looks good to me. The only minor issue I noticed was that the commit
message should have been prefixed with an area but wasn't.

I changed it to the following when queueing:

    Documentation/gitcredentials.txt: mention password alternatives

Thank you for your work. Let's start merging this one down.

Thanks,
Taylor

Patch

diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index 80517b4eb2c..6df50e8a144 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -17,9 +17,10 @@  DESCRIPTION
 
 Git will sometimes need credentials from the user in order to perform
 operations; for example, it may need to ask for a username and password
-in order to access a remote repository over HTTP. This manual describes
-the mechanisms Git uses to request these credentials, as well as some
-features to avoid inputting these credentials repeatedly.
+in order to access a remote repository over HTTP. Some remotes accept
+a personal access token or OAuth access token as a password. This
+manual describes the mechanisms Git uses to request these credentials,
+as well as some features to avoid inputting these credentials repeatedly.
 
 REQUESTING CREDENTIALS
 ----------------------