From f385158d103be27433b684f86e6b65bff009a4fb Mon Sep 17 00:00:00 2001 From: Felipe Gasper Date: Wed, 21 Dec 2022 14:34:37 -0500 Subject: [PATCH] docs --- README.md | 9 ++++++--- lib/Net/mbedTLS.pm | 5 ++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ab358ae..bafb90a 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,7 @@ Net::mbedTLS - [mbedTLS](https://tls.mbed.org/) in Perl # DESCRIPTION -[OpenSSL](https://openssl.org) is great, and so is [Net::SSLeay](https://metacpan.org/pod/Net%3A%3ASSLeay), -its Perl binding. Both are rather large, though. +[OpenSSL](https://openssl.org) is great but rather large. This distribution allows use of mbedTLS, a smaller, simpler TLS library, from Perl. @@ -41,7 +40,7 @@ This library, like mbedTLS itself, minimizes memory usage at the cost of performance. After a simple TLS handshake with this library Perl’s memory usage is about 6.5 MiB lower than when using [IO::Socket::SSL](https://metacpan.org/pod/IO%3A%3ASocket%3A%3ASSL) for the same. On the other hand, OpenSSL does the -handshake about 18 times faster. +handshake (as of this writing) about 18 times faster. # AVAILABLE FUNCTIONALITY @@ -63,6 +62,10 @@ contains mbedTLS’s `include` and `lib` (or `library`) directories. - Static, to a specific path: Like the previous one, but also set `NET_MBEDTLS_LINKING` to `static` in your environment. +NB: In the latter two cases your compiler has to generate +_position-independent_ code when building mbedTLS. GCC’s `-fPIC` +flag does this. (See this distribution’s CI tests for an example.) + Dynamic linking allows Net::mbedTLS to use the most recent (compatible) mbedTLS but requires you to have a shared mbedTLS available, whereas static linking alleviates that dependency at the diff --git a/lib/Net/mbedTLS.pm b/lib/Net/mbedTLS.pm index 7d2e04b..6e8d6c6 100644 --- a/lib/Net/mbedTLS.pm +++ b/lib/Net/mbedTLS.pm @@ -45,8 +45,7 @@ Net::mbedTLS - L in Perl =head1 DESCRIPTION -L is great, and so is L, -its Perl binding. Both are rather large, though. +L is great but rather large. This distribution allows use of mbedTLS, a smaller, simpler TLS library, from Perl. @@ -57,7 +56,7 @@ This library, like mbedTLS itself, minimizes memory usage at the cost of performance. After a simple TLS handshake with this library Perl’s memory usage is about 6.5 MiB lower than when using L for the same. On the other hand, OpenSSL does the -handshake about 18 times faster. +handshake (as of this writing) about 18 times faster. =head1 AVAILABLE FUNCTIONALITY