From 1e4e5492966007268485920a56613b9c6893f237 Mon Sep 17 00:00:00 2001 From: Ulf Möller Date: Sat, 16 Sep 2000 15:39:28 +0000 Subject: ispell and some other nit-picking --- doc/crypto/BIO_ctrl.pod | 6 +++--- doc/crypto/BIO_f_cipher.pod | 2 +- doc/crypto/BIO_f_md.pod | 4 ++-- doc/crypto/BIO_f_ssl.pod | 6 +++--- doc/crypto/BIO_new.pod | 2 +- doc/crypto/BIO_new_bio_pair.pod | 6 +++--- doc/crypto/BIO_read.pod | 4 ++-- doc/crypto/BIO_s_accept.pod | 2 +- doc/crypto/BIO_s_bio.pod | 8 ++++---- doc/crypto/BIO_s_connect.pod | 8 ++++---- doc/crypto/BIO_s_fd.pod | 8 ++++---- doc/crypto/BIO_s_file.pod | 2 +- doc/crypto/BIO_s_mem.pod | 6 ++---- doc/crypto/BIO_s_socket.pod | 2 +- doc/crypto/BIO_should_retry.pod | 2 +- 15 files changed, 33 insertions(+), 35 deletions(-) (limited to 'doc/crypto') diff --git a/doc/crypto/BIO_ctrl.pod b/doc/crypto/BIO_ctrl.pod index aed2095925..421a3ac1cb 100644 --- a/doc/crypto/BIO_ctrl.pod +++ b/doc/crypto/BIO_ctrl.pod @@ -58,14 +58,14 @@ be closed when the BIO is freed. BIO_get_close() returns the BIOs close flag. BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending() -return the number of pending characterers in the BIOs read and write buffers. +return the number of pending characters in the BIOs read and write buffers. Not all BIOs support these calls. BIO_ctrl_pending() and BIO_ctrl_wpending() return a size_t type and are functions, BIO_pending() and BIO_wpending() are macros which call BIO_ctrl(). =head1 RETURN VALUES -BIO_reset() returns 1 fo success and 0 for failure. +BIO_reset() returns 1 for success and 0 for failure. BIO_flush() returns 1 for success and 0 or -1 for failure. @@ -97,7 +97,7 @@ This often means there is no need to locate the required BIO for a particular operation, it can be called on a chain and it will be automatically passed to the relevant BIO. -Source/sink BIOs will return an error if the do not recognise the +Source/sink BIOs will return an error if the do not recognize the BIO_ctrl() operation. =head1 SEE ALSO diff --git a/doc/crypto/BIO_f_cipher.pod b/doc/crypto/BIO_f_cipher.pod index e024865cd4..4182f2c309 100644 --- a/doc/crypto/BIO_f_cipher.pod +++ b/doc/crypto/BIO_f_cipher.pod @@ -38,7 +38,7 @@ is a BIO_ctrl() macro which can be called to determine whether the decryption operation was successful. BIO_get_cipher_ctx() is a BIO_ctrl() macro which retrieves the internal -BIO cipher context. The retrieved context can be used in conjustion +BIO cipher context. The retrieved context can be used in conjunction with the standard cipher routines to set it up. This is useful when BIO_set_cipher() is not flexible enough for the applications needs. diff --git a/doc/crypto/BIO_f_md.pod b/doc/crypto/BIO_f_md.pod index 0845d2bc2b..ebca944065 100644 --- a/doc/crypto/BIO_f_md.pod +++ b/doc/crypto/BIO_f_md.pod @@ -31,7 +31,7 @@ not supported. BIO_reset() reinitializes a digest BIO. BIO_set_md() sets the message digest of BIO B to B: this -must be called to initialise a digest BIO before any data is +must be called to initialize a digest BIO before any data is passed through it. It is a BIO_ctrl() macro. BIO_get_md() places the a pointer to the digest BIOs digest method @@ -127,7 +127,7 @@ outputs them. This could be used with the examples above. =head1 BUGS -The lack of support for BIO_puts() and the non standard behaviour of +The lack of support for BIO_puts() and the non standard behavior of BIO_gets() could be regarded as anomalous. It could be argued that BIO_gets() and BIO_puts() should be passed to the next BIO in the chain and digest the data passed through and that digests should be retrieved using a diff --git a/doc/crypto/BIO_f_ssl.pod b/doc/crypto/BIO_f_ssl.pod index 4ae4400427..122deb42cb 100644 --- a/doc/crypto/BIO_f_ssl.pod +++ b/doc/crypto/BIO_f_ssl.pod @@ -33,7 +33,7 @@ BIO_ssl_shutdown - SSL BIO =head1 DESCRIPTION BIO_f_ssl() returns the SSL BIO method. This is a filter BIO which -is a wrapper round the OpenSSL SSL routines adding a BIO "flavour" to +is a wrapper round the OpenSSL SSL routines adding a BIO "flavor" to SSL I/O. I/O performed on an SSL BIO communicates using the SSL protocol with @@ -65,7 +65,7 @@ the SSL session is automatically renegotiated. B must be at least 512 bytes. BIO_set_ssl_renegotiate_timeout() sets the renegotiate timeout to -B. When the renegotiate timeout elapses the sesssion is +B. When the renegotiate timeout elapses the session is automatically renegotiated. BIO_get_num_renegotiates() returns the total number of session @@ -100,7 +100,7 @@ renegotiation takes place during a BIO_read() operation, one case where this happens is when SGC or step up occurs. In OpenSSL 0.9.6 and later the SSL flag SSL_AUTO_RETRY can be -set to disable this behaviour. That is when this flag is set +set to disable this behavior. That is when this flag is set an SSL BIO using a blocking transport will never request a retry. diff --git a/doc/crypto/BIO_new.pod b/doc/crypto/BIO_new.pod index 53d56b2e6f..2a245fc8de 100644 --- a/doc/crypto/BIO_new.pod +++ b/doc/crypto/BIO_new.pod @@ -40,7 +40,7 @@ BIO_free_all() and BIO_vfree() do not return values. =head1 NOTES Some BIOs (such as memory BIOs) can be used immediately after calling -BIO_new(). Others (such as file BIOs) need some additional initialisation, +BIO_new(). Others (such as file BIOs) need some additional initialization, and frequently a utility function exists to create and initialize such BIOs. If BIO_free() is called on a BIO chain it will only free one BIO resulting diff --git a/doc/crypto/BIO_new_bio_pair.pod b/doc/crypto/BIO_new_bio_pair.pod index c331bd02b8..2256ba9d34 100644 --- a/doc/crypto/BIO_new_bio_pair.pod +++ b/doc/crypto/BIO_new_bio_pair.pod @@ -25,8 +25,8 @@ BIO_new_bio_pair() does not check whether B or B do point to some other BIO, the values are overwritten, BIO_free() is not called. The two BIOs, even though forming a BIO pair and must be BIO_free()'ed -seperately. This can be of importance, as some SSL-functions like SSL_set_bio() -or SSL_free() call BIO_free() implicitely, so that the peer-BIO is left +separately. This can be of importance, as some SSL-functions like SSL_set_bio() +or SSL_free() call BIO_free() implicitly, so that the peer-BIO is left untouched and must also be BIO_free()'ed. =head1 EXAMPLE @@ -53,7 +53,7 @@ without having to go through the SSL-interface. socket | ... - SSL_free(ssl); /* implicitely frees internal_bio */ + SSL_free(ssl); /* implicitly frees internal_bio */ BIO_free(network_bio); ... diff --git a/doc/crypto/BIO_read.pod b/doc/crypto/BIO_read.pod index d9311708ab..b34528104d 100644 --- a/doc/crypto/BIO_read.pod +++ b/doc/crypto/BIO_read.pod @@ -43,8 +43,8 @@ it may merely be an indication that no data is currently available and that the application should retry the operation later. One technique sometimes used with blocking sockets is to use a system call -(such as select(), poll() or eqivalent) to determine when data is available -and then call read() to read the data. The eqivalent with BIOs (that is call +(such as select(), poll() or equivalent) to determine when data is available +and then call read() to read the data. The equivalent with BIOs (that is call select() on the underlying I/O structure and then call BIO_read() to read the data) should B be used because a single call to BIO_read() can cause several reads (and writes in the case of SSL BIOs) on the underlying diff --git a/doc/crypto/BIO_s_accept.pod b/doc/crypto/BIO_s_accept.pod index 17fd54a9c6..ddb1f9a2b0 100644 --- a/doc/crypto/BIO_s_accept.pod +++ b/doc/crypto/BIO_s_accept.pod @@ -100,7 +100,7 @@ BIO is not at then end of a chain it passes I/O calls to the next BIO in the chain. When a connection is established a new socket BIO is created for -the conection and appended to the chain. That is the chain is now +the connection and appended to the chain. That is the chain is now accept->socket. This effectively means that attempting I/O on an initial accept socket will await an incoming connection then perform I/O on it. diff --git a/doc/crypto/BIO_s_bio.pod b/doc/crypto/BIO_s_bio.pod index 2c93f179b9..7a3b2db141 100644 --- a/doc/crypto/BIO_s_bio.pod +++ b/doc/crypto/BIO_s_bio.pod @@ -61,7 +61,7 @@ BIO_destroy_pair() destroys the association between two connected BIOs. Freeing up any half of the pair will automatically destroy the association. BIO_set_write_buf_size() sets the write buffer size of BIO B to B. -If the size is not initialised a default value is used. This is currently +If the size is not initialized a default value is used. This is currently 17K, sufficient for a maximum size TLS record. BIO_get_write_buf_size() returns the size of the write buffer. @@ -71,7 +71,7 @@ BIO_set_write_buf_size() to create a connected pair of BIOs B, B with write buffer sizes B and B. If either size is zero then the default size is used. -BIO_get_write_guarantee() and BIO_ctrl_get_write_guarentee() return the maximum +BIO_get_write_guarantee() and BIO_ctrl_get_write_guarantee() return the maximum length of data that can be currently written to the BIO. Writes larger than this value will return a value from BIO_write() less than the amount requested or if the buffer is full request a retry. BIO_ctrl_get_write_guarantee() is a function @@ -89,7 +89,7 @@ BIO_get_read_request() to zero. =head1 NOTES -Both halves of a BIO pair should be freed. That is even if one half is implicity +Both halves of a BIO pair should be freed. That is even if one half is implicit freed due to a BIO_free_all() or SSL_free() call the other half needs to be freed. When used in bidirectional applications (such as TLS/SSL) care should be taken to @@ -103,7 +103,7 @@ BIO_write() and a response read with BIO_read(), this can occur during an TLS/SSL handshake for example. BIO_write() will succeed and place data in the write buffer. BIO_read() will initially fail and BIO_should_read() will be true. If the application then waits for data to be available on the underlying transport -before flusing the write buffer it will never succeed because the request was +before flushing the write buffer it will never succeed because the request was never sent! =head1 EXAMPLE diff --git a/doc/crypto/BIO_s_connect.pod b/doc/crypto/BIO_s_connect.pod index 65723a70a4..fe1aa679d4 100644 --- a/doc/crypto/BIO_s_connect.pod +++ b/doc/crypto/BIO_s_connect.pod @@ -66,13 +66,13 @@ fails a standard table of port names will be used. Currently the list is http, telnet, socks, https, ssl, ftp, gopher and wais. BIO_set_conn_ip() sets the IP address to B using binary form, -that is four bytes specifying the IP address in big endian form. +that is four bytes specifying the IP address in big-endian form. BIO_set_conn_int_port() sets the port using B. B should be of type (int *). BIO_get_conn_hostname() returns the hostname of the connect BIO or -NULL if the BIO is initialised but no hostname is set. +NULL if the BIO is initialized but no hostname is set. This return value is an internal pointer which should not be modified. BIO_get_conn_port() returns the port as a string. @@ -120,7 +120,7 @@ It addition to BIO_should_read() and BIO_should_write() it is also possible for BIO_should_io_special() to be true during the initial connection process with the reason BIO_RR_CONNECT. If this is returned then this is an indication that a connection attempt would block, -the application should then take appropiate action to wait until +the application should then take appropriate action to wait until the underlying socket has connected and retry the call. =head1 RETURN VALUES @@ -128,7 +128,7 @@ the underlying socket has connected and retry the call. BIO_s_connect() returns the connect BIO method. BIO_get_fd() returns the socket or -1 if the BIO has not -been initialised. +been initialized. BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_set_conn_ip() and BIO_set_conn_int_port() always return 1. diff --git a/doc/crypto/BIO_s_fd.pod b/doc/crypto/BIO_s_fd.pod index da08ba1023..e0ca2eca94 100644 --- a/doc/crypto/BIO_s_fd.pod +++ b/doc/crypto/BIO_s_fd.pod @@ -36,11 +36,11 @@ BIO_get_fd() places the file descriptor in B if it is not NULL, it also returns the file descriptor. If B is not NULL it should be of type (int *). -BIO_new_fd() returns a file desciptor BIO using B and B. +BIO_new_fd() returns a file descriptor BIO using B and B. =head1 NOTES -The behaviour of BIO_read() and BIO_write() depends on the behaviour of the +The behavior of BIO_read() and BIO_write() depends on the behavior of the platforms read() and write() calls on the descriptor. If the underlying file descriptor is in a non blocking mode then the BIO will behave in the manner described in the L and L @@ -56,12 +56,12 @@ BIO_s_fd() returns the file descriptor BIO method. BIO_reset() returns zero for success and -1 if an error occurred. BIO_seek() and BIO_tell() return the current file position or -1 is an error occurred. These values reflect the underlying lseek() -behaviour. +behavior. BIO_set_fd() always returns 1. BIO_get_fd() returns the file descriptor or -1 if the BIO has not -been initialised. +been initialized. BIO_new_fd() returns the newly allocated BIO or NULL is an error occurred. diff --git a/doc/crypto/BIO_s_file.pod b/doc/crypto/BIO_s_file.pod index 10fe4933c7..672dc2f48d 100644 --- a/doc/crypto/BIO_s_file.pod +++ b/doc/crypto/BIO_s_file.pod @@ -66,7 +66,7 @@ When wrapping stdout, stdin or stderr the underlying stream should not normally be closed so the BIO_NOCLOSE flag should be set. Because the file BIO calls the underlying stdio functions any quirks -in stdio behaviour will be mirrored by the corresponding BIO. +in stdio behavior will be mirrored by the corresponding BIO. =head1 EXAMPLES diff --git a/doc/crypto/BIO_s_mem.pod b/doc/crypto/BIO_s_mem.pod index 0c5f58ed1b..3208932588 100644 --- a/doc/crypto/BIO_s_mem.pod +++ b/doc/crypto/BIO_s_mem.pod @@ -43,7 +43,7 @@ BIO_eof() is true if no data is in the BIO. BIO_ctrl_pending() returns the number of bytes currently stored. -BIO_set_mem_eof_return() sets the behaviour of memory BIO B when it is +BIO_set_mem_eof_return() sets the behavior of memory BIO B when it is empty. If the B is zero then an empty memory BIO will return EOF (that is it will return zero and BIO_should_retry(b) will be false. If B is non zero then it will return B when it is empty and it will set the read retry @@ -87,9 +87,7 @@ There should be a way to "rewind" a read write BIO without destroying its contents. The copying operation should not occur after every small read of a large BIO -to improve efficieny. - -There shoy +to improve efficiency. =head1 EXAMPLE diff --git a/doc/crypto/BIO_s_socket.pod b/doc/crypto/BIO_s_socket.pod index ec450e11f1..253185185c 100644 --- a/doc/crypto/BIO_s_socket.pod +++ b/doc/crypto/BIO_s_socket.pod @@ -51,7 +51,7 @@ BIO_s_socket() returns the socket BIO method. BIO_set_fd() always returns 1. BIO_get_fd() returns the socket or -1 if the BIO has not been -initialised. +initialized. BIO_new_socket() returns the newly allocated BIO or NULL is an error occurred. diff --git a/doc/crypto/BIO_should_retry.pod b/doc/crypto/BIO_should_retry.pod index 539c391272..cd7adcd425 100644 --- a/doc/crypto/BIO_should_retry.pod +++ b/doc/crypto/BIO_should_retry.pod @@ -97,7 +97,7 @@ the performance may be poor if SSL BIOs are present because long delays can occur during the initial handshake process. It is possible for a BIO to block indefinitely if the underlying I/O -structure cannot process or return any data. This depends on the behaviour of +structure cannot process or return any data. This depends on the behavior of the platforms I/O functions. This is often not desirable: one solution is to use non blocking I/O and use a timeout on the select() (or equivalent) call. -- cgit v1.2.3