Skip to content

Commit d4396a2

Browse files
committed
Switch to reference style links
1 parent f5ea6fc commit d4396a2

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

docs/faq.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Please follow these steps to diagnose or resolve the problem:
1010

1111
1. If you are experiencing a Git authentication problem using an editor, IDE or other tool, try performing the same operation from the terminal. Does this still fail? If the operation succeeds from the terminal please include details of the specific tool and version in any issue reports.
1212

13-
1. Set the environment variable `GCM_TRACE` and run the Git operation again. Find instructions [here](environment.md#GCM_TRACE).
13+
1. Set the environment variable `GCM_TRACE` and run the Git operation again. Find instructions in the [environment doc][env-trace].
1414

15-
1. If all else fails, create an issue [here](https://github.com/GitCredentialManager/git-credential-manager/issues/create), making sure to include the trace log.
15+
1. If all else fails, create an issue [here][create-issue], making sure to include the trace log.
1616

1717
### Q: I got an error saying unsecure HTTP is not supported
1818

@@ -22,15 +22,15 @@ Please make sure your remote URLs use "https://" rather than "http://".
2222

2323
### Q: I got an authentication error and I am behind a network proxy
2424

25-
You probably need to configure Git and GCM to use a proxy. Please see detailed information [here](https://aka.ms/gcm/httpproxy).
25+
You probably need to configure Git and GCM to use a proxy. Please see detailed information in the [netconfig doc][netconfig-http-proxy].
2626

2727
### Q: I'm getting errors about picking a credential store on Linux
2828

29-
On Linux you must [select and configure a credential store](https://aka.ms/gcm/credstores), as due to the varied nature of distributions and installations, we cannot guarantee a suitable storage solution is available.
29+
On Linux you must [select and configure a credential store][credstores], as due to the varied nature of distributions and installations, we cannot guarantee a suitable storage solution is available.
3030

3131
## About the project
3232

33-
### Q: How does this project relate to [Git Credential Manager for Windows](https://github.com/Microsoft/Git-Credential-Manager-for-Windows) and [Git Credential Manager for Mac and Linux](https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux)?
33+
### Q: How does this project relate to [Git Credential Manager for Windows][gcm-windows] and [Git Credential Manager for Mac and Linux][gcm-linux]?
3434

3535
Git Credential Manager for Windows (GCM Windows) is a .NET Framework-based Git credential helper which runs on Windows.
3636
Likewise the Git Credential Manager for Mac and Linux (Java GCM) is a Java-based Git credential helper that runs only on macOS and Linux. Although both of these projects aim to solve the same problem (providing seamless multi-factor HTTPS authentication with Git), they are based on different codebases and languages which is becoming hard to manage to ensure feature parity.
@@ -43,17 +43,17 @@ Yes. Git Credential Manager for Windows (GCM Windows) is no longer receiving upd
4343

4444
### Q: Does this mean the Java-based GCM for Mac/Linux is deprecated?
4545

46-
Yes. Usage of Git Credential Manager for Mac and Linux (Java GCM) should be replaced with GCM or SSH keys. If you wish to install GCM on macOS or Linux, please follow the [download and installation instructions](../README.md#download-and-install).
46+
Yes. Usage of Git Credential Manager for Mac and Linux (Java GCM) should be replaced with GCM or SSH keys. If you wish to install GCM on macOS or Linux, please follow the [download and installation instructions][download-and-install].
4747

4848
### Q: I want to use SSH
4949

5050
GCM is only useful for HTTP(S)-based remotes. Git supports SSH out-of-the box so you shouldn't need to install anything else.
5151

5252
To use SSH please follow the below links:
5353

54-
- [Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops)
55-
- [GitHub](https://help.github.com/en/articles/connecting-to-github-with-ssh)
56-
- [Bitbucket](https://confluence.atlassian.com/bitbucket/ssh-keys-935365775.html)
54+
- [Azure DevOps][azure-ssh]
55+
- [GitHub][github-ssh]
56+
- [Bitbucket][bitbucket-ssh]
5757

5858
### Q: Are HTTP(S) remotes preferred over SSH?
5959

@@ -85,7 +85,7 @@ In the older GCM for Windows product, the solution to the same problem was a "ha
8585

8686
### Why does GCM take so long at startup the first time?
8787

88-
GCM will [autodetect](autodetect.md) what kind of Git host it's talking to. GitHub, Bitbucket, and Azure DevOps each have their own form(s) of authentication, plus there's a "generic" username and password option.
88+
GCM will [autodetect][autodetect] what kind of Git host it's talking to. GitHub, Bitbucket, and Azure DevOps each have their own form(s) of authentication, plus there's a "generic" username and password option.
8989

9090
For the hosted versions of these services, GCM can guess from the URL which service to use. But for on-premises versions which would have unique URLs, GCM will probe with a network call. GCM caches the results of the probe, so it should be faster on the second and later invocations.
9191

@@ -100,24 +100,24 @@ Generic|`git config --global credential.https://example.com.provider generic`
100100

101101
### How do I fix "Could not create SSL/TLS secure channel" errors on Windows 7?
102102

103-
This likely indicates that you don't have newer TLS versions available. Please [follow Microsoft's guide](https://support.microsoft.com/topic/update-to-enable-tls-1-1-and-tls-1-2-as-default-secure-protocols-in-winhttp-in-windows-c4bd73d2-31d7-761e-0178-11268bb10392) for enabling TLS 1.1 and 1.2 on your machine, specifically the **SChannel** instructions. You'll need to be on at least Windows 7 SP1, and in the end you should have a `TLS 1.2` key with `DisabledByDefault` set to `0`. You can also read [more from Microsoft](https://docs.microsoft.com/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/dn786418(v=ws.11)#tls-12) on this change.
103+
This likely indicates that you don't have newer TLS versions available. Please [follow Microsoft's guide][enable-windows-ssh] for enabling TLS 1.1 and 1.2 on your machine, specifically the **SChannel** instructions. You'll need to be on at least Windows 7 SP1, and in the end you should have a `TLS 1.2` key with `DisabledByDefault` set to `0`. You can also read [more from Microsoft][windows-server-tls] on this change.
104104

105105
### How do I use GCM with Windows Subsystem for Linux (WSL)?
106106

107-
Follow the instructions in [our WSL guide](wsl.md) carefully. Especially note the need to run `git config --global credential.https://dev.azure.com.useHttpPath true` _within_ WSL if you're using Azure DevOps.
107+
Follow the instructions in [our WSL guide][wsl] carefully. Especially note the need to run `git config --global credential.https://dev.azure.com.useHttpPath true` _within_ WSL if you're using Azure DevOps.
108108

109109
### Does GCM work with multiple users? If so, how?
110110

111-
That's a fairly complicated question to answer, but in short, yes. See [our document on multiple users](multiple-users.md) for details.
111+
That's a fairly complicated question to answer, but in short, yes. See [our document on multiple users][multiple-users] for details.
112112

113113
### How can I disable GUI dialogs and prompts?
114114

115115
There are various environment variables and configuration options available to
116116
customize how GCM will prompt you (or not) for input. Please see the following:
117117

118-
- [`GCM_INTERACTIVE`](environment.md#GCM_INTERACTIVE) / [`credential.interactive`](configuration.md#credentialinteractive)
119-
- [`GCM_GUI_PROMPT`](environment.md#GCM_GUI_PROMPT) / [`credential.guiPrompt`](configuration.md#credentialguiprompt)
120-
- [`GIT_TERMINAL_PROMPT`](https://git-scm.com/docs/git#Documentation/git.txt-codeGITTERMINALPROMPTcode) (note this is a _Git setting_ that will affect Git as well as GCM)
118+
- [`GCM_INTERACTIVE`][env-interactive] / [`credential.interactive`][config-interactive]
119+
- [`GCM_GUI_PROMPT`][env-gui-prompt] / [`credential.guiPrompt`][config-gui-prompt]
120+
- [`GIT_TERMINAL_PROMPT`][git-term-prompt] (note this is a _Git setting_ that will affect Git as well as GCM)
121121

122122
### How can I extend GUI prompts/integrate prompts with my application?
123123

@@ -164,3 +164,24 @@ There are some scenarios (e.g. updated scopes) for which you will need to manual
164164

165165
![Notifaction of successful revocation](./img/gitlab-oauthapp-revoked.png)
166166
5. Re-authorizing the application with the new scope (GCM should automatically initiate this flow for you next time access is requested).
167+
168+
[autodetect]: autodetect.md
169+
[azure-ssh]: https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops
170+
[bitbucket-ssh]: https://confluence.atlassian.com/bitbucket/ssh-keys-935365775.html
171+
[config-gui-prompt]: configuration.md#credentialguiprompt
172+
[config-interactive]: configuration.md#credentialinteractive
173+
[create-issue]: https://github.com/GitCredentialManager/git-credential-manager/issues/create
174+
[credstores]: credstores.md
175+
[download-and-install]: ../README.md#download-and-install
176+
[enable-windows-ssh]: https://support.microsoft.com/topic/update-to-enable-tls-1-1-and-tls-1-2-as-default-secure-protocols-in-winhttp-in-windows-c4bd73d2-31d7-761e-0178-11268bb10392
177+
[env-gui-prompt]: environment.md#GCM_GUI_PROMPT
178+
[env-interactive]: environment.md#GCM_INTERACTIVE
179+
[env-trace]: environment.md#GCM_TRACE
180+
[gcm-linux]: https://github.com/Microsoft/Git-Credential-Manager-for-Mac-and-Linux
181+
[gcm-windows]: https://github.com/Microsoft/Git-Credential-Manager-for-Windows
182+
[git-term-prompt]: https://git-scm.com/docs/git#Documentation/git.txt-codeGITTERMINALPROMPTcode
183+
[github-ssh]: https://help.github.com/en/articles/connecting-to-github-with-ssh
184+
[multiple-users]: multiple-users.md
185+
[netconfig-http-proxy]: netconfig.md#http-proxy
186+
[windows-server-tls]: https://docs.microsoft.com/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/dn786418(v=ws.11)#tls-12
187+
[wsl]: wsl.md

0 commit comments

Comments
 (0)