Allow a 'paths-relative-to' key in the firmware config #70
Conversation
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
… final fw_configs fw_configs will always be a dictionnary, but individual ones might not.
configs paths-relative-to can be CWD, THIS_FILE, or a literal path. It defaults to CWD. The firmware configs will be patched accordingly: binary paths will be prefixed by either the current working directory (this is the old behaviour), the directory containing the firmware config file, or the literal path.
rgantois
requested changes
Jul 24, 2025
| def patch_firmware_image_paths(fw_config: dict, this_file_path: str) -> dict: | ||
| paths_relative_to_conf = fw_config.pop("paths-relative-to", "CWD") | ||
| if paths_relative_to_conf == "CWD": | ||
| path_relative_to = os.getcwd() |
There was a problem hiding this comment.
As mentioned in your PR message, I'd prefer we didn't modify the path at all if "CWD" is specified. I'm pretty sure it wouldn't change anything but I'd rather not take an unnecessary risk.
| @@ -76,6 +77,20 @@ def check_soc_model(soc_model: str): | |||
| return None | |||
|
|
|||
|
|
|||
| def patch_firmware_image_paths(fw_config: dict, this_file_path: str) -> dict: | |||
There was a problem hiding this comment.
This function doesn't actually need to return anything. It just modifies the dict in-place.
| @@ -76,6 +77,20 @@ def check_soc_model(soc_model: str): | |||
| return None | |||
|
|
|||
|
|
|||
| def patch_firmware_image_paths(fw_config: dict, this_file_path: str) -> dict: | |||
| paths_relative_to_conf = fw_config.pop("paths-relative-to", "CWD") | |||
There was a problem hiding this comment.
This is a user interface change, so it needs to be documented. You can describe this configuration option in docs/fw_binaries.md, in the introduction section.
| @@ -127,6 +142,7 @@ def init_config(args: list): | |||
| cli_error( | |||
| f"firmware config passed to CLI did not evaluate to dict: {fw_configs}" | |||
| ) | |||
| fw_config_file = patch_firmware_image_paths(fw_config_file, path) | |||
There was a problem hiding this comment.
nit: I'd prefer "complete_fw_paths()"
also, as mentioned above, this function doesn't return anything.
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 #68
paths-relative-to can be CWD, THIS_FILE, or a literal path. It defaults
to CWD.
The firmware configs will be patched accordingly: binary paths will be
prefixed by either the current working directory (this is the old
behaviour), the directory containing the firmware config file, or the
literal path.
Let me know if you prefer the CWD behaviour to do nothing (like the current behaviour) instead of prefixing with os.getcwd().