Skip to content

symlink requires admin rights on Windows #40

Description

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:

  1. Delete docs/index.rst if it's not strictly needed and just points to README.rst anyway.
  2. Replace the symlink at docs/index.rst with a file containing a short text message, telling the user to look at README.rst instead.
  3. Copy README.rst to docs/index.rst.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions