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

Move the description of the core types into their own pages #19842

Closed
wants to merge 6 commits into from
Closed

Move the description of the core types into their own pages #19842

wants to merge 6 commits into from

Conversation

levitte
Copy link
Member

@levitte levitte commented Dec 5, 2022

This expands on some of the core type descriptions, and also makes it
easier to find the documentation for each type, at least on Unix, with
a simple call like "man OSSL_ALGORITHM".

@levitte levitte added approval: otc review pending This pull request needs review by an OTC member approval: review pending This pull request needs review by a committer branch: 3.0 Merge to openssl-3.0 branch branch: 3.1 Merge to openssl-3.1 branch: master Merge to master branch tests: exempted The PR is exempt from requirements for testing triaged: documentation The issue/pr deals with documentation (errors) labels Dec 5, 2022
@levitte levitte self-assigned this Dec 5, 2022
@levitte levitte requested review from a team December 5, 2022 15:52
@levitte
Copy link
Member Author

levitte commented Dec 5, 2022

This was initiated by the discussion in #19827.

@baentsch, would you mind looking at this and see if this corresponds
to what you and I have discussed?

@levitte
Move the description of the core types into their own pages
d944985 
This expands on some of the core type descriptions, and also makes it
easier to find the documentation for each type, at least on Unix, with
a simple call like "man OSSL_ALGORITHM".
@levitte
Replace some boldened types with a corresponding man page link
4487ed6 
The types OSSL_DISPATCH, OSSL_ITEM, OSSL_ALGORITHM, OSSL_PARAM,
OSSL_CALLBACK, and OSSL_PASSPHRASE_CALLBACK are described in their own
manual page, so we change every mention of them to links to those pages.
baentsch
baentsch approved these changes Dec 5, 2022
View reviewed changes
Copy link
Contributor

@baentsch baentsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Except some nits, LGTM. man OSSL_ALGORITHM is a great help: Thanks (on behalf of all people reading man pages :)!

slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man3/EVP_KDF.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man3/EVP_KDF.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man3/EVP_KEYMGMT.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man3/EVP_MAC.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man3/EVP_MAC.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man3/EVP_MAC.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man7/provider-kem.pod Outdated Show resolved Hide resolved
slontis
slontis reviewed Dec 5, 2022
View reviewed changes
doc/man3/OSSL_ALGORITHM.pod Outdated Show resolved Hide resolved
@t8m t8m removed the approval: otc review pending This pull request needs review by an OTC member label Dec 6, 2022
@hlandau hlandau added approval: done This pull request has the required number of approvals and removed approval: review pending This pull request needs review by a committer labels Dec 6, 2022
@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 Dec 7, 2022
@openssl-machine
Copy link
Collaborator

This pull request is ready to merge

openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Better sorting of util/other.syms
9dabb55 
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #19842)
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Move the description of the core types into their own pages
801e54d 
This expands on some of the core type descriptions, and also makes it
easier to find the documentation for each type, at least on Unix, with
a simple call like "man OSSL_ALGORITHM".

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #19842)
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Replace some boldened types with a corresponding man page link
318a9df 
The types OSSL_DISPATCH, OSSL_ITEM, OSSL_ALGORITHM, OSSL_PARAM,
OSSL_CALLBACK, and OSSL_PASSPHRASE_CALLBACK are described in their own
manual page, so we change every mention of them to links to those pages.

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #19842)
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Better sorting of util/other.syms
2e1ec27 
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #19842)

(cherry picked from commit 9dabb55)
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Move the description of the core types into their own pages
e921c27 
This expands on some of the core type descriptions, and also makes it
easier to find the documentation for each type, at least on Unix, with
a simple call like "man OSSL_ALGORITHM".

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

(cherry picked from commit 801e54d)
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Replace some boldened types with a corresponding man page link
31240c1 
The types OSSL_DISPATCH, OSSL_ITEM, OSSL_ALGORITHM, OSSL_PARAM,
OSSL_CALLBACK, and OSSL_PASSPHRASE_CALLBACK are described in their own
manual page, so we change every mention of them to links to those pages.

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

(cherry picked from commit 318a9df)
@levitte
Copy link
Member Author

levitte commented Dec 8, 2022

Merged

master:
318a9df Replace some boldened types with a corresponding man page link
801e54d Move the description of the core types into their own pages
9dabb55 Better sorting of util/other.syms

3.1:
31240c1 Replace some boldened types with a corresponding man page link
e921c27 Move the description of the core types into their own pages
2e1ec27 Better sorting of util/other.syms

3.0:
c919280 Replace some boldened types with a corresponding man page link
2365be2 Move the description of the core types into their own pages
a0564dc Better sorting of util/other.syms

@levitte levitte closed this Dec 8, 2022
@levitte levitte deleted the document-core-types-better branch December 8, 2022 06:43
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Better sorting of util/other.syms
a0564dc 
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from #19842)

(cherry picked from commit 9dabb55)
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Move the description of the core types into their own pages
2365be2 
This expands on some of the core type descriptions, and also makes it
easier to find the documentation for each type, at least on Unix, with
a simple call like "man OSSL_ALGORITHM".

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

(cherry picked from commit 801e54d)
openssl-machine pushed a commit that referenced this pull request Dec 8, 2022
@levitte
Replace some boldened types with a corresponding man page link
c919280 
The types OSSL_DISPATCH, OSSL_ITEM, OSSL_ALGORITHM, OSSL_PARAM,
OSSL_CALLBACK, and OSSL_PASSPHRASE_CALLBACK are described in their own
manual page, so we change every mention of them to links to those pages.

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

(cherry picked from commit 318a9df)
beldmit pushed a commit to beldmit/openssl that referenced this pull request Dec 26, 2022
@levitte @beldmit
Better sorting of util/other.syms
ce61930 
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl#19842)
beldmit pushed a commit to beldmit/openssl that referenced this pull request Dec 26, 2022
@levitte @beldmit
Move the description of the core types into their own pages
148c1ff 
This expands on some of the core type descriptions, and also makes it
easier to find the documentation for each type, at least on Unix, with
a simple call like "man OSSL_ALGORITHM".

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl#19842)
beldmit pushed a commit to beldmit/openssl that referenced this pull request Dec 26, 2022
@levitte @beldmit
Replace some boldened types with a corresponding man page link
b146e82 
The types OSSL_DISPATCH, OSSL_ITEM, OSSL_ALGORITHM, OSSL_PARAM,
OSSL_CALLBACK, and OSSL_PASSPHRASE_CALLBACK are described in their own
manual page, so we change every mention of them to links to those pages.

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from openssl#19842)
@baentsch baentsch mentioned this pull request Dec 27, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slontis slontis slontis left review comments

@hlandau hlandau hlandau approved these changes

@t8m t8m t8m approved these changes

@baentsch baentsch baentsch approved these changes

Assignees

@levitte levitte

Labels
approval: ready to merge The 24 hour grace period has passed, ready to merge branch: master Merge to master branch branch: 3.0 Merge to openssl-3.0 branch branch: 3.1 Merge to openssl-3.1 tests: exempted The PR is exempt from requirements for testing triaged: documentation The issue/pr deals with documentation (errors)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@levitte @openssl-machine @hlandau @t8m @slontis @baentsch