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.

Sign up for GitHub

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

doc: happy-eyeballs text is awkward #7433

Closed
jsoref opened this issue Jul 19, 2021 · 0 comments
Closed

doc: happy-eyeballs text is awkward #7433

jsoref opened this issue Jul 19, 2021 · 0 comments
Labels
documentation

Comments

@jsoref
Copy link
Contributor

jsoref commented Jul 19, 2021

curl/docs/cmdline-opts/happy-eyeballs-timeout-ms.d

Lines 8 to 9 in f538bc5

addresses for dual-stack hosts, preferring IPv6 first for the number of
milliseconds. If the IPv6 address cannot be connected to within that time then

... preferring IPv6 first for the number of milliseconds ...

is awkward.

I suspect it could be improved by changing preferring...first to giving IPv6 a head-start of ....

I'm familiar w/ happy-eyeballs technically, but the text here is confusing.

curl/docs/cmdline-opts/happy-eyeballs-timeout-ms.d

Line 7 in f538bc5

Happy eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6

Beyond that, Happy Eyeballs should probably be capitalized as such. c.f.

curl/docs/cmdline-opts/happy-eyeballs-timeout-ms.d

Line 13 in f538bc5

The range of suggested useful values is limited. Happy Eyeballs RFC 6555 says

Unless there's a house style I haven't properly identified.

Possible text:

Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6 addresses for dual-stack hosts, giving IPv6 a head-start of the specified number of milliseconds.
bagder added a commit that referenced this issue Aug 8, 2021
@bagder
happy-eyeballs-timeout-ms.d: polish the wording
43e95cd 
Reported-by: Josh Soref
Closes #7433
@bagder bagder mentioned this issue Aug 8, 2021
Closed
@bagder bagder closed this as completed in a2e29f0 Aug 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

happy-eyeballs-timeout-ms.d: polish the wording curl/curl
2 participants
@bagder @jsoref