yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-25 18:35:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix some typos in documentation and comments

Browse Source
This commit is contained in:
Manuel Pégourié-Gonnard 2018-10-22 09:56:53 +02:00
parent bcedb92e7b
commit ca29fdf569
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/mbedtls/ssl.h
View File

@ -2917,7 +2917,7 @@ int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session
* \return \c 0 if successful. * \return \c 0 if successful.
* \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
* in the handshake is incomplete but or waiting for data to * in the handshake is incomplete but or waiting for data to
* be availaible for reading from or writing to the underlying * be available for reading from or writing to the underlying
* transport - in this case you must call this function again * transport - in this case you must call this function again
* when the underlying transport is ready for the operation. * when the underlying transport is ready for the operation.
* \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
@ -2951,7 +2951,7 @@ int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session
* actual error, but you still need to reset/free the context. * actual error, but you still need to reset/free the context.
* *
* \note Remarks regarding event-driven DTLS: * \note Remarks regarding event-driven DTLS:
* If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
* from the underlying transport layer is currently being processed, * from the underlying transport layer is currently being processed,
* and it is safe to idle until the timer or the underlying transport * and it is safe to idle until the timer or the underlying transport
* signal a new event. This is not true for a successful handshake, * signal a new event. This is not true for a successful handshake,
@ -3022,7 +3022,7 @@ int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
* - in this case you must stop using the context (see below). * - in this case you must stop using the context (see below).
* \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
* in the handshake is incomplete but or waiting for data to * in the handshake is incomplete but or waiting for data to
* be availaible for reading from or writing to the underlying * be available for reading from or writing to the underlying
* transport - in this case you must call this function again * transport - in this case you must call this function again
* when the underlying transport is ready for the operation. * when the underlying transport is ready for the operation.
* \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
@ -3035,7 +3035,7 @@ int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
* the handshake when you're done attending other tasks. * the handshake when you're done attending other tasks.
* \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
* side of a DTLS connection and the client is initiating a * side of a DTLS connection and the client is initiating a
* new commection using the same source port. See below. * new connection using the same source port. See below.
* \return Another SSL error code - in this case you must stop using * \return Another SSL error code - in this case you must stop using
* the context (see below). * the context (see below).
* *
@ -3051,7 +3051,7 @@ int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
* on it before re-using it for a new connection; the current * on it before re-using it for a new connection; the current
* connection must be closed. * connection must be closed.
* *
* \note When this function return MBEDTLS_ERR_SSL_CLIENT_RECONNECT * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
* (which can only happen server-side), it means that a client * (which can only happen server-side), it means that a client
* is initiating a new connection using the same source port. * is initiating a new connection using the same source port.
* You can either treat that as a connection close and wait * You can either treat that as a connection close and wait
@ -3066,7 +3066,7 @@ int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
* application layer, would allow authentication bypass! * application layer, would allow authentication bypass!
* *
* \note Remarks regarding event-driven DTLS: * \note Remarks regarding event-driven DTLS:
* - If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
* from the underlying transport layer is currently being processed, * from the underlying transport layer is currently being processed,
* and it is safe to idle until the timer or the underlying transport * and it is safe to idle until the timer or the underlying transport
* signal a new event. * signal a new event.
@ -3096,10 +3096,10 @@ int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
* \param len how many bytes must be written * \param len how many bytes must be written
* *
* \return The (non-negative) number of bytes actually written if * \return The (non-negative) number of bytes actually written if
* successfull (may be less than \p len). * successful (may be less than \p len).
* \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
* in the handshake is incomplete but or waiting for data to * in the handshake is incomplete but or waiting for data to
* be availaible for reading from or writing to the underlying * be available for reading from or writing to the underlying
* transport - in this case you must call this function again * transport - in this case you must call this function again
* when the underlying transport is ready for the operation. * when the underlying transport is ready for the operation.
* \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
@ -3124,10 +3124,10 @@ int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
* on it before re-using it for a new connection; the current * on it before re-using it for a new connection; the current
* connection must be closed. * connection must be closed.
* *
* \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ, * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
* it must be called later with the *same* arguments, * it must be called later with the *same* arguments,
* until it returns a value greater that or equal to 0. When * until it returns a value greater that or equal to 0. When
* the function returns MBEDTLS_ERR_SSL_WANT_WRITE there may be * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
* some partial data in the output buffer, however this is not * some partial data in the output buffer, however this is not
* yet sent. * yet sent.
* *

2
library/ecdh.c
View File

@ -43,7 +43,7 @@
* Generate public key (restartable version) * Generate public key (restartable version)
* *
* Note: this internal function relies on its caller preserving the value of * Note: this internal function relies on its caller preserving the value of
* the output parameter 'd' accross continuation calls. This would not be * the output parameter 'd' across continuation calls. This would not be
* acceptable for a public function but is OK here as we control call sites. * acceptable for a public function but is OK here as we control call sites.
*/ */
static int ecdh_gen_public_restartable( mbedtls_ecp_group *grp, static int ecdh_gen_public_restartable( mbedtls_ecp_group *grp,