Don't overwrite .vscode config if it already exists #2182
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Referencing issue analogdevicesinc#2181. $(PROJECT_TARGET)_configure targets in maxim.mk and stm32.mk don't check if .vscode config files already exist and forcefully overwrite them with the defaults during every build. This adds some shell commands to only write the defaults if the files don't exist or are empty = when setting up the project = when we actually need those defaults. Signed-off-by: Ioan Dragomir <ioan.dragomir@analog.com>
trupples
requested review from
dbogdan,
amiclaus,
rbolboac,
SRaus,
AAndrisa,
CiprianRegus and
buha
as code owners
|
/AzurePipeline run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
@EoghanMonahan can you please take a look at this since you might be familiar with the topic? |
buha
approved these changes
May 15, 2024
dbogdan
approved these changes
May 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
(Referencing issue #2181, the following content is copied from there)
Behaviour
The
$(PROJECT_TARGET)_configuretargets in tools/scripts/stm32.mk and tools/scripts/maxim.mk use the GNU Makefilefunction to set up a default VS Code configuration for projects, with no regard to the contents of those files.no-OS/tools/scripts/maxim.mk
Lines 139 to 143 in 3cb5f58
For context, the content of the files is generated in vsc_intellisense.mk, vsc_openocd_debug.mk, and vsc_tasks.mk.
Impact
With the current makefiles, one may not change their VS Code config without it being reset to the no-OS defaults during the next build, which greatly hinders development. For instance, my WSL dev setup requires changing the gdb options in
launch.json, but doing so is futile because the makefile resets my changes when building.Options
I suggest (this PR) adding a condition to only write to these files if they are empty or don't exist (i.e., during project setup), but keep their current content otherwise, to allow for customization of the config.
Despite some effort, I didn't manage to do it using just GNU Make syntax, but rather by changing the
filecall fromfilename.jsontofilename.json.default, and having some shell commands conditionally copyfilename.json.defaulttofilename.jsonif the latter doesn't exist. Finally, shell commands remove the.defaultfiles to keep the directory tidy.PR Type
PR Checklist