cs

cs is a script that generates cscope and clangd databases of compiled sources for large C/C++ projects, such as the Linux kernel. It also supports U-Boot, QEMU, FreeBSD, LLVM, UEFI, and ninja-based projects.

# cs help
Usage:

       [KBUILD_ABS_SRCTREE=1] [SYMLINKS=1]   cs [dir/]
       [KBUILD_ABS_SRCTREE=1] [SYMLINKS=1]   cs find [dir/]
       [KBUILD_ABS_SRCTREE=1]                cs freebsd
       [KBUILD_ABS_SRCTREE=1] [SYMLINKS=1]   cs llvm
       [KBUILD_ABS_SRCTREE=1] [SYMLINKS=1]   cs ninja
       [KBUILD_ABS_SRCTREE=1] [SYMLINKS=1]   cs qemu
       [KBUILD_ABS_SRCTREE=1] [SYMLINKS=1]   cs uboot
       [KBUILD_ABS_SRCTREE=1] [SYMLINKS=1]   cs uefi

  make [KBUILD_ABS_SRCTREE=1] COMPILED_SOURCE=1 [O=dir/] cscope compile_commands.json
                                                         ↓              ↓
                                                         for cscope     for clangd

For certain projects like the Linux Kernel, the cs command must be run from the directory where the .config file is located.

Installation

Make the cs script available in your system's PATH. You can either download it directly or link it from this repository if you have it cloned.

Method 1: Direct Download

curl https://raw.githubusercontent.com/vimuxx/cscope_maps.vim/master/cs -o /usr/local/bin/cs
chmod +x /usr/local/bin/cs

Method 2: Symbolic Link

If you have this repository cloned (e.g., as part of a vim configuration like .vim), you can link the script:

ln -s /path/to/cscope_maps.vim/cs /usr/local/bin/cs

Important Prerequisites

For all subcommands except find, you must compile your target project before running the cs script.

It functions by analyzing build artifacts (e.g., .d, .cmd files) generated during compilation. An uncompiled project will cause script failure or yield empty results. The find subcommand is the only exception, as it operates on source files directly.