VSCode Linux内核源码阅读环境

安装Clangd插件

在VSCode中,你可以通过以下步骤安装Clangd插件:

  • 打开VSCode;
  • 点击左侧的插件图标(Ctrl+Shift+X);
  • 搜索“Clangd”插件;
  • 点击“安装”按钮。

生成compile_commands.json

对于make项目来说,常规来讲,可以使用Bear来对源码生成compile_commands.json。首先安装Bear:

sudo apt install bear

然后在项目根目录下执行:

bear make -j32

编译完成后,会在项目根目录下生成compile_commands.json文件。

对于CMAKE项目来说,可以在CMakeLists.txt中添加以下语句,然后重新编译项目即可生成compile_commands.json文件:
set(CMAKE_EXPORT_COMPILE_COMMANDS True)

配置Clangd插件

进入到项目目录下,下载配置文件:

git clone --depth 1 https://github.com/Dunky-Z/dot-vscode.git .vscode

主要修改--compile-commands-dir参数,将其修改为自己的路径。

随便打开内核源码文件,clangd将会自动生成索引,并将索引文件.idx保存在项目根目录下的.cache目录中。

Linux-5.4
├── .cache
│   └── clangd
├── .config
├── .git

如果生成了索引文件,那么说明配置成功,可以打开源码文件看看是否能够正常跳转。