From 3ada35e8632d29095857b303faf778ed76209d75 Mon Sep 17 00:00:00 2001 From: Gatsby Van Date: Mon, 28 Oct 2024 17:39:46 +0800 Subject: [PATCH] docs(platform/xilinx): add description for `sources` section, fix typos Added a description of the `sources` field, detailing its use of relative paths and wildcard support. Fixed minor typos for clarity. --- platform/xilinx/HOWTO.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/platform/xilinx/HOWTO.md b/platform/xilinx/HOWTO.md index dec91c8..3f339d7 100644 --- a/platform/xilinx/HOWTO.md +++ b/platform/xilinx/HOWTO.md @@ -171,13 +171,13 @@ } ``` -- **sources**: 源文件列表(相对配置文件路径); +- **sources**: 源文件列表,应为相对当前配置文件的路径,可使用通配符。例如,`"src/*"` 会将配置文件所在目录下的 `src` 文件夹中的所有文件复制或链接到相应工程目录下的 `src` 文件夹中。 - **target_cpu**: 目标 CPU ID[^2]; - **os**: 操作系统类型[^1],必须与 BSP/Domain 匹配; - **language**: 编程语言,"C" 或 "C++"; - *bsp*: 应用所使用的 BSP 名称,若未指定则会自动创建名为 `_` 的 BSP/Domain. -- *bsp_lib*: 针对自动创建的 BSP/Domain 所使用库的配置,与 [bsps](#-bsps) 中 `libs` 对应; -- *bsp_config*: 针对自动创建的 BSP/Domain 配置与 [bsps](#-bsps) 中 `config` 对应; +- *bsp_lib*: 针对自动创建的 BSP/Domain 所使用库的配置,与 [bsps](#bsps) 中 `libs` 对应; +- *bsp_config*: 针对自动创建的 BSP/Domain 配置与 [bsps](#bsps) 中 `config` 对应; - *mem_layout*: 应用内存布局,包括堆栈大小和堆大小等; -*heap_size*: 堆大小,必须写为十六进制,例如 "0x80000"; -*stack_size*: 栈大小,必须写为十六进制,例如 "0x4000";