Skip to content

net/http: explain when HTTP/2 is disabled #64708

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jsha
Copy link

@jsha jsha commented Dec 14, 2023

Previously the docs simply said HTTP/2 is disabled for "simple configurations." Instead, say which specific configurations disable HTTP/2.

Also, the sentence "... Transport and Server both automatically enable HTTP/2 support for simple configurations" was redundant with the sentence at the start of the section:

"Starting with Go 1.6, the http package has transparent support for the HTTP/2 protocol when using HTTPS."

Several fields of Transport can disable HTTP/2 support, but only one (TLSClientConfig) was documented to do so. Add consistent documentation to each of them.

Background:

For letsencrypt/boulder, we're adding DoH support to talk to Unbound. Unbound requires HTTP/2. We configured a custom root certificate since our internal Unbound uses an internal PKI. We were puzzled to get errors and had trouble tracking down why HTTP/2 wasn't happening, despite checking the docs several times. Hopefully this change can make things clearer for future readers.

Previously the docs simply said HTTP/2 is disabled for "simple
configurations." Instead, say which specific configurations disable
HTTP/2.

Also, the sentence "... Transport and Server both automatically enable
HTTP/2 support for simple configurations" was redundant with the
sentence at the start of the section:

"Starting with Go 1.6, the http package has transparent support for the
HTTP/2 protocol when using HTTPS."

Several fields of Transport can disable HTTP/2 support, but only
one (TLSClientConfig) was documented to do so. Add consistent
documentation to each of them.
@jsha jsha changed the title net/htp: explain when HTTP/2 is disabled net/http: explain when HTTP/2 is disabled Dec 14, 2023
@gopherbot
Copy link
Contributor

This PR (HEAD: 9bf970f) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/549519.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/549519.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Emmanuel Odeke:

Patch Set 1: Run-TryBot+1


Please don’t reply on this GitHub thread. Visit golang.org/cl/549519.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/549519.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1: TryBot-Result+1

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/549519.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Damien Neil:

Patch Set 1: Code-Review+2


Please don’t reply on this GitHub thread. Visit golang.org/cl/549519.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Ian Lance Taylor:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/549519.
After addressing review feedback, remember to publish your drafts!

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

Successfully merging this pull request may close these issues.

2 participants