microsoft / microsoft/vscode-cmake-tools

Source and build directories should be configurable per kit

Open
#3,827 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Feature: kits
Dominant language
TypeScript
Stars
1.7k
Forks
546
Avg merge
2d 16h
Merged PRs (30d)
32

Description

Brief Issue Summary

I work on LLVM, which is a federation of CMake projects. For example, cmake -S /path/to/llvm-project/llvm configures a build directory for building all of LLVM, while cmake -S /path/to/llvm-project/runtimes will only configure a directory for building the runtimes subproject (similarly for cmake -S /path/to/llvm-project/clang, cmake -S /path/to/llvm-project/lldb, etc.). It would be nice to specify the source directory per kit, so that I don't risk forgetting to change it when swapping from subproject to subproject.

Similarly, it would be good for each kit to specify its own build directory. This will make A/B tests and profile-guided optimisation builds less painful.

CMake Tools Diagnostics

No response

Debug Log

No response

Additional Information

Here's what I'd like to see:

[
  {
    "name": "Build LLVM (stage 1)",
    "sourceDirectory": "${workspaceFolder}/llvm",
    "buildDirectory": "${workspaceFolder}/build/llvm-stage-1",
    "cmakeSettings": {
        // ...
    }
  },
  {
    "name": "Build LLVM (stage 2)",
    "sourceDirectory": "${workspaceFolder}/llvm",
    "buildDirectory": "${workspaceFolder}/build/llvm-stage-2",
    "cmakeSettings": {
        // ...
    }
  },
  {
    "name": "Build LLVM (stage 3)",
    "sourceDirectory": "${workspaceFolder}/llvm",
    "buildDirectory": "${workspaceFolder}/build/llvm-stage-3",
    "cmakeSettings": {
        // ...
    }
  },
  {
    "name": "Build Clang",
    "sourceDirectory": "${workspaceFolder}/clang",
    "buildDirectory": "${workspaceFolder}/build/clang",
    "cmakeSettings": {
        // ...
    }
  },
  {
    "name": "Build runtimes",
    "sourceDirectory": "${workspaceFolder}/runtimes",
    "buildDirectory": "${workspaceFolder}/build/runtimes",
    "cmakeSettings": {
        // ...
    }
  },
]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files, tests, or entry points are identified in the issue. Start by locating the kit configuration and the existing source- and build-directory handling, then compare it with the per-kit JSON examples. Done means separate kits can retain their own sourceDirectory and buildDirectory without requiring manual changes when switching kits.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, typescript
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.