Merge branch 'docs/consistent_naming_convention_for_ESP_Component_Registry' into 'master'

docs: Consistent naming convention for ESP Component Registry

See merge request espressif/esp-idf!31205
This commit is contained in:
Daniel Paul
2024-07-29 17:30:33 +08:00
35 changed files with 61 additions and 60 deletions

View File

@@ -19,7 +19,7 @@ The following C++ features are supported:
``esp-idf-cxx`` Component
-------------------------
`esp-idf-cxx <https://github.com/espressif/esp-idf-cxx>`_ component provides higher-level C++ APIs for some of the ESP-IDF features. This component is available from the `ESP-IDF Component Registry <https://components.espressif.com/components/espressif/esp-idf-cxx>`_.
`esp-idf-cxx <https://github.com/espressif/esp-idf-cxx>`_ component provides higher-level C++ APIs for some of the ESP-IDF features. This component is available from the `ESP Component Registry <https://components.espressif.com/components/espressif/esp-idf-cxx>`_.
C++ Language Standard

View File

@@ -4,7 +4,7 @@ IDF Component Manager
:link_to_translation:`zh_CN:[中文]`
The IDF Component Manager is a tool that downloads dependencies for any ESP-IDF CMake project. The download happens automatically during a run of CMake. It can source components either from the `component registry <https://components.espressif.com>`__ or from a Git repository.
The IDF Component Manager is a tool that downloads dependencies for any ESP-IDF CMake project. The download happens automatically during a run of CMake. It can source components either from the `ESP Component Registry <https://components.espressif.com>`__ or from a Git repository.
A list of components can be found on `<https://components.espressif.com/>`__.
@@ -29,7 +29,7 @@ To add a dependency to a component (e.g., ``my_component``) in your ESP-IDF proj
.. note::
The command ``add-dependency`` adds dependencies to your project explicitly from the `Espressif Component Registry <https://components.espressif.com/>`__.
The command ``add-dependency`` adds dependencies to your project explicitly from the `ESP Component Registry <https://components.espressif.com/>`__.
To update dependencies of the ESP-IDF project, you can run the command ``idf.py update-dependencies``. You can also specify the path to the project directory using ``--project-dir PATH``.
@@ -50,19 +50,19 @@ You may set the build property ``DEPENDENCIES_LOCK`` to specify the lock-file pa
Creating a Project From an Example
==================================
Some components on the registry contain example projects. To create a new project from an example you can run the command ``idf.py create-project-from-example EXAMPLE``. The ``EXAMPLE`` argument should be in the format ``namespace/name=1.0.0:example`` where `namespace/name` is the name of the component, `=1.0.0` is a version range of the component (see the `Versioning Documentation <https://docs.espressif.com/projects/idf-component-manager/en/latest/reference/versioning.html>`__) and `example` is the example's name. You can find the list of examples for every component and the command to start a project for it in the `Espressif Component Registry <https://components.espressif.com/>`__.
Some components in the ESP Component Registry contain example projects. To create a new project from an example you can run the command ``idf.py create-project-from-example EXAMPLE``. The ``EXAMPLE`` argument should be in the format ``namespace/name=1.0.0:example`` where `namespace/name` is the name of the component, `=1.0.0` is a version range of the component (see the `Versioning Documentation <https://docs.espressif.com/projects/idf-component-manager/en/latest/reference/versioning.html>`__) and `example` is the example's name. You can find the list of examples for every component and the command to start a project for it in the `ESP Component Registry <https://components.espressif.com/>`__.
Defining Dependencies in the Manifest
=====================================
You can easily define dependencies in the manifest file ``idf_component.yml`` by editing it directly in the text editor. Below are some basic examples that demonstrate how to define dependencies.
You can define a dependency from the registry by specifying the component name and the version range:
You can define a dependency from the ESP Component Registry by specifying the component name and the version range:
.. code-block:: yaml
dependencies:
# Define a dependency from the registry (https://components.espressif.com/component/example/cmp)
# Define a dependency from the ESP Component Registry (https://components.espressif.com/component/example/cmp)
example/cmp: ">=1.0.0"
To define a dependency from a Git repository, provide the path to the component within the repository and the repository's URL: