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

crypto/internal/boring: Enabled documentation outdated since linux/arm64 support introduced #63920

Closed
c-kruse opened this issue Nov 2, 2023 · 1 comment
Labels
Documentation NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@c-kruse
Copy link
Contributor

c-kruse commented Nov 2, 2023

What version of Go are you using (go version)?

$ go version
go version go1.21.3 linux/amd64

Does this issue reproduce with the latest release?

Yes

What did you do?

go doc -all crypto/internal/boring  Enabled
package boring // import "crypto/internal/boring"

const Enabled = available
    Enabled reports whether BoringCrypto is available. When enabled is false,
    all functions in this package panic.

    BoringCrypto is only available on linux/amd64 systems.

What did you expect to see?

If I understand correctly this statement is no longer accurate since go 1.20 and https://go-review.googlesource.com/c/go/+/423362.

BoringCrypto is only available on linux/amd64 systems.

I would suggest BoringCrypto is only available on linux/amd64 and linux/arm64 systems.

Glad to push a CL amending this if someone could confirm my understanding.

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/539298 mentions this issue: boring: update documentation to include arm64

@mauri870 mauri870 changed the title cyrpto/internal/boring: Enabled documentation outdated since linux/arm64 support introduced crypto/internal/boring: Enabled documentation outdated since linux/arm64 support introduced Nov 2, 2023
@cherrymui cherrymui added the NeedsFix The path to resolution is known, but the work has not been done. label Nov 3, 2023
@cherrymui cherrymui added this to the Backlog milestone Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

3 participants