Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

symlink: docs need an update #58

Open
kolyshkin opened this issue Dec 10, 2020 · 1 comment
Open

symlink: docs need an update #58

kolyshkin opened this issue Dec 10, 2020 · 1 comment

Comments

@kolyshkin
Copy link
Collaborator

kolyshkin commented Dec 10, 2020

moby/sys/symlink documentation (as seen at e.g. https://pkg.go.dev/github.com/moby/sys/symlink) needs a few updates:

  1. Package docs say the package "implements EvalSymlinksInScope ..." while in fact it implements FollowSymlinkInScope.

  2. Doc for FollowSymlinksInScope says it "is a wrapper around evalSymlinksInScope" which is not an adequate description as a user knows nothing about evalSymlinksInScope.

@kolyshkin
Copy link
Collaborator Author

Also, this is unrelated, but from the first glance it seems that golang's filepath.EvalSymlinks now support \\?\-like paths on Windows, which makes moby/sys/symlink.EvalSymlink obsoleted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant