rt-thread-official/tools/release
Meco Man dd1906ca24 [tools] remove kconfig-frontends 2024-06-30 22:35:34 +08:00
..
README.md [tools] remove kconfig-frontends 2024-06-30 22:35:34 +08:00
buildbot.py [tool][release] add tools/release folder for the scrips that prepare the version release 2023-05-15 09:03:04 -04:00
run-clang-format.py [clang-format] 增加clang-format格式化配置,通过ide或者手动运行tools/run-clang-format.py进行代码自动格式化 2024-04-21 01:18:37 -04:00
stm32_update.py [tool][release] add tools/release folder for the scrips that prepare the version release 2023-05-15 09:03:04 -04:00

README.md

版本发布前自动更新与部署

在ENV环境下并在release文件夹下执行 python buildbot.py update 可完成自动版本发布 部分 准备工作。 欢迎补充其他发布前自动化脚本。

目前可以自动更新和部署的内容包括:

  1. 更新所有BSP工程包括.config文件、rtconfig文件更新以及Keil\IAR等工程的刷新
  2. STM32启动文件更新
    1. 对gcc的汇编启动文件中main替换为entry函数
    2. 将启动文件heap降为0(Keil IAR)
    3. 将GCC的堆大小扩展到0x400与Keil IAR保持一致

clang-format代码自动格式化

run-clang-format.py 根据.clang-format.clang-format-ignore文件使用clang-format工具对代码进行格式化。

如果不希望对某个文件夹进行格式化,那么在该文件夹下增加一个.clang-format,内容为:

---
Language: Cpp
DisableFormat: true
---

如果不希望对某个代码片段进行格式化,那么在代码中插入// clang-format off/on

int formatted_code;
// clang-format off
    void    unformatted_code  ;
// clang-format on
void formatted_code_again;

使用以下命令将对除了bsp、elmfat、lwip等文件夹之外的所有代码进行格式化

# 安装clang-format
pip install clang-format
# 切换到RTT目录
cd $RTT_ROOT
# 执行格式化
# -r递归子目录-i是将格式化结果写入文件-e是排除目录-j是并行线程.是当前目录
python tools/release/run-clang-format.py -r -i -e bsp/**/* -j 10 .

如果格式化过程中提示以下错误一般是文件中存在UTF-8编码无法识别的字符。

error: Command 'clang-format -i libcpu\aarch64\common\asm-fpu.h' returned non-zero exit status 1