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

os, syscall: changes to os.Err* and syscall.Errno not mentioned in release notes and syscall package docs #33436

Closed
bcmills opened this issue Aug 2, 2019 · 2 comments
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Milestone

Comments

@bcmills
Copy link
Member

bcmills commented Aug 2, 2019

The changes made to the os and syscall package for #30322 are not mentioned in the Go 1.13 release notes, nor in the documentation for syscall.Errno or the syscall package.

Because users in general cannot redefine the error behavior of the errors defined by their dependencies, as a user I would not expect syscall.Errno errors to be defined as equivalent to errors defined in the higher-level os package. As noted in #32463 and #33411, the fact that they are has significant, non-trivial implications.

If errors.Is is now recommended and supported for checking the properties of syscall.Errno errors, the syscall.Errno documentation and the Go 1.13 release notes should be updated to mention that.

CC @neild @jba @mpvl @rsc @andybons @ianlancetaylor

@bcmills bcmills added Documentation NeedsFix The path to resolution is known, but the work has not been done. release-blocker labels Aug 2, 2019
@bcmills bcmills added this to the Go1.13 milestone Aug 2, 2019
@ianlancetaylor
Copy link
Contributor

Ping @jba Want to write something about this as you've written other error-related docs?

@gopherbot
Copy link

Change https://golang.org/cl/191337 mentions this issue: syscall: document relationship among Errno, errors.Is and os.Err*

t4n6a1ka pushed a commit to t4n6a1ka/go that referenced this issue Sep 5, 2019
- Add doc to syscall.Errno (and syscall.ErrorString for plan9).

- Mention under `syscall` in release notes.

Fixes golang#33436.

Change-Id: I032ffebaa76ed67eb9d748e7645ca73f26144ea0
Reviewed-on: https://go-review.googlesource.com/c/go/+/191337
Reviewed-by: Ian Lance Taylor <iant@golang.org>
@golang golang locked and limited conversation to collaborators Aug 21, 2020
@rsc rsc unassigned jba Jun 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Projects
None yet
Development

No branches or pull requests

4 participants