From ca33cafab0e3f51c1ab2323020c0f2c80d7705f9 Mon Sep 17 00:00:00 2001 From: Simon Butcher Date: Wed, 18 Jul 2018 17:52:14 +0100 Subject: [PATCH 1/2] Add definition of purpose and use of networking module The purpose of the networking module can sometimes be misunderstood. This adds a definition and explanation of what the networking module is and what it can be used for. --- include/mbedtls/net_sockets.h | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/include/mbedtls/net_sockets.h b/include/mbedtls/net_sockets.h index 0f9b31ebc..dd7dc6733 100644 --- a/include/mbedtls/net_sockets.h +++ b/include/mbedtls/net_sockets.h @@ -1,7 +1,22 @@ /** * \file net_sockets.h * - * \brief Network communication functions + * \brief Network sockets abstraction layer to integrate Mbed TLS into a + * BSD-style sockets API. + * + * The network sockets module provides an example integration of the + * Mbed TLS library into a BSD sockets implementation. The module is + * intended to be both an example of how Mbed TLS can be integrated + * into a networking stack, and also act as Mbed TLS's integration on + * the supported platforms. + * + * The module is intended only for the use of the Mbed TLS library and + * is not intended to be used by third party application software. + * + * The supported platforms are as follows: + * * Microsoft Windows and Windows CE + * * POSIX/Unix platforms including Linux, OS X + * */ /* * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved From 5cf4d0694f74496fe9ad1985324eba6b4e3ea63c Mon Sep 17 00:00:00 2001 From: Simon Butcher Date: Mon, 23 Jul 2018 14:36:40 +0100 Subject: [PATCH 2/2] Refine the definition of net_sockets.h Clarified the purport of net_socket.h to make its purpose clearer. --- include/mbedtls/net_sockets.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/include/mbedtls/net_sockets.h b/include/mbedtls/net_sockets.h index dd7dc6733..9f07eeb4d 100644 --- a/include/mbedtls/net_sockets.h +++ b/include/mbedtls/net_sockets.h @@ -6,12 +6,13 @@ * * The network sockets module provides an example integration of the * Mbed TLS library into a BSD sockets implementation. The module is - * intended to be both an example of how Mbed TLS can be integrated - * into a networking stack, and also act as Mbed TLS's integration on - * the supported platforms. + * intended to be an example of how Mbed TLS can be integrated into a + * networking stack, as well as to be Mbed TLS's network integration + * for its supported platforms. * - * The module is intended only for the use of the Mbed TLS library and - * is not intended to be used by third party application software. + * The module is intended only to be used with the Mbed TLS library and + * is not intended to be used by third party application software + * directly. * * The supported platforms are as follows: * * Microsoft Windows and Windows CE