diff options
author | Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com> | 2023-05-09 09:06:40 +0200 |
---|---|---|
committer | Pauli <pauli@openssl.org> | 2023-06-15 10:11:46 +1000 |
commit | eb4129e12cdf7fe64b3ce352f539e3dbeb1b1321 (patch) | |
tree | 70ffce338d4927b9053db6c3b7b8e16af9e9b681 /doc | |
parent | 71cf587ea21c1422640847e358019a51806d2811 (diff) |
Fix typos found by codespell
Typos in doc/man* will be fixed in a different commit.
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20910)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/designs/ddd/WINDOWS.md | 2 | ||||
-rw-r--r-- | doc/designs/quic-design/congestion-control.md | 6 | ||||
-rw-r--r-- | doc/designs/quic-design/dgram-api.md | 4 | ||||
-rw-r--r-- | doc/designs/quic-design/quic-ackm.md | 2 | ||||
-rw-r--r-- | doc/designs/quic-design/quic-fault-injector.md | 8 | ||||
-rw-r--r-- | doc/designs/quic-design/quic-requirements.md | 2 | ||||
-rw-r--r-- | doc/designs/quic-design/record-layer.md | 4 | ||||
-rw-r--r-- | doc/internal/man3/OSSL_EVENT.pod | 2 |
8 files changed, 15 insertions, 15 deletions
diff --git a/doc/designs/ddd/WINDOWS.md b/doc/designs/ddd/WINDOWS.md index 2c96a9542e..d92c4133d3 100644 --- a/doc/designs/ddd/WINDOWS.md +++ b/doc/designs/ddd/WINDOWS.md @@ -32,7 +32,7 @@ For this reason it's actually common for asynchronous I/O libraries to basically contain two separate implementations of their APIs internally, or at least a substantial chunk of their code (e.g. libuv, nanomsg). It turns out to be easier just to write a poll-based implementation of an I/O reactor and an IOCP-based -implementation than try to overcome the impedence discontinuities. +implementation than try to overcome the impedance discontinuities. The difference between polling and IOCPs is that polling reports *readiness* whereas IOCPs report *completion of an operation*. For example, in the IOCP diff --git a/doc/designs/quic-design/congestion-control.md b/doc/designs/quic-design/congestion-control.md index 336290b5f9..d6892ed769 100644 --- a/doc/designs/quic-design/congestion-control.md +++ b/doc/designs/quic-design/congestion-control.md @@ -15,7 +15,7 @@ Congestion controllers are not thread safe; the caller is responsible for synchronisation. Congestion controllers may vary their state with respect to time. This is -faciliated via the `get_wakeup_deadline` method and the `now` argument to the +facilitated via the `get_wakeup_deadline` method and the `now` argument to the `new` method, which provides access to a clock. While no current congestion controller makes use of this facility, it can be used by future congestion controllers to implement packet pacing. @@ -40,10 +40,10 @@ only a single path per connection, so there is one congestion control instance per connection. This may change in future. While the congestion control API is roughly based around the arrangement of -functions as described by the congestion control psuedocode in RFC 9002, there +functions as described by the congestion control pseudocode in RFC 9002, there are some deliberate changes in order to obtain cleaner separation between the loss detection and congestion control functions. Where a literal option of RFC -9002 psuedocode would require a congestion controller to access the ACK +9002 pseudocode would require a congestion controller to access the ACK manager's internal state directly, the interface between the two has been changed to avoid this. This involves some small amounts of functionality which RFC 9002 considers part of the congestion controller being part of the ACK diff --git a/doc/designs/quic-design/dgram-api.md b/doc/designs/quic-design/dgram-api.md index cbd6d56970..691a3acd14 100644 --- a/doc/designs/quic-design/dgram-api.md +++ b/doc/designs/quic-design/dgram-api.md @@ -55,7 +55,7 @@ The adopted design makes the following design decisions: The motivation for this is that these functions are intended to support concurrent use on the same BIO. If they read or modify BIO state, they would - need to be sychronised with a lock, undermining performance on what (for + need to be synchronised with a lock, undermining performance on what (for `BIO_dgram`) would otherwise be a straight system call. - We do not support iovecs. The motivations for this are: @@ -286,7 +286,7 @@ If we go with this, there are some issues that arise: `sendmsg`/`recvmsg`. This again adds burdens on the code using BIO_dgram, but it seems the only way to avoid the surprising performance pitfall of buffer copying to emulate iovec support. There is a fair risk - of code being written which accidentially works on one platform but not + of code being written which accidentally works on one platform but not another, because the author didn't realise the iovec limit is 1 on some platforms. Possibly we could have an “iovec limit” variable in the BIO_dgram which is 1 by default, which can be increased by a call to a diff --git a/doc/designs/quic-design/quic-ackm.md b/doc/designs/quic-design/quic-ackm.md index f81634a2e1..488fded5e1 100644 --- a/doc/designs/quic-design/quic-ackm.md +++ b/doc/designs/quic-design/quic-ackm.md @@ -425,7 +425,7 @@ Failure to do so may may result in processing a duplicated packet in violation of the RFC. The returrn value of this function transitions from 1 to 0 for a given PN once -that PN is passed to ossl_ackm_on_rx_packet, thus this functiion must be used +that PN is passed to ossl_ackm_on_rx_packet, thus this function must be used before calling `ossl_ackm_on_rx_packet`. ```c diff --git a/doc/designs/quic-design/quic-fault-injector.md b/doc/designs/quic-design/quic-fault-injector.md index 2d7a5a9fa2..77e034df4d 100644 --- a/doc/designs/quic-design/quic-fault-injector.md +++ b/doc/designs/quic-design/quic-fault-injector.md @@ -161,7 +161,7 @@ The Fault Injector will utilise the callbacks described above in order to supply a more test friendly API to test authors. This API will primarily take the form of a set of event listener callbacks. A -test will be able to "listen" for a specifc event occuring and be informed about +test will be able to "listen" for a specific event occurring and be informed about it when it does. Examples of events might include: - An EncryptedExtensions handshake message being sent @@ -295,7 +295,7 @@ int ossl_quic_fault_set_handshake_listener(OSSL_QUIC_FAULT *fault, int ossl_quic_fault_resize_handshake(OSSL_QUIC_FAULT *fault, size_t newlen); /* - * TODO(QUIC): Add listeners for specifc types of frame here. E.g. we might + * TODO(QUIC): Add listeners for specific types of frame here. E.g. we might * expect to see an "ACK" frame listener which will be passed pre-parsed ack * data that can be modified as required. */ @@ -338,7 +338,7 @@ int ossl_quic_fault_delete_extension(OSSL_QUIC_FAULT *fault, size_t *extlen); /* - * TODO(QUIC): Add additional helper functions for quering extensions here (e.g. + * TODO(QUIC): Add additional helper functions for querying extensions here (e.g. * finding or adding them). We could also provide a "listener" API for listening * for specific extension types */ @@ -470,7 +470,7 @@ static int test_unknown_frame(void) * TODO(QUIC): We should expect an error on the queue after this - but we * don't have it yet. * Note, just raising the error in the obvious place causes SSL_tick() to - * succeed, but leave a suprious error on the stack. We need to either + * succeed, but leave a spurious error on the stack. We need to either * allow SSL_tick() to fail, or somehow delay the raising of the error * until the SSL_read() call. */ diff --git a/doc/designs/quic-design/quic-requirements.md b/doc/designs/quic-design/quic-requirements.md index 6b12b42597..c8aeedc7b7 100644 --- a/doc/designs/quic-design/quic-requirements.md +++ b/doc/designs/quic-design/quic-requirements.md @@ -120,7 +120,7 @@ Additional OTC analysis An OTC document provided the following analysis. -There are differents types of application that we need to cater for: +There are different types of application that we need to cater for: * Simple clients that just do basic SSL_read/SSL_write or BIO_read/BIO_write interactions. We want to be able to enable them to transfer to using single diff --git a/doc/designs/quic-design/record-layer.md b/doc/designs/quic-design/record-layer.md index 8b035f0d8b..da424064a3 100644 --- a/doc/designs/quic-design/record-layer.md +++ b/doc/designs/quic-design/record-layer.md @@ -302,7 +302,7 @@ The internal recordmethod.h header file for the record method API: */ /* - * An OSSL_RECORD_METHOD is a protcol specific method which provides the + * An OSSL_RECORD_METHOD is a protocol specific method which provides the * functions for reading and writing records for that protocol. Which * OSSL_RECORD_METHOD to use for a given protocol is defined by the SSL_METHOD. */ @@ -437,7 +437,7 @@ struct ossl_record_method_st { int (*processed_read_pending)(OSSL_RECORD_LAYER *rl); /* - * The amount of processed app data that is internally bufferred and + * The amount of processed app data that is internally buffered and * available to read */ size_t (*app_data_pending)(OSSL_RECORD_LAYER *rl); diff --git a/doc/internal/man3/OSSL_EVENT.pod b/doc/internal/man3/OSSL_EVENT.pod index 7f263b5b14..089890de9d 100644 --- a/doc/internal/man3/OSSL_EVENT.pod +++ b/doc/internal/man3/OSSL_EVENT.pod @@ -81,7 +81,7 @@ guaranteed to not trigger before their time. =item context -A reference to user supplied contextual informaton. The event queue passes +A reference to user supplied contextual information. The event queue passes this to callbacks and never dereferences the pointer. =item payload, payload_size |