Skip to content

Commit 7634fc4

Browse files
committed
Clarify symlink handling on Windows
1 parent 2f0ccb2 commit 7634fc4

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/contributing.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,13 @@ dependencies (`evmone <https://github.com/ethereum/evmone/releases>`_,
9494
On macOS some of the testing scripts expect GNU coreutils to be installed.
9595
This can be easiest accomplished using Homebrew: ``brew install coreutils``.
9696

97+
On Windows systems make sure that you have a privilege to create symlinks,
98+
otherwise several tests may fail.
99+
Administrators should have that privilege, but you may also
100+
`grant it to other users <https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links#policy-management>`_
101+
or
102+
`enable Developer Mode <https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development>`_.
103+
97104
Running the Tests
98105
-----------------
99106

test/FilesystemUtils.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,6 @@ bool solidity::test::createSymlinkIfSupportedByFilesystem(
8181
BOOST_THROW_EXCEPTION(runtime_error(
8282
"Failed to create a symbolic link: \"" + _linkName.string() + "\""
8383
" -> " + _targetPath.string() + "\"."
84+
" " + symlinkCreationError.message() + "."
8485
));
8586
}

0 commit comments

Comments
 (0)