alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-30 19:19:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'bugfix/docs_PROJECT_VER' into 'master'

Browse Source 
Updated documentation concerning 'PROJECT_VER' and 'PROJECT_NAME'.

See merge request idf/esp-idf!4410
This commit is contained in:
Ivan Grokhotkov
2019-03-06 17:29:10 +08:00
parent c1e50c8a27 88b153fcf7
commit ea0a1c3030
3 changed files with 10 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/en/api-guides/build-system-cmake.rst
View File

@@ -344,8 +344,8 @@ The following variables are set at the project level, but available for use in c
- ``IDF_TARGET``: Name of the target for which the project is being built.
- ``PROJECT_VER``: Project version.
* If ``PROJECT_VER`` variable set in project CMakeLists.txt file, its value will be used.
* Else, if the ``${PROJECT_PATH}/version.txt`` exists, its contents will be used as ``PROJECT_VER``.
* If ``PROJECT_VER`` variable is set in project CMakeLists.txt file, its value will be used.
* Else, if the ``$(PROJECT_PATH}/version.txt`` exists, its contents will be used as ``PROJECT_VER``.
* Else, if the project is located inside a Git repository, the output of git describe will be used.
* Otherwise, ``PROJECT_VER`` will be "1".
@@ -426,10 +426,8 @@ Preprocessor Definitions
The ESP-IDF build system adds the following C preprocessor definitions on the command line:
- ``ESP_PLATFORM`` ： Can be used to detect that build happens within ESP-IDF.
- ``IDF_VER`` ： Defined to a git version string. E.g. ``v2.0`` for a tagged release or ``v1.0-275-g0efaa4f`` for an arbitrary commit.
- ``PROJECT_VER``: The project version, see `Preset Component Variables`_ for more details.
- ``PROJECT_NAME``: Name of the project, as set in project CMakeLists.txt file.
- ``ESP_PLATFORM`` : Can be used to detect that build happens within ESP-IDF.
- ``IDF_VER`` : Defined to a git version string. E.g. ``v2.0`` for a tagged release or ``v1.0-275-g0efaa4f`` for an arbitrary commit.
Component Requirements
======================

10
docs/en/api-guides/build-system.rst
View File

@@ -190,10 +190,10 @@ The following variables are set at the project level, but exported for use in th
- ``IDF_VER``: ESP-IDF version, retrieved from either ``$(IDF_PATH)/version.txt`` file (if present) else using git command ``git describe``. Recommended format here is single liner that specifies major IDF release version, e.g. ``v2.0`` for a tagged release or ``v2.0-275-g0efaa4f`` for an arbitrary commit. Application can make use of this by calling :cpp:func:`esp_get_idf_version`.
- ``PROJECT_VER``: Project version.
* If ``PROJECT_VER`` variable set in project Makefile file, its value will be used.
* Else, if the ``$PROJECT_PATH/version.txt`` exists, its contents will be used as ``PROJECT_VER``.
* Else, if the project is located inside a Git repository, the output of git describe will be used.
* Otherwise, ``PROJECT_VER`` will be "1".
* If ``PROJECT_VER`` variable is set in project Makefile file, its value will be used.
* Else, if the ``$PROJECT_PATH/version.txt`` exists, its contents will be used as ``PROJECT_VER``.
* Else, if the project is located inside a Git repository, the output of git describe will be used.
* Otherwise, ``PROJECT_VER`` will be "1".
If you modify any of these variables inside ``component.mk`` then this will not prevent other components from building but it may make your component hard to build and/or debug.
@@ -309,8 +309,6 @@ ESP-IDF build systems adds the following C preprocessor definitions on the comma
- ``ESP_PLATFORM`` — Can be used to detect that build happens within ESP-IDF.
- ``IDF_VER`` — ESP-IDF version, see `Preset Component Variables`_ for more details.
- ``PROJECT_VER``: The project version, see `Preset Component Variables`_ for more details.
- ``PROJECT_NAME``: Name of the project, as set in project Makefile.
Build Process Internals
-----------------------