feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

docs(soc): improved soc caps generation documentation

Browse Source
This commit is contained in:
Jakob Hasse
2023-11-15 12:10:26 +08:00
parent 82a110c7f3
commit 46e44ee154
10 changed files with 18 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/soc/esp32/include/soc/soc_caps.h
View File

@@ -32,9 +32,7 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py 'components/soc/esp32/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
*
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*/ */
#pragma once #pragma once

7
components/soc/esp32c2/include/soc/soc_caps.h
View File

@@ -16,11 +16,8 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py -d 'components/soc/esp32c2/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
* */
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*
*/
#pragma once #pragma once

7
components/soc/esp32c3/include/soc/soc_caps.h
View File

@@ -16,11 +16,8 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py -d 'components/soc/esp32c3/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
* */
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*
*/
#pragma once #pragma once

7
components/soc/esp32c6/include/soc/soc_caps.h
View File

@@ -16,11 +16,8 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py -d 'components/soc/esp32c6/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
* */
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*
*/
#pragma once #pragma once

7
components/soc/esp32h2/include/soc/soc_caps.h
View File

@@ -16,11 +16,8 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py -d 'components/soc/esp32h2/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
* */
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*
*/
#pragma once #pragma once

7
components/soc/esp32p4/include/soc/soc_caps.h
View File

@@ -16,11 +16,8 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py 'components/soc/esp32p4/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
* */
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*
*/
#pragma once #pragma once

4
components/soc/esp32s2/include/soc/soc_caps.h
View File

@@ -31,9 +31,7 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py 'components/soc/esp32s2/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
*
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*/ */
#pragma once #pragma once

7
components/soc/esp32s3/include/soc/soc_caps.h
View File

@@ -16,11 +16,8 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py 'components/soc/esp32s3/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
* */
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*
*/
#pragma once #pragma once

7
components/soc/linux/include/soc/soc_caps.h
View File

@@ -16,11 +16,8 @@
* If this file is changed the script will automatically run the script * If this file is changed the script will automatically run the script
* and generate the kconfig variables as part of the pre-commit hooks. * and generate the kconfig variables as part of the pre-commit hooks.
* *
* It can also be ran manually with `./tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py 'components/soc/esp32c3/include/soc/'` * It can also be run manually. For more information, see `${IDF_PATH}/tools/gen_soc_caps_kconfig/README.md`
* */
* For more information see `tools/gen_soc_caps_kconfig/README.md`
*
*/
/* /*
* NOTE: These definitions are only meant to allow host-based unit testing of some features using CMock. * NOTE: These definitions are only meant to allow host-based unit testing of some features using CMock.

4
tools/gen_soc_caps_kconfig/README.md
View File

@@ -4,9 +4,9 @@
The script will automatically run as part of the pre-commit hook if any of the `soc_caps` related files have been modified. The script will automatically run as part of the pre-commit hook if any of the `soc_caps` related files have been modified.
To run it manually from IDF_PATH run: To run it manually, navigate to `${IDF_PATH}` and execute:
`python tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py 'components/soc/*/include/soc/'` `python tools/gen_soc_caps_kconfig/gen_soc_caps_kconfig.py -d 'components/soc/*/include/soc/'`
The results are `kconfig.soc_caps.in`-files containing the bool/int/hex/string values defined in the `soc_caps.h` file. The results are `kconfig.soc_caps.in`-files containing the bool/int/hex/string values defined in the `soc_caps.h` file.