summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorcliff-cmc <[email protected]>2021-02-26 11:09:27 +0800
committerCliff Chen <[email protected]>2021-02-26 11:45:19 +0800
commiteea0c3d74a40f73235da45c6f77e8b411ac94cf2 (patch)
treea6906f1aed7118ab53dbe18f2ee4727a754583af /documentation
parent1a9ecf27f31277750d92c921b62503f75275e122 (diff)
parentfae0fa8eea4c0e797940bf1eddc8ee6c1711734a (diff)
Add memtrace command for memheap.c
Diffstat (limited to 'documentation')
-rw-r--r--documentation/coding_style_cn.md37
-rw-r--r--documentation/coding_style_en.txt22
-rw-r--r--documentation/doxygen/systeminit.h6
3 files changed, 19 insertions, 46 deletions
diff --git a/documentation/coding_style_cn.md b/documentation/coding_style_cn.md
index 26bed9d045..9c4019d647 100644
--- a/documentation/coding_style_cn.md
+++ b/documentation/coding_style_cn.md
@@ -7,7 +7,7 @@
## 1.目录名称
-目录名称如果无特殊的需求,请使用全小写的形式;目录名称应能够反应部分的意思,例
+目录名称如果无特殊的需求,请使用全小写的形式;目录名称应能够反映部分的意思,例
如各芯片移植由其芯片名称构成或芯片类别构成;components 目录下能够反映组件的意义。
## 2.文件名称
@@ -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
+ */
```
例如采用如上的形式。
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/systeminit.h b/documentation/doxygen/systeminit.h
index d62aca59bb..c45eda4079 100644
--- a/documentation/doxygen/systeminit.h
+++ b/documentation/doxygen/systeminit.h
@@ -21,12 +21,6 @@
* - show version
* rt_show_version();
*
- * - initialize system tick
- * rt_system_tick_init();
- *
- * - initialize kernel object [deprecated]
- * rt_system_object_init();
- *
* - initialize timer system
* rt_system_timer_init();
*