summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2026-02-10 11:25:46 +0700
committerhathach <[email protected]>2026-02-10 11:25:46 +0700
commite7c71fefa7576e971c6bb05c1a5bab6075bd044f (patch)
tree7bf3443577ace1ee355231fd6cc707833465f57a
parent320d0f88bf7f3c8fb9e2e8c86e55051a0d0980aa (diff)
update getting_started.rst and get_deps.py for clarity and improved dependency handling
-rw-r--r--docs/getting_started.rst2
-rwxr-xr-xtools/get_deps.py24
2 files changed, 8 insertions, 18 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index b7a962d50..8442305d4 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -37,7 +37,7 @@ Get the Code
Some MCU families require additional SDKs, please follow their instructions to install and set it up
* **rp2040**: Requires `pico-sdk <https://github.com/raspberrypi/pico-sdk>`_
- * **Espressif (esp32)**: Requires `esp-idf <https://github.com/espressif/esp-idf>`_
+ * **Espressif (esp32)**: Requires `esp-idf <https://github.com/espressif/esp-idf>`_. Only a few examples support the ESP-IDF build system. Look for ones with `src/CMakeLists.txt` that contain `idf_component_register()`, such as `cdc_msc_freertos`.
Simple Device Example
---------------------
diff --git a/tools/get_deps.py b/tools/get_deps.py
index deacbb23b..51c2b1012 100755
--- a/tools/get_deps.py
+++ b/tools/get_deps.py
@@ -327,18 +327,16 @@ def main():
parser.add_argument('-b', '--board', action='append', default=[], help='Boards to fetch')
parser.add_argument('-D', '--define', action='append', default=[], help='Have no effect')
parser.add_argument('-f1', '--build-flags-on', action='append', default=[], help='Have no effect')
- parser.add_argument('--print', action='store_true', help='Print commit hash only')
args = parser.parse_args()
families = args.families
boards = args.board
- print_only = args.print
status = 0
- deps = list(deps_mandatory.keys())
+ deps = []
if 'all' in families:
- deps += deps_optional.keys()
+ deps.extend(deps_optional.keys())
else:
families = list(families)
if boards is not None:
@@ -346,24 +344,16 @@ def main():
f = find_family(b)
if f is not None:
families.append(f)
-
for f in families:
for d in deps_optional:
if d not in deps and f in deps_optional[d][2].split():
deps.append(d)
+ if len(deps) == 0:
+ print('WARN: no additional dependencies found for given boards or families')
- if print_only:
- pvalue = {}
- # print only without arguments, always add CMSIS_5
- if len(families) == 0 and len(boards) == 0:
- deps.append('lib/CMSIS_5')
- for d in deps:
- commit = deps_all[d][1]
- pvalue[d] = commit
- print(pvalue)
- else:
- with Pool() as pool:
- status = sum(pool.map(get_a_dep, deps))
+ deps.extend(deps_mandatory.keys())
+ with Pool() as pool:
+ status = sum(pool.map(get_a_dep, deps))
return status