From 06ea40d8bbe5f5fa6a68f65324d86e343b94744b Mon Sep 17 00:00:00 2001 From: Jake Carter Date: Fri, 23 Aug 2024 17:55:09 -0600 Subject: [PATCH] Improve doc strings --- .github/workflows/scripts/build.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/scripts/build.py b/.github/workflows/scripts/build.py index 2748e1f39d..3619dffd31 100644 --- a/.github/workflows/scripts/build.py +++ b/.github/workflows/scripts/build.py @@ -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() @@ -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 = []