What happens when I clone a repository with symlinks on Windows?

by

Since version 1.5.3 of the native Git client git clone and git init will probe the target file system for symlink support and set the local repository configuration for core.symlinks accordingly, i.e. to false for FAT or NTFS. This makes symlinks created and committed e.g. under Linux appear as plain text files that contain the link text under Windows (see the git config documentation on core.symlinks for details).

Since Git for Windows version 2.10.2 the installer has an explicit option to enable symbolic link support.

In older versions of Git for Windows you can manually set core.symlinks to true which enabled Git to create symbolic links under the following constraints:

  • Symbolic links are only available on Windows Vista and later.
  • Symbolic links will only work on NTFS, not on FAT.
  • You need to be an admin and / or have the SeCreateSymbolicLinkPrivilege privilege.
  • Symbolic links on remote filesystems are disabled by default.
  • Windows’ symbolic links are typed.
  • Many programs do not understand symbolic links (that includes older version of Windows Explorer).

More details are available in the Git for Windows wiki.

In older versions of Git for Windows manually setting core.symlinks manually to true after cloning and reset your working tree, you would get error messages similar to

$ git reset --hard HEAD
error: unable to create symlink directory (Function not implemented)
error: unable to create symlink linux-links/this_is_a_symbolic_link_to_file (Function not implemented)
fatal: Could not reset index file to revision 'HEAD'.

As a side note, the JGit client did not probe the target file system for symlink support until its version 3.3, so the core.symlinks setting was falling back to whatever the system / global Git configuration was. Starting with version 3.3 JGit probes for symlink support but seems to be too conservative, setting core.symlinks = false in some cases where symlinks would be in fact supported.

You can checkout https://github.com/sschuberth/git-playground which contains a bunch of links created on Linux for testing.

More Related Contents:

  1. Git symbolic links in Windows
  2. Ignoring directories in Git repositories on Windows
  3. Unable to resolve “unable to get local issuer certificate” using git on Windows with self-signed certificate
  4. Git on Windows: How do you set up a mergetool?
  5. Setup a Git server with msysgit on Windows [closed]
  6. MSysGit vs. Git for Windows
  7. MSysGit and ssh config. missing
  8. Remove credentials from Git
  9. Git – How to use .netrc file on Windows to save user and password
  10. How can I set up an editor to work with Git on Windows?
  11. Git on Windows, “Out of memory – malloc failed”
  12. Threadscope’s gettext.sh file interferes with git on Windows
  13. Changing .gitconfig location on Windows
  14. How to force consistent line endings in Git commits with cross-platform compatibility
  15. How to prevent that the password to decrypt the private key has to be entered every time when using Git Bash on Windows?
  16. How do I configure Git to trust certificates from the Windows Certificate Store?
  17. How to upgrade Git on Windows to the latest version
  18. Git Bash and Pageant are not using keys
  19. Disable auto-completion of remote branches in Git Bash?
  20. ‘ssh-keygen’ is not recognized as an internal or external command
  21. Error “‘git’ is not recognized as an internal or external command”
  22. Git file permissions on Windows
  23. Git rename from index.lock to index failed
  24. What is the difference between NTFS Junction Points and Symbolic Links?
  25. Why is “MINGW64” appearing on my Git bash?
  26. sh.exe.stackdump when use git stash
  27. How to update git version from GitHub Desktop on Windows
  28. Git serve: I would like it that simple
  29. git – Server host key not cached
  30. How to replace crlf with lf in a single file

Leave a Comment