Skip to content

Commit 5841a0d

Browse files
committed
Merge branch 'docs/little-fix' into 'main'
docs: clarify naming convention for override_path dependencies See merge request espressif/idf-component-manager!548
2 parents 6a578a1 + 4584724 commit 5841a0d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/en/reference/manifest_file.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -609,8 +609,13 @@ Example:
609609
610610
dependencies:
611611
# This component exists in the ESP Component Registry, but we want to use a local version
612-
published_component:
613-
override_path: ../../projects/local_version_of_published_component
612+
example/cmp:
613+
override_path: ../../projects/local_version_of/example__cmp
614+
# Alternative: ../../projects/local_version_of/cmp
615+
616+
.. note::
617+
618+
The dependency name (``example/cmp`` in the example above) should match the directory name at the end of the override path. The ESP-IDF build system uses the `directory name as the component name <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html#cmake-component-properties>`_, so the directory of the override_path should match the component name. If you want to specify the full name of the component with the namespace, replace `/` in the component name with `__`.
614619

615620
.. _git-source:
616621

0 commit comments

Comments
 (0)