diff options
| author | yangjie11 <[email protected]> | 2020-11-18 09:56:35 +0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2020-11-18 09:56:35 +0800 |
| commit | d4a682e8d97fa131e5a8d795f8c5451d55cdd5b0 (patch) | |
| tree | 4773b40cb012475c5daf74bfd55707e141477669 /documentation | |
| parent | 2b98f4720c827ae1850df78299f6b273d568c8c7 (diff) | |
| parent | 2ef3c9d861f55253620996a94831a4be31ca6620 (diff) | |
Merge pull request #3 from RT-Thread/master
sync
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/coding_style_cn.md | 39 | ||||
| -rw-r--r-- | documentation/coding_style_en.txt | 22 | ||||
| -rw-r--r-- | documentation/doxygen/kernel.h | 2 | ||||
| -rw-r--r-- | documentation/figures/architecture.png | bin | 0 -> 86850 bytes | |||
| -rw-r--r-- | documentation/figures/architecturezh.png | bin | 0 -> 74621 bytes | |||
| -rw-r--r-- | documentation/figures/qrcode.png | bin | 0 -> 39623 bytes | |||
| -rw-r--r-- | documentation/figures/studio.gif | bin | 0 -> 1439881 bytes | |||
| -rw-r--r-- | documentation/figures/studiozh.gif | bin | 0 -> 1352959 bytes |
8 files changed, 21 insertions, 42 deletions
diff --git a/documentation/coding_style_cn.md b/documentation/coding_style_cn.md index 0aff3cb543..80662ee959 100644 --- a/documentation/coding_style_cn.md +++ b/documentation/coding_style_cn.md @@ -36,31 +36,16 @@ C语言头文件为了避免多次重复包含,需要定义一个符号。这� 在每个源文件文件头上,应该包括相应的版权信息,Change Log 记录: ```c - /* - * File : rtthread.h - * This file is part of RT-Thread RTOS - * COPYRIGHT (C) 2006 - 2012, RT-Thread Development Team - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License along - * with this program; if not, write to the Free Software Foundation, Inc., - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - * - * Change Logs: - * Date Author Notes - * 2006-03-18 Bernard the first version - * 2006-04-26 Bernard add semaphore APIs - * ... - */ +/* + * Copyright (c) 2006-2020, RT-Thread Development Team + * + * SPDX-License-Identifier: Apache-2.0 + * + * Change Logs: + * Date Author Notes + * 2006-03-18 Bernard the first version + * 2006-04-26 Bernard add semaphore APIs + */ ``` 例如采用如上的形式。 @@ -131,7 +116,7 @@ C语言头文件为了避免多次重复包含,需要定义一个符号。这� } ``` -唯一的例外是 swtich 语句,switch-case 语句采用 case 语句与 swtich 对齐的方式, +唯一的例外是 switch 语句,switch-case 语句采用 case 语句与 switch 对齐的方式, 例如: ```c @@ -173,7 +158,7 @@ case 语句与前面的 switch 语句对齐,后续的语句则采用缩进的� } ``` -建议在括号前留出一个空格(涉及的包括 if、for、while、swtich 语句),而运算表达式 +建议在括号前留出一个空格(涉及的包括 if、for、while、switch 语句),而运算表达式 中,运算符与字符串间留一个空格。另外,不要在括号的表达式两侧留空格,例如: ```c diff --git a/documentation/coding_style_en.txt b/documentation/coding_style_en.txt index 4eae4f52dd..9ebc72f6d4 100644 --- a/documentation/coding_style_en.txt +++ b/documentation/coding_style_en.txt @@ -42,22 +42,16 @@ In every header file, there should be copyright information and Change Log record like this: /* - * File : rtthread.h - * This file is part of RT-Thread RTOS - * COPYRIGHT (C) 2006, RT-Thread Development Team - * - * The license and distribution terms for this file may be - * found in the file LICENSE in this distribution or at - * http://www.rt-thread.org/license/LICENSE. - * - * Change Logs: - * Date Author Notes - * 2006-03-18 Bernard the first version - * 2006-04-26 Bernard add semaphore APIs - * ... + * Copyright (c) 2006-2020, RT-Thread Development Team + * + * SPDX-License-Identifier: Apache-2.0 + * + * Change Logs: + * Date Author Notes + * 2006-03-18 Bernard the first version + * 2006-04-26 Bernard add semaphore APIs */ - 5. Structure Defines Please name structures in lower-case and connect words with "_". For example: diff --git a/documentation/doxygen/kernel.h b/documentation/doxygen/kernel.h index b54144780b..527ce835f0 100644 --- a/documentation/doxygen/kernel.h +++ b/documentation/doxygen/kernel.h @@ -87,7 +87,7 @@ * priority would get the resource. * * RT-Thread operating systems supports event/fast event, mail box and message queue. - * - The event mechanism is used to awake a thead by setting one or more corresponding + * - The event mechanism is used to awake a thread by setting one or more corresponding * bit of a binary number when an event ocurs. * - The fast event supports event thread queue. Once a one bit event occurs, the corresponding * blocked thread can be found out timing accurately, then will be waked up. diff --git a/documentation/figures/architecture.png b/documentation/figures/architecture.png Binary files differnew file mode 100644 index 0000000000..8f91aa39ae --- /dev/null +++ b/documentation/figures/architecture.png diff --git a/documentation/figures/architecturezh.png b/documentation/figures/architecturezh.png Binary files differnew file mode 100644 index 0000000000..efd6845e4a --- /dev/null +++ b/documentation/figures/architecturezh.png diff --git a/documentation/figures/qrcode.png b/documentation/figures/qrcode.png Binary files differnew file mode 100644 index 0000000000..0ccb9e34a5 --- /dev/null +++ b/documentation/figures/qrcode.png diff --git a/documentation/figures/studio.gif b/documentation/figures/studio.gif Binary files differnew file mode 100644 index 0000000000..73c7d245ce --- /dev/null +++ b/documentation/figures/studio.gif diff --git a/documentation/figures/studiozh.gif b/documentation/figures/studiozh.gif Binary files differnew file mode 100644 index 0000000000..bb2a540451 --- /dev/null +++ b/documentation/figures/studiozh.gif |
