]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
quic docs: update ddd README.md
authorJames Muir <james@openssl.org>
Fri, 27 Oct 2023 16:46:30 +0000 (12:46 -0400)
committerHugo Landau <hlandau@openssl.org>
Wed, 1 Nov 2023 15:37:53 +0000 (15:37 +0000)
Minor edits (expand MVP acronym, suggest how to install "libuv")

These changes are part of
https://github.com/openssl/project/issues/253

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22543)

doc/designs/ddd/README.md

index 3f430de24a0e72a69d6b6a3e51074915136fd65f..3fc63f2462cf17187425e4b1884c240ca0c22b75 100644 (file)
@@ -43,7 +43,7 @@ The demos also deliberately focus on aspects of libssl usage which are likely to
 be relevant to QUIC and require changes; for example, how varied applications
 have libssl perform network I/O, and how varied applications create sockets and
 connections for use with libssl. The libssl API as a whole has a much larger
-scope and includes innumerate functions and myriad features; the intention is
+scope and includes numerous functions and features; the intention is
 not to demonstrate all of these, because most of them will not be touched by
 QUIC. For example, while many users of OpenSSL may make use of APIs for client
 certificates or other TLS functionality, the use of QUIC is unlikely to have
@@ -51,13 +51,13 @@ implications for these APIs and demos demonstrating such functionality are
 therefore out of scope.
 
 [A report is available](REPORT.md) on the results of the DDD process following
-the completion of the development of the QUIC MVP.
+the completion of the development of the QUIC MVP (minimum viable product).
 
 Background
 ----------
 
 These demos were developed after analysis of the following open source
-applications to determine libssl API usage patterns. The modally occurring usage
+applications to determine libssl API usage patterns. The commonly occurring usage
 patterns were determined and used to determine categories into which to classify
 the applications:
 
@@ -86,8 +86,8 @@ the applications:
 | pgbouncer        | A |      AOSF, BIOc  |
 
 * Blk: Whether the application uses blocking or non-blocking I/O.
-  * S: Blocking
-  * A: Nonblocking
+  * S: Blocking (Synchronous)
+  * A: Nonblocking (Asynchronous)
 * FD: Whether the application creates and owns its own FD.
   * AOSF: Application owns, calls SSL_set_fd.
   * AOSFx: Application owns, calls SSL_set_[rw]fd, different FDs for read/write.
@@ -114,5 +114,7 @@ The demos found in this directory are:
 | [ddd-05-mem-nonblocking](ddd-05-mem-nonblocking.c) | A-BIOm | A non-blocking example based on use of a memory buffer to feed OpenSSL encrypted data (corresponding to A-BIOm applications above) |
 | [ddd-06-mem-uv](ddd-06-mem-uv.c) | A-BIOm | A non-blocking example based on use of a memory buffer to feed OpenSSL encrypted data; uses libuv, a real-world async I/O library |
 
+On Ubuntu, libuv can be obtained by installing the package "libuv1-dev".
+
 Availability of a default certificate store is assumed. `SSL_CERT_DIR` may be
 set when running the demos if necessary.