llnl / llnl/blt

Create macro to help with deprecating options?

Open
#493 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

design question
Dominant language
C++
Stars
296
Forks
66
Avg merge
1h 3m
Merged PRs (30d)
1

Description

Should we create a new macro to help blt users to gracefully migrate configuration options?

This macro could:
* produce a custom warning message
* indicate which option should be used instead
* optionally cause a configuration error
* ...

e.g.
```cmake
blt_deprecated_option(
NAME foo # option to deprecate
MESSAGE "Using deprecated option...."
NEW_OPTION bar # use this instead
IS_CONFIG_ERROR false
...
)
```

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

Review BLT's existing CMake option-handling patterns, then assess the proposed blt_deprecated_option signature and its warning, replacement-option, and configuration-error requirements. Done should include an agreed macro design and implementation that supports the listed behaviors, with validation for each option.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake
Domain
build-system
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.