Skip to content

Commit 2d1a2bc

Browse files
committed
Update rename doc to mention symlink removal
In GCM 2.3 we dropped the symlinks. Let's update our docs on the issue to reflect this.
1 parent 8c430c9 commit 2d1a2bc

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/rename.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@ At the time, the actual exectuable name was not updated and continued to be
1111
`git-credential-manager-core`. As of [2.0.877][rename-ver], the executable has
1212
been renamed to `git-credential-manager`, matching the new project name.
1313

14+
---
15+
16+
:warning: **Update:** :warning:
17+
18+
As of [2.3.0][no-symlink-ver] the `git-credential-manager-core` symlinks have been
19+
removed.
20+
21+
If you have not updated your configuration you will see error messages similar to:
22+
23+
```console
24+
git: 'credential-manager-core' is not a git command. See 'git --help'.
25+
```
26+
27+
To fix your configuration, please follow the [instructions][instructions] below.
28+
29+
---
30+
1431
## Rename transition
1532

1633
If you continue to use the `git-credential-manager-core` executable name you may
@@ -35,7 +52,7 @@ name as soon as possible to prevent any issues in the future.
3552
### Git for Windows
3653

3754
If you are using GCM bundled with Git for Windows (recommended), you should make
38-
sure you have updated to at least version WINGIT_VERSION.
55+
sure you have updated to the latest version.
3956

4057
[Download the latest Git for Windows ⬇️][git-windows]
4158

@@ -164,3 +181,5 @@ or `manager` respectively.
164181
[gcm-latest]: https://aka.ms/gcm/latest
165182
[warnings]: #rename-transition
166183
[win-standalone-instr]: ../README.md#standalone-installation
184+
[instructions]: #how-to-update
185+
[no-symlink-ver]: https://github.com/git-ecosystem/git-credential-manager/releases/tag/v2.3.0

0 commit comments

Comments
 (0)