The repo contains a symlink (docs/index.rst -> ../README.rst), which has the effect that unpacking funcsigs on Windows requires admin rights.
Admin rights are required due to Windows not generally allowing (temporarily) dangling symlinks, as explained e.g. in this thread.
The reason why this matters is that distributing funcsigs as a packed bundle is common for systems depending on funcsigs, such as GoogleCloudPlatform/gsutil.
gsutil in turn is used in projects like Chrome and Dart.
Example issue: dart-lang/sdk#41729
I see a few ways to address this issue:
- Delete
docs/index.rst if it's not strictly needed and just points to README.rst anyway.
- Replace the symlink at
docs/index.rst with a file containing a short text message, telling the user to look at README.rst instead.
- Copy
README.rst to docs/index.rst.
The repo contains a symlink (docs/index.rst -> ../README.rst), which has the effect that unpacking
funcsigson Windows requires admin rights.Admin rights are required due to Windows not generally allowing (temporarily) dangling symlinks, as explained e.g. in this thread.
The reason why this matters is that distributing
funcsigsas a packed bundle is common for systems depending onfuncsigs, such as GoogleCloudPlatform/gsutil.gsutilin turn is used in projects like Chrome and Dart.Example issue: dart-lang/sdk#41729
I see a few ways to address this issue:
docs/index.rstif it's not strictly needed and just points toREADME.rstanyway.docs/index.rstwith a file containing a short text message, telling the user to look atREADME.rstinstead.README.rsttodocs/index.rst.