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

Numerous documentation tweaks and improvements #22505

Closed
wants to merge 12 commits into from

Conversation

mattcaswell
Copy link
Member

Updates to various README files - in part inspired by @jamuir's experience described in openssl/project#253

We move some of the "why QUIC" content into the guide and just provide a
summary in README-QUIC.md.

We also clarify how to use s_client with QUIC.
We also add reference for ALPN ids
Point users at the actual guide, and also explain about LD_LIBRARY_PATH
@mattcaswell mattcaswell added branch: master Merge to master branch approval: review pending This pull request needs review by a committer approval: otc review pending This pull request needs review by an OTC member labels Oct 25, 2023
@mattcaswell mattcaswell added this to the 3.2.0 milestone Oct 25, 2023
@t8m
Copy link
Member

t8m commented Oct 25, 2023

CI is relevant

@t8m t8m added triaged: documentation The issue/pr deals with documentation (errors) tests: exempted The PR is exempt from requirements for testing labels Oct 25, 2023
README-QUIC.md Outdated Show resolved Hide resolved
README-QUIC.md Outdated Show resolved Hide resolved
README-QUIC.md Outdated Show resolved Hide resolved
README-QUIC.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mattcaswell
Copy link
Member Author

All feedback addressed. Please take another look.

@mattcaswell mattcaswell reopened this Oct 25, 2023
README-QUIC.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mattcaswell
Copy link
Member Author

Latest round of feedback addressed. Please take another look.

@hlandau hlandau removed the approval: otc review pending This pull request needs review by an OTC member label Oct 26, 2023
@t8m t8m removed the approval: review pending This pull request needs review by a committer label Oct 26, 2023
@t8m t8m added approval: done This pull request has the required number of approvals branch: 3.2 Merge to openssl-3.2 labels Oct 26, 2023
@openssl-machine openssl-machine added approval: ready to merge The 24 hour grace period has passed, ready to merge and removed approval: done This pull request has the required number of approvals labels Oct 27, 2023
@openssl-machine
Copy link
Collaborator

This pull request is ready to merge

@hlandau
Copy link
Member

hlandau commented Oct 30, 2023

Merged to master and 3.2. Thank you.

@hlandau hlandau closed this Oct 30, 2023
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
We move some of the "why QUIC" content into the guide and just provide a
summary in README-QUIC.md.

We also clarify how to use s_client with QUIC.

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
We also add reference for ALPN ids

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Point users at the actual guide, and also explain about LD_LIBRARY_PATH

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)

(cherry picked from commit 0181a1a)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
We move some of the "why QUIC" content into the guide and just provide a
summary in README-QUIC.md.

We also clarify how to use s_client with QUIC.

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)

(cherry picked from commit 355fd1f)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)

(cherry picked from commit aefb529)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)

(cherry picked from commit 899c910)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
We also add reference for ALPN ids

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)

(cherry picked from commit f666599)
openssl-machine pushed a commit that referenced this pull request Oct 30, 2023
Point users at the actual guide, and also explain about LD_LIBRARY_PATH

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #22505)

(cherry picked from commit ada33e9)
wanghao75 pushed a commit to openeuler-mirror/openssl that referenced this pull request Nov 4, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl/openssl#22505)

Signed-off-by: fly2x <fly2x@hitls.org>
wanghao75 pushed a commit to openeuler-mirror/openssl that referenced this pull request Nov 4, 2023
We move some of the "why QUIC" content into the guide and just provide a
summary in README-QUIC.md.

We also clarify how to use s_client with QUIC.

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl/openssl#22505)

Signed-off-by: fly2x <fly2x@hitls.org>
wanghao75 pushed a commit to openeuler-mirror/openssl that referenced this pull request Nov 4, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl/openssl#22505)

Signed-off-by: fly2x <fly2x@hitls.org>
wanghao75 pushed a commit to openeuler-mirror/openssl that referenced this pull request Nov 4, 2023
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl/openssl#22505)

Signed-off-by: fly2x <fly2x@hitls.org>
wanghao75 pushed a commit to openeuler-mirror/openssl that referenced this pull request Nov 4, 2023
We also add reference for ALPN ids

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl/openssl#22505)

Signed-off-by: fly2x <fly2x@hitls.org>
wanghao75 pushed a commit to openeuler-mirror/openssl that referenced this pull request Nov 4, 2023
Point users at the actual guide, and also explain about LD_LIBRARY_PATH

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl/openssl#22505)

Signed-off-by: fly2x <fly2x@hitls.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approval: ready to merge The 24 hour grace period has passed, ready to merge branch: master Merge to master branch branch: 3.2 Merge to openssl-3.2 tests: exempted The PR is exempt from requirements for testing triaged: documentation The issue/pr deals with documentation (errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants