Docs: Add CONFIG.md documenting config files, env vars, and precedence#530
Merged
pradeeban merged 2 commits intoControlCore-Project:devfrom Apr 3, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new single-source reference document for concore’s configuration system as implemented by mkconcore.py, covering supported config files, environment variables, and resolution/precedence rules.
Changes:
- Introduces
docs/CONFIG.mddocumentingCONCOREPATHresolution and supported legacy config files (concore.tools,concore.octave,concore.mcr,concore.sudo,concore.repo). - Documents tool key/variable mappings for compiler/runtime selection across platforms.
- Adds a stated precedence order and quick-start configuration examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
Closes #503
Adds
docs/CONFIG.mda single reference document for concore's configuration system. No code changes.What's Documented
concore.toolsall 14 supported keys (CPPEXE, PYTHONEXE, VEXE, etc.) with format, platform variants, and examplesconcore.octavepresence-based flag to treat.mfiles as Octaveconcore.mcrMATLAB Compiler Runtime pathconcore.sudoDocker executable override (sudo docker, podman, etc.)concore.repoDocker Hub repository prefix overrideCONCORE_*andDOCKEREXEvariables with defaultsWhy
Per mentor feedback on #503: "If your goal is to simply document these four files somewhere handy, go for it." This is purely additive documentation no code, no config format changes, no modifications to
mkconcore.py.Verified
pytest tests/ -v)ruff format --checkcleanmkconcore.py