docs: Documentation clean up #3329
Merged
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
lrstewart
reviewed
May 24, 2022
lundinc2
force-pushed
the
documentation-readme
branch
2 times, most recently
from
7d96994 to
4e0aa5e
Compare
maddeleine
reviewed
May 25, 2022
There was a problem hiding this comment.
I don't think this PR actually resolves #3314, it doesn't include the CSS changes.
I'll do a separate PR to introduce CSS changes |
maddeleine
approved these changes
May 26, 2022
lrstewart
reviewed
May 26, 2022
api/s2n.h
Outdated
Comment on lines
1742
to
1730
| * @note Unlike OpenSSL, repeated calls to s2n_send() should not duplicate the original parameters, but should | ||
| * update `buf` and `size` per the indication of size written. For example; | ||
| * ```c |
There was a problem hiding this comment.
I think I was wrong about removing examples. This one seems pretty integral to this @note.
Same for s2n_sendv_with_offset and s2n_recv.
api/s2n.h
Outdated
Comment on lines
2724
to
2729
| * | ||
| * @warning The string "TLS_NULL_WITH_NULL_NULL" is returned before the TLS handshake has been performed. | ||
| * This does not mean that the ciphersuite "TLS_NULL_WITH_NULL_NULL" will be used by the connection, | ||
| * it is merely being used as a placeholder. | ||
| * | ||
| * @note This function is only accurate after the TLS handshake. |
There was a problem hiding this comment.
Why is this being removed? Didn't another PR just add these notes?
There was a problem hiding this comment.
That was an error on my part. I'll revert this change.
lundinc2
force-pushed
the
documentation-readme
branch
2 times, most recently
from
219dd6a to
21bd600
Compare
lundinc2
force-pushed
the
documentation-readme
branch
from
21bd600 to
b21b9a9
Compare
lrstewart
approved these changes
Jun 8, 2022
|
|
||
| **s2n_config_new** returns a new configuration object suitable for associating certs and keys. | ||
| This object can (and should) be associated with many connection objects. | ||
| Setting the `S2N_SELF_SERVICE_BLINDING` option with `s2n_connection_set_blinding()` turns off this behavior. This is useful for applications that are handling many connections in a single thread. In that case, if `s2n_recv()` or `s2n_negotiate()` return an error, self-service applications must call `s2n_connection_get_delay()` and pause activity on the connection for the specified number of nanoseconds before calling `close()` or `shutdown()`. `s2n_shutdown()` will fail if called before the blinding delay elapses. |
There was a problem hiding this comment.
Nit: double space
Suggested change
| Setting the `S2N_SELF_SERVICE_BLINDING` option with `s2n_connection_set_blinding()` turns off this behavior. This is useful for applications that are handling many connections in a single thread. In that case, if `s2n_recv()` or `s2n_negotiate()` return an error, self-service applications must call `s2n_connection_get_delay()` and pause activity on the connection for the specified number of nanoseconds before calling `close()` or `shutdown()`. `s2n_shutdown()` will fail if called before the blinding delay elapses. | |
| Setting the `S2N_SELF_SERVICE_BLINDING` option with `s2n_connection_set_blinding()` turns off this behavior. This is useful for applications that are handling many connections in a single thread. In that case, if `s2n_recv()` or `s2n_negotiate()` return an error, self-service applications must call `s2n_connection_get_delay()` and pause activity on the connection for the specified number of nanoseconds before calling `close()` or `shutdown()`. `s2n_shutdown()` will fail if called before the blinding delay elapses. |
Comment on lines
+318
to
+319
| ### Stacktraces | ||
| s2n-tls has an mechanism to capture stacktraces when errors occur. |
There was a problem hiding this comment.
Nit
Suggested change
| ### Stacktraces | |
| s2n-tls has an mechanism to capture stacktraces when errors occur. | |
| ### Stacktraces | |
| s2n-tls has a mechanism to capture stacktraces when errors occur. |
lundinc2
added a commit
to lundinc2/s2n-tls
that referenced
this pull request
Jun 9, 2022
Re-write a portion of the USAGE GUIDE to move it towards being a guide vs an API reference.
dougch
pushed a commit
to dougch/s2n-tls
that referenced
this pull request
Jun 27, 2022
Re-write a portion of the USAGE GUIDE to move it towards being a guide vs an API reference.
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.
Resolved issues:
resolves 3314
Description of changes:
Call-outs:
Address any potentially confusing code. Is there code added that needs to be cleaned up later? Is there code that is missing because it’s still in development?
Testing:
How is this change tested (unit tests, fuzz tests, etc.)? Are there any testing steps to be verified by the reviewer?
Is this a refactor change? If so, how have you proved that the intended behavior hasn't changed?
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.