Add docs on providers #3884
Merged
Add docs on providers #3884
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
reneme
reviewed
Jan 12, 2024
| ============================== | ||
|
|
||
| Botan ships with a variety of cryptographic algorithms in both pure software | ||
| as well as with support from :doc:`hardware acceleration <../hardware_acceleration>`. |
There was a problem hiding this comment.
Should we link to an rST label rather than a file, maybe?
There was a problem hiding this comment.
If we would want to do that, we would need to add a label "hardware acceleration" to hardware_acceleration.rst, which is kind of double the work. After #3849 was merged, we are now able to reference whole documents as well as headlines with autogenerated labels. To see all labels sphinx generates, run python3 -m sphinx.ext.intersphinx build/docs/handbook/objects.inv.
randombit
approved these changes
Feb 15, 2024
securitykernel
force-pushed
the
sk/provider-docs
branch
from
a1227ee
to
8c983c6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt to document what providers in Botan are, how to use them, and how to implement them (at least roughly, I tried to make it appeal to both users and implementors) as a follow-up of #3837. IMHO this really needs a thorough review. It may serve as a starting point of discussions on the future of the provider interfaces.