Skip to content

Commit

Permalink
Improve doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake-Carter committed Aug 23, 2024
1 parent cd1bf5b commit 06ea40d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/scripts/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,15 @@ def query_build_variable(project:Path, variable:str) -> list:
affects ME14). This is difficult because example projects do not have direct visibility
into library SRCS/VPATH for libraries that build a static file.
The format of the dependency map a dictionary:
dependency_map[TARGET] = [DEPENDENCIES]
where TARGET is the target micro's part number (ex: MAX78000)
and DEPENDENCIES is a list of absolute paths as strings (ex: ['/home/jhcarter/repos/msdk/Examples/MAX32690/ADC',
'/home/jhcarter/repos/msdk/Examples/MAX32690/ADC/board.c',
'/home/jhcarter/repos/msdk/Examples/MAX32690/ADC/heap.c',
...])
the paths may be a file or a folder.
"""
def create_dependency_map(maxim_path:Path, targets:list) -> dict:
dependency_map = dict()
Expand Down Expand Up @@ -195,6 +204,9 @@ def create_dependency_map(maxim_path:Path, targets:list) -> dict:

return dependency_map

"""
Return a list of target microcontrollers that are affected by a change to the specified file.
"""
def get_affected_targets(dependency_map: dict, file: Path) -> list:
file = Path(file)
affected = []
Expand Down

0 comments on commit 06ea40d

Please sign in to comment.