# vscode-linux-kernel

**Repository Path**: yonglei717/vscode-linux-kernel

## Basic Information

- **Project Name**: vscode-linux-kernel
- **Description**: Visual Studio Code project/compile_commands.json generator for Linux kernel sources and out-of-tree modules
- **Primary Language**: Unknown
- **License**: Unlicense
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-11
- **Last Updated**: 2023-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Visual Studio Code project for Linux kernel sources
===================================================

Ensure the kernel is built (at least, all `*.cmd` files should be generated):

    $ make defconfig
    $ make

Clone this repository as ".vscode":

    $ git clone git@github.com:amezin/vscode-linux-kernel.git .vscode

Generate compile_commands.json:

    $ python .vscode/generate_compdb.py

If you are not compiling kernel for x64, change `intelliSenseMode` in
`c_cpp_properties.json`. Possible values as of vscode-cpptools 1.0.1:

* `gcc-x86`
* `gcc-x64`
* `gcc-arm`
* `gcc-arm64`

Open the project:

    $ code .

Out-of-tree builds
------------------

https://github.com/amezin/vscode-linux-kernel/issues/4

Kernel can be built with separate output directory:

    $ make O=../linux-build defconfig
    $ make O=../linux-build

In this case, you should pass the directory to `generate_compdb.py`:

    $ python .vscode/generate_compdb.py -O ../linux-build

`compile_commands.json` will still be generated in the current directory (root of the `linux` repository).
Unfortunately, `tasks.json` will not work out of the box in this configuration (TODO).

Out-of-tree module development
------------------------------

If you build your module with this command:

    $ make -C $KDIR M=$PWD modules

You could generate `compile_commands.json` with:

    $ python .vscode/generate_compdb.py -O $KDIR $PWD

Example: https://github.com/amezin/nzxt-rgb-fan-controller-dkms