docs: add 'Common Issues' section to README with steps for triggering index update in Vitis.

2024-10-28 13:57:10 +08:00
parent 41cca8c4e1
commit f9a2a2e0d9
1 changed files with 10 additions and 0 deletions
@@ -143,6 +143,16 @@

       其中 `%~dp0` 表示当前 `.bat` 文件所在目录。上述模板配置假设配置文件和相关工具脚本与 `.bat` 在同一目录，并在该目录下的 `build` 文件夹中创建工程。该脚本实现了自动创建工程并完成相关配置最后加载对应 IDE 的功能。

+## 常见问题
+
+1. 在 Xilinx Vitis 中打开构建的工程后，点击符号时可能无法跳转，并且在 IDE 左下角会显示如下错误信息：
+
+    ```plaintext
+    Could not find symbol 'XXXX' in index
+    ```
+
+    这是因为源文件在导入时被直接链接或复制到了工程目录中，未触发 C++ Indexer 更新索引。此外，新版本的 Vitis 没有直接的命令或 UI 选项来重建或更新索引。最简单的解决方法是随意打开一个源文件，在任意行末输入一个空格并保存。IDE 会自动删除该空格，不会对源文件造成任何更改，但此操作可触发索引的自动更新。
+
 ## 待办事项

 - [x] 支持 Xilinx SDK 的 XSCT 接口