diff options
author | lloyd <[email protected]> | 2012-06-29 21:40:27 +0000 |
---|---|---|
committer | lloyd <[email protected]> | 2012-06-29 21:40:27 +0000 |
commit | 8c7bc96055be1a783c097837307b280b3ec8ab88 (patch) | |
tree | cebdd1f450a1125865f9a65022e03f97836c47fd | |
parent | 30e1d232848a5fb8faf3e7c98b3389e041b27987 (diff) |
Minor doc updates
-rw-r--r-- | doc/index.txt | 8 | ||||
-rw-r--r-- | doc/tls.txt | 5 |
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/index.txt b/doc/index.txt index bfb69cd0c..7434b9840 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -4,10 +4,10 @@ Welcome Botan is a :doc:`BSD-licensed <license>` crypto library for C++. It provides applications with most any :doc:`cryptographic algorithm -<algos>` you might be looking for, along with :doc:`SSL/TLS <tls>`, -:doc:`X.509 certificates and CRLs <x509>`, a :doc:`pipeline-style -message processing system <filters>`, and a wide variety of other -features. A third party open source implementation of `SSHv2 +<algos>` you might be looking for, along with :doc:`tls`, :doc:`X.509 +certificates and CRLs <x509>`, a :doc:`pipeline-style message +processing system <filters>`, and a wide variety of other features. A +third party open source implementation of `SSHv2 <http://www.netsieben.com/products/ssh/>`_ that uses botan is also available. In addition to C++ you can use botan from :doc:`Python <python>` or `Node.js <https://github.com/justinfreitag/node-botan>`_ diff --git a/doc/tls.txt b/doc/tls.txt index 3b545dfbc..e5e9dc91d 100644 --- a/doc/tls.txt +++ b/doc/tls.txt @@ -83,6 +83,11 @@ available: result in one or more callback functions that were provided to the constructor being called. + The return value of ``received_data`` specifies how many more + bytes of input are needed to make any progress, unless the end of + the data fell exactly on a message boundary, in which case it + will return 0 instead. + .. cpp:function:: void send(const byte buf[], size_t buf_size) If the connection has completed the initial handshake process, |