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

Jump to bottom

net/netip: inconsistent terminology for IPv4-mapped IPv6 addresses in documentation #51834

Closed
favonia opened this issue Mar 21, 2022 · 5 comments
Closed

net/netip: inconsistent terminology for IPv4-mapped IPv6 addresses in documentation #51834

favonia opened this issue Mar 21, 2022 · 5 comments
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Backlog

Comments

@favonia
Copy link
Contributor

favonia commented Mar 21, 2022

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

$ go version
go version go1.18 linux/amd64

Does this issue reproduce with the latest release?

Yes

What did you do?

Read https://pkg.go.dev/net/netip@go1.18

What did you expect to see?

A consistent name for IPv4 addresses wrapped in IPv6 addresses.

What did you see instead?

Many different names or phrases have appeared in the documentation, and they seem to refer to the same thing:

  • IPv4-mapped IPv6 address
  • IP4-mapped IPv6 address
  • IPv6-mapped IPv4 address
  • v6-mapped form
  • v6-mapped IPv6 address
  • v6-mapped IPv4 IP
@favonia favonia changed the title net/netip: inconsistent names for IPv4-mapped IPv6 addresses in documentation net/netip: inconsistent terminology for IPv4-mapped IPv6 addresses in documentation Mar 21, 2022
@ianlancetaylor ianlancetaylor added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Mar 21, 2022
@ianlancetaylor ianlancetaylor added this to the Backlog milestone Mar 21, 2022
@ianlancetaylor
Copy link
Contributor

CC @bradfitz @josharian

@gopherbot
Copy link

Change https://go.dev/cl/394078 mentions this issue: net/netip: inconsistent terminology for IPv4-mapped IPv6 addresses in documentation

@favonia
Copy link
Contributor Author

favonia commented Mar 28, 2022

This seems to be fixed by #51950.

@favonia favonia closed this as completed Mar 28, 2022
@favonia
Copy link
Contributor Author

favonia commented Mar 30, 2022

@hopehook If you are still interested, I think #51950 did not fix one IP4 in the comments to IPv4. However, at this point, it's already much better than what it was.

@hopehook
Copy link
Member

@favonia Thanks.

gopherbot pushed a commit that referenced this issue Apr 2, 2022
@hopehook @odeke-em
net/netip: improve documentation terminology for IPv4-mapped IPv6 add…
153c18a 
…resses

Updates #51834

Change-Id: I07a43457e2e328b51fea8131f7d6d5a4f1de4dc5
Reviewed-on: https://go-review.googlesource.com/c/go/+/394078
Trust: Damien Neil <dneil@google.com>
Run-TryBot: Damien Neil <dneil@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Damien Neil <dneil@google.com>
Trust: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Emmanuel Odeke <emmanuel@orijtech.com>
@golang golang locked and limited conversation to collaborators Mar 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
4 participants
@favonia @ianlancetaylor @hopehook @gopherbot