Allow the user to specify output directory in `kbuild.toml`

Open
#4,207 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
build-system, cli

Research direction

Start by tracing how kbuild reads kbuild.toml, selects the default kdist directory, and dispatches commands. Add support for the relative [build] kdist-dir setting and the kbuild clean command; done means targets use the configured directory and clean removes only directories corresponding to targets, without deleting the directory wholesale.

Written by the indexing model from the issue text.

Description

kbuild pyk

If no command line option is specified for the output directory, kbuild puts kompiled targets under kdist in the project root.

Introduce a field like

[build]
kdist-dir = "foo/bar"

in kbuild.toml to allow the user to override the default. The value is a relative path within the project.

Add a command kbuild clean that removes from kdist-dir directories that correspond to targets. (Note: deleting kdist-dir altogether is probably not safe, as the user might accidentally specify directories that contain files other than kompiled targets.)

Dominant language
Python
Stars
591
Forks
163
No merged PRs in 30d

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.

More from runtimeverification/k

All issues in runtimeverification/k

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.