Merge pull request #39 from yangjie11/master

【修改】修改文件中的代码格式，及细节

README.md

@@ -29,7 +29,7 @@ Apache License Version 2.0 协议许可。
 
 - 配置软件包并使能示例
 
-```shell
+```c
 RT-Thread online packages --->
     security packages  --->
             Select Root Certificate  --->      # 选择证书文件
@@ -44,15 +44,15 @@ RT-Thread online packages --->
 
 - 选择证书文件
 
-    ```shell
-    RT-Thread online packages --->
-        security packages  --->
-            [*] mbedtls: An portable and flexible SSL/TLS library  ---  # 打开 mbedtls 软件包
-                  Select Root Certificate  --->      # 选择证书文件
-                       [ ] Using all default CA(Use preset CA certificates. Take up more memory)
-                       [ ] Using user CA(copy your Root CA file to mbedtls package "certs" directory)
-                       [*] Using Digital Signature Trust Root CA # 测试例程需要使用的证书
-    ```
+```c
+RT-Thread online packages --->
+    security packages  --->
+        [*] mbedtls: An portable and flexible SSL/TLS library  ---  # 打开 mbedtls 软件包
+                Select Root Certificate  --->                       # 选择证书文件
+                    [ ] Using all default CA(Use preset CA certificates. Take up more memory)
+                    [ ] Using user CA(copy your Root CA file to mbedtls package "certs" directory)
+                    [*] Using Digital Signature Trust Root CA       # 测试例程需要使用的证书
+```
 
     - `Using all default CA` 配置选项会将 `certs/default` 目录下的所有预置证书加入编译，将占用很大的内存
     - `Using user CA` 配置选项允许用户将自己需要的证书文件加入编译，需要用户将证书文件拷贝到 `certs` 根目录

docs/api.md

@@ -11,7 +11,9 @@
 
 ### mbedtls 初始化
 
-> int mbedtls_client_init(MbedTLSSession *session, void *entropy, size_t entropyLen);
+```c
+int mbedtls_client_init(MbedTLSSession *session, void *entropy, size_t entropyLen);
+```
 
 mbedtls 客户端初始化函数，用于初始化底层网络接口、设置证书、设置 SSL 会话等。
 
@@ -26,7 +28,9 @@ mbedtls 客户端初始化函数，用于初始化底层网络接口、设置证
 
 ### 配置 mbedtls 上下文
 
-> int mbedtls_client_context(MbedTLSSession *session);
+```c
+int mbedtls_client_context(MbedTLSSession *session);
+```
 
 SSL 层配置，应用程序使用 `mbedtls_client_context` 函数配置客户端上下文信息，包括证书解析、设置主机名、设置默认 SSL 配置、设置认证模式（默认 MBEDTLS_SSL_VERIFY_OPTIONAL）等。
 
@@ -39,7 +43,9 @@ SSL 层配置，应用程序使用 `mbedtls_client_context` 函数配置客户
 
 ### 建立 SSL/TLS 连接
 
-> int mbedtls_client_connect(MbedTLSSession *session);
+```c
+int mbedtls_client_connect(MbedTLSSession *session);
+```
 
 使用 `mbedtls_client_connect` 函数为 SSL/TLS 连接建立通道。这里包含整个的握手连接过程，以及证书校验结果。
 
@@ -54,7 +60,9 @@ SSL 层配置，应用程序使用 `mbedtls_client_context` 函数配置客户
 
 - **向加密连接写入数据**
 
-> int mbedtls_client_write(MbedTLSSession *session, const unsigned char *buf , size_t len);
+```c
+int mbedtls_client_write(MbedTLSSession *session, const unsigned char *buf , size_t len);
+```
 
 | 参数           | 描述    |
 | :-----         | :-----  |
@@ -67,7 +75,9 @@ SSL 层配置，应用程序使用 `mbedtls_client_context` 函数配置客户
 
 - **从加密连接读取数据**
 
-> int mbedtls_client_read(MbedTLSSession *session, unsigned char *buf , size_t len);
+```c
+int mbedtls_client_read(MbedTLSSession *session, unsigned char *buf , size_t len);
+```
 
 | 参数           | 描述    |
 | :-----         | :-----  |
@@ -80,7 +90,9 @@ SSL 层配置，应用程序使用 `mbedtls_client_context` 函数配置客户
 
 ### 关闭 mbedtls 客户端
 
-> int mbedtls_client_close(MbedTLSSession *session);
+```c
+int mbedtls_client_close(MbedTLSSession *session);
+```
 
 客户端主动关闭连接或者因为异常错误关闭连接，都需要使用 `mbedtls_client_close` 关闭连接并释放资源。
 
@@ -95,7 +107,9 @@ SSL 层配置，应用程序使用 `mbedtls_client_context` 函数配置客户
 
 ### 设置调试级别
 
-> void mbedtls_debug_set_threshold( int threshold );
+```c
+void mbedtls_debug_set_threshold( int threshold );
+```
 
 如果开启了 `MBEDTLS_DEBUG_C`，可以使用该函数设置调试级别，用于控制不同级别的调试日志输出。
 
@@ -119,7 +133,9 @@ mbedtls 定义了 5 种调试级别，如下所示：
 
 - **网络上下文初始化**
 
-> void mbedtls_net_init( mbedtls_net_context *ctx );
+```c
+void mbedtls_net_init( mbedtls_net_context *ctx );
+```
 
 初始化 TLS 网络上下文，目前只有 fd 描述符。
 
@@ -131,7 +147,9 @@ mbedtls 定义了 5 种调试级别，如下所示：
 
 - **SSL 上下文初始化**
 
-> void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
+```c
+void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
+```
 
 SSL 上下文初始化，主要是清空 SSL 上下文对象，为 SSL 连接做准备。
 
@@ -143,7 +161,9 @@ SSL 上下文初始化，主要是清空 SSL 上下文对象，为 SSL 连接做
 
 - **初始化 SSL 配置**
 
-> void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
+```c
+void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
+```
 
 SSL 配置初始化，主要是清空 SSL 配置结构体对象，为 SSL 连接做准备。
 
@@ -155,7 +175,9 @@ SSL 配置初始化，主要是清空 SSL 配置结构体对象，为 SSL 连接
 
 - **初始化 SSL 随机字节发生器**
 
-> void mbedtls_ctr_drbg_init( mbedtls_ctr_drbg_context *ctx );
+```c
+void mbedtls_ctr_drbg_init( mbedtls_ctr_drbg_context *ctx );
+```
 
 清空 CTR_DRBG（SSL 随机字节发生器）上下文结构体对象，为 `mbedtls_ctr_drbg_seed` 做准备。
 
@@ -167,7 +189,9 @@ SSL 配置初始化，主要是清空 SSL 配置结构体对象，为 SSL 连接
 
 - **初始化 SSL 熵**
 
-> void mbedtls_entropy_init( mbedtls_entropy_context *ctx );
+```c
+void mbedtls_entropy_init( mbedtls_entropy_context *ctx );
+```
 
 初始化 SSL 熵结构体对象。
 
@@ -201,7 +225,9 @@ int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx,
 
 - **设置根证书列表**
 
-> void mbedtls_x509_crt_init( mbedtls_x509_crt *crt );
+```c
+void mbedtls_x509_crt_init( mbedtls_x509_crt *crt );
+```
 
 初始化根证书链表。
 
@@ -213,7 +239,9 @@ int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx,
 
 - **解析根证书**
 
-> int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
+```c
+int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
+```
 
 解释性地解析。解析 buf 中一个或多个证书并将其添加到根证书链接列表中。如果可以解析某些证书，则结果是它遇到的失败证书的数量。 如果没有正确完成，则返回第一个错误。
 
@@ -229,7 +257,9 @@ int mbedtls_ctr_drbg_seed( mbedtls_ctr_drbg_context *ctx,
 
 - **设置主机名**
 
-> int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
+```c
+int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
+```
 
 注意，这里设置的 `hostname` 必须对应服务器证书中的 `common name`，即 CN 字段。
 
@@ -252,7 +282,10 @@ int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
 | 无             | 无 |
 
 - **设置证书验证模式**
-> void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
+
+```c
+void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
+```
 
 设置证书验证模式默认值：服务器上为 `MBEDTLS_SSL_VERIFY_NONE`，客户端上为 `MBEDTLS_SSL_VERIFY_REQUIRED` 或者 `MBEDTLS_SSL_VERIFY_OPTIONAL`（默认使用）。
 
@@ -365,7 +398,9 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
 
 - **SSL/TLS 握手接口**
 
-> int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
+```c
+int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
+```
 
 执行 SSL/TLS 握手操作。
 
@@ -383,7 +418,9 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
 
 - **获取证书验证结果**
 
-> uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
+```c
+uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
+```
 
 | 参数           | 描述    |
 | :-----         | :-----  |
@@ -416,7 +453,9 @@ int mbedtls_x509_crt_verify_info( char *buf, size_t size,
 
 **SSL/TLS 写函数**
 
-> int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
+```c
+int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
+```
 
 从 SLL/TLS 读取数据，最多读取 'len' 字节长度数据字节。
 
@@ -435,7 +474,9 @@ int mbedtls_x509_crt_verify_info( char *buf, size_t size,
 
 **SSL/TLS 读函数**
 
-> int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
+```c
+int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
+```
 
 向 SSL/TLS 写入数据，最多写入 'len' 字节长度数据。
 

docs/introduction.md

@@ -1,6 +1,6 @@
 # 软件包介绍
 
-> [**mbedtls**](https://github.com/RT-Thread-packages/mbedtls) 软件包是 **RT-Thread** 基于 [ARMmbed/mbedtls](https://github.com/ARMmbed/mbedtls/) 开源库的移植。
+ [**mbedtls**](https://github.com/RT-Thread-packages/mbedtls) 软件包是 **RT-Thread** 基于 [ARMmbed/mbedtls](https://github.com/ARMmbed/mbedtls/) 开源库的移植。
 
 **mbedTLS**（前身 PolarSSL）是一个由 ARM 公司开源和维护的 SSL/TLS 算法库。其使用 C 编程语言以最小的编码占用空间实现了 SSL/TLS 功能及各种加密算法，易于理解、使用、集成和扩展，方便开发人员轻松地在嵌入式产品中使用 SSL/TLS 功能。
 
@@ -24,7 +24,7 @@ mbedTLS 软件包提供了一组可以单独使用和编译的加密组件，各
 
 **ports** 目录是 RT-Thread 移植 mbedtls 软件包时所涉及到的移植文件，使用 scons 进行重新构建。
 
-```shell
+```c
 mbedtls
 |   LICENSE                         // 软件包许可协议
 |   README.md                       // 软件包使用说明

docs/samples.md

@@ -63,42 +63,42 @@ SSL/TLS 服务器进行证书校验的过程中，会对当前发起校验请求
 
     未同步过时间的设备输入 **`date`** 命令后如下所示：
 
-    ```c
-    msh />date
-    Thu Jan  1 00:00:06 1970
-    ```
+```c
+msh />date
+Thu Jan  1 00:00:06 1970
+```
 
     使用 **`date`** 设置当前时间，如下所示：
 
-    ```c
-    msh />date 2018 08 02 12 23 00
-    msh />date
-    Thu Aug  2 12:23:01 2018
-    msh />
-    ```
+```c
+msh />date 2018 08 02 12 23 00
+msh />date
+Thu Aug  2 12:23:01 2018
+msh />
+```
 
 - 方式二： 使用 NTP 同步网络时间
 
     该方式需要依赖 NTP 工具包，使用 `menuconfig` 配置获取，如下所示：
 
-    ```c
-    RT-Thread online packages --->
-        IoT - internet of things  --->
-            -*- netutils: Networking utilities for RT-Thread  --->
-                -*-   Enable NTP(Network Time Protocol) client
-                (8)     Timezone for calculate local time
-                (cn.ntp.org.cn) NTP server name
-    ```
+```c
+RT-Thread online packages --->
+    IoT - internet of things  --->
+        -*- netutils: Networking utilities for RT-Thread  --->
+            -*-   Enable NTP(Network Time Protocol) client
+            (8)     Timezone for calculate local time
+            (cn.ntp.org.cn) NTP server name
+```
 
     使用命令 **`ntp_sync`** 同步网络时间
 
-    ```c
-    msh />ntp_sync
-    Get local time from NTP server: Thu Aug  2 14:31:30 2018
-    The system time is updated. Timezone is 8.
-    msh />date
-    Thu Aug  2 14:31:34 2018
-    ```
+```c
+msh />ntp_sync
+Get local time from NTP server: Thu Aug  2 14:31:30 2018
+The system time is updated. Timezone is 8.
+msh />date
+Thu Aug  2 14:31:34 2018
+```
 
 ## 启动例程
 

docs/user-guide.md

@@ -209,6 +209,7 @@ CA 证书有两种常用格式 **PEM 格式** 和 **DER** 格式，目前 RT-Thr
     **PEM 格式证书** 通常是以 **.pem** 和 **.cer** 后缀名结尾的文件。
 
     使用文本编辑器打开后，文件内容以 `-----BEGIN CERTIFICATE-----` 开头，以 `-----END CERTIFICATE-----` 结尾。
+
 - `DER 格式证书`
 
     **DER 格式证书** 是二进制文件类型。