Merge branch 'feature/removed_hyphens_from_examples' into 'master'

[examples]: Project names consistent with their directories

Closes IDFGH-3673

See merge request espressif/esp-idf!13570

docs/en/get-started/index.rst

@@ -489,11 +489,11 @@ This command will compile the application and all ESP-IDF components, then it wi
 
    ... (more lines of build system output)
 
-   [527/527] Generating hello-world.bin
+   [527/527] Generating hello_world.bin
    esptool.py v2.3.1
 
    Project build complete. To flash, run this command:
-   ../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin  build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
+   ../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello_world.bin  build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
    or run 'idf.py -p PORT flash'
 
 If there are no errors, the build will finish by generating the firmware binary .bin files.
@@ -504,7 +504,7 @@ If there are no errors, the build will finish by generating the firmware binary
 Step 9. Flash onto the Device
 =============================
 
-Flash the binaries that you just built (bootloader.bin, partition-table.bin and hello-world.bin) onto your {IDF_TARGET_NAME} board by running:
+Flash the binaries that you just built (bootloader.bin, partition-table.bin and hello_world.bin) onto your {IDF_TARGET_NAME} board by running:
 
 .. code-block:: bash
 
@@ -551,7 +551,7 @@ When flashing, you will see the output log similar to the following:
     .. code-block:: none
 
         ...
-        esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello-world.bin
+        esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello_world.bin
         esptool.py v3.0-dev
         Serial port /dev/ttyUSB0
         Connecting........_
@@ -591,7 +591,7 @@ When flashing, you will see the output log similar to the following:
     .. code-block:: none
 
         ...
-        esptool.py --chip esp32s2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello-world.bin
+        esptool.py --chip esp32s2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello_world.bin
         esptool.py v3.0-dev
         Serial port /dev/ttyUSB0
         Connecting....
@@ -631,7 +631,7 @@ When flashing, you will see the output log similar to the following:
     .. code-block:: none
 
         ...
-        esptool.py esp32s3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello-world.bin 0x8000 partition_table/partition-table.bin
+        esptool.py esp32s3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin
         esptool.py v3.2-dev
         Serial port /dev/ttyUSB0
         Connecting....
@@ -676,7 +676,7 @@ When flashing, you will see the output log similar to the following:
     .. code-block:: none
 
         ...
-        esptool.py --chip esp32c3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x0 bootloader/bootloader.bin 0x10000 hello-world.bin
+        esptool.py --chip esp32c3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin
         esptool.py v3.0
         Serial port /dev/ttyUSB0
         Connecting....
@@ -728,7 +728,7 @@ This command launches the :doc:`IDF Monitor <../api-guides/tools/idf-monitor>` a
 
     $ idf.py -p /dev/ttyUSB0 monitor
     Running idf_monitor in directory [...]/esp/hello_world/build
-    Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello-world.elf"...
+    Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello_world.elf"...
     --- idf_monitor on /dev/ttyUSB0 115200 ---
     --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
     ets Jun  8 2016 00:22:57

docs/zh_CN/get-started/index.rst

@@ -489,11 +489,11 @@ Windows 操作系统
 
     ... (more lines of build system output)
 
-    [527/527] Generating hello-world.bin
+    [527/527] Generating hello_world.bin
     esptool.py v2.3.1
 
     Project build complete. To flash, run this command:
-    ../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin  build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
+    ../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello_world.bin  build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
     or run 'idf.py -p PORT flash'
 
 如果一切正常，编译完成后将生成 .bin 文件。
@@ -504,7 +504,7 @@ Windows 操作系统
 第九步：烧录到设备
 =============================
 
-请使用以下命令，将刚刚生成的二进制文件 (bootloader.bin, partition-table.bin 和 hello-world.bin) 烧录至您的 {IDF_TARGET_NAME} 开发板：
+请使用以下命令，将刚刚生成的二进制文件 (bootloader.bin, partition-table.bin 和 hello_world.bin) 烧录至您的 {IDF_TARGET_NAME} 开发板：
 
 .. code-block:: bash
 
@@ -551,7 +551,7 @@ Windows 操作系统
     .. code-block:: none
 
         ...
-        esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello-world.bin
+        esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello_world.bin
         esptool.py v3.0-dev
         Serial port /dev/ttyUSB0
         Connecting........_
@@ -591,7 +591,7 @@ Windows 操作系统
     .. code-block:: none
 
         ...
-        esptool.py --chip esp32s2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello-world.bin
+        esptool.py --chip esp32s2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello_world.bin
         esptool.py v3.0-dev
         Serial port /dev/ttyUSB0
         Connecting....
@@ -631,7 +631,7 @@ Windows 操作系统
     .. code-block:: none
 
         ...
-        esptool.py esp32s3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello-world.bin 0x8000 partition_table/partition-table.bin
+        esptool.py esp32s3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin
         esptool.py v3.2-dev
         Serial port /dev/ttyUSB0
         Connecting....
@@ -676,7 +676,7 @@ Windows 操作系统
     .. code-block:: none
 
         ...
-        esptool.py --chip esp32c3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x0 bootloader/bootloader.bin 0x10000 hello-world.bin
+        esptool.py --chip esp32c3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin
         esptool.py v3.0
         Serial port /dev/ttyUSB0
         Connecting....
@@ -728,7 +728,7 @@ Windows 操作系统
 
     $ idf.py -p /dev/ttyUSB0 monitor
     Running idf_monitor in directory [...]/esp/hello_world/build
-    Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello-world.elf"...
+    Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello_world.elf"...
     --- idf_monitor on /dev/ttyUSB0 115200 ---
     --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
     ets Jun  8 2016 00:22:57

examples/get-started/hello_world/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(hello-world)
+project(hello_world)

examples/get-started/hello_world/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := hello-world
+PROJECT_NAME := hello_world
 
 include $(IDF_PATH)/make/project.mk

examples/peripherals/gpio/generic_gpio/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(generic-gpio)
+project(generic_gpio)

examples/peripherals/gpio/generic_gpio/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := generic-gpio
+PROJECT_NAME := generic_gpio
 
 include $(IDF_PATH)/make/project.mk

examples/peripherals/gpio/matrix_keyboard/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(matrix-keyboard)
+project(matrix_keyboard)

examples/peripherals/i2c/i2c_self_test/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(i2c-example)
+project(i2c_example)

examples/peripherals/i2c/i2c_self_test/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := i2c-example
+PROJECT_NAME := i2c_example
 
 include $(IDF_PATH)/make/project.mk

examples/peripherals/i2c/i2c_tools/CMakeLists.txt

@@ -5,4 +5,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/system/console/advanced/components)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(i2c-tools)
+project(i2c_tools)

examples/peripherals/i2c/i2c_tools/Makefile

@@ -3,7 +3,7 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := i2c-tools
+PROJECT_NAME := i2c_tools
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/system/console/advanced/components
 

examples/peripherals/i2s/i2s_adc_dac/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(i2s-adc-dac)
+project(i2s_adc_dac)

examples/peripherals/i2s/i2s_adc_dac/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := i2s-adc-dac
+PROJECT_NAME := i2s_adc_dac
 
 include $(IDF_PATH)/make/project.mk

examples/peripherals/i2s/i2s_audio_recorder_sdcard/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(esp32-i2s-driver-example)
+project(esp32_i2s_driver_example)

examples/peripherals/i2s/i2s_basic/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(esp32-i2s-driver-example)
+project(esp32_i2s_driver_example)

examples/peripherals/i2s/i2s_basic/Makefile

@@ -3,5 +3,5 @@
 # project subdirectory.
 #
 VERBOSE = 1
-PROJECT_NAME := esp32-i2s-driver-example
+PROJECT_NAME := esp32_i2s_driver_example
 include $(IDF_PATH)/make/project.mk

examples/peripherals/spi_slave/receiver/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(spi-slave-receiver)
+project(spi_slave_receiver)

examples/peripherals/spi_slave/receiver/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := spi-slave-receiver
+PROJECT_NAME := spi_slave_receiver
 
 include $(IDF_PATH)/make/project.mk

examples/peripherals/spi_slave/sender/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(spi-slave-sender)
+project(spi_slave_sender)

examples/peripherals/spi_slave/sender/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := spi-slave-sender
+PROJECT_NAME := spi_slave_sender
 
 include $(IDF_PATH)/make/project.mk

examples/peripherals/spi_slave_hd/segment_mode/seg_master/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(seg-master)
+project(seg_master)

examples/peripherals/spi_slave_hd/segment_mode/seg_master/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := spi-slave-hd-seg-master
+PROJECT_NAME := spi_slave_hd_seg_master
 
 include $(IDF_PATH)/make/project.mk

examples/peripherals/spi_slave_hd/segment_mode/seg_slave/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(seg-slave)
+project(seg_slave)

examples/protocols/esp_http_client/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(esp-http-client-example)
+project(esp_http_client_example)

examples/protocols/esp_http_client/Makefile

@@ -3,7 +3,7 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := esp-http-client-example
+PROJECT_NAME := esp_http_client_example
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
 

examples/protocols/esp_http_client/esp_http_client_test.py

@@ -13,7 +13,7 @@ def test_examples_protocol_esp_http_client(env, extra_data):
     """
     dut1 = env.get_dut('esp_http_client', 'examples/protocols/esp_http_client', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'esp-http-client-example.bin')
+    binary_file = os.path.join(dut1.app.binary_path, 'esp_http_client_example.bin')
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance('esp_http_client_bin_size', '{}KB'.format(bin_size // 1024))
     # start test
@@ -39,7 +39,7 @@ def test_examples_protocol_esp_http_client(env, extra_data):
     # test mbedtls dynamic resource
     dut1 = env.get_dut('esp_http_client', 'examples/protocols/esp_http_client', dut_class=ttfw_idf.ESP32DUT, app_config_name='ssldyn')
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'esp-http-client-example.bin')
+    binary_file = os.path.join(dut1.app.binary_path, 'esp_http_client_example.bin')
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance('esp_http_client_bin_size', '{}KB'.format(bin_size // 1024))
     # start test

examples/protocols/http2_request/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(http2-request)
+project(http2_request)

examples/protocols/http2_request/example_test.py

@@ -1,18 +1,7 @@
 #!/usr/bin/env python
 #
-# Copyright 2021 Espressif Systems (Shanghai) CO LTD
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# SPDX-FileCopyrightText: 2021 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
 
 import http.client
 import os
@@ -50,7 +39,7 @@ def test_examples_protocol_http2_request(env, extra_data):  # type: (tiny_test_f
     """
     dut1 = env.get_dut('http2_request', 'examples/protocols/http2_request', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'http2-request.bin')
+    binary_file = os.path.join(dut1.app.binary_path, 'http2_request.bin')
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance('http2_request_bin_size', '{}KB'.format(bin_size // 1024))
     # start the test

examples/protocols/http_request/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(http-request)
+project(http_request)

examples/protocols/http_request/Makefile

@@ -3,7 +3,7 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := http-request
+PROJECT_NAME := http_request
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
 

examples/protocols/http_request/example_test.py

@@ -1,18 +1,7 @@
 #!/usr/bin/env python
 #
-# Copyright 2021 Espressif Systems (Shanghai) CO LTD
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# SPDX-FileCopyrightText: 2021 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
 
 import os
 import re
@@ -31,7 +20,7 @@ def test_examples_protocol_http_request(env, extra_data):  # type: (tiny_test_fw
     """
     dut1 = env.get_dut('http_request', 'examples/protocols/http_request', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'http-request.bin')
+    binary_file = os.path.join(dut1.app.binary_path, 'http_request.bin')
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance('http_request_bin_size', '{}KB'.format(bin_size // 1024))
     # start test

examples/protocols/https_mbedtls/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(https-mbedtls)
+project(https_mbedtls)

examples/protocols/https_mbedtls/Makefile

@@ -3,7 +3,7 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := https-mbedtls
+PROJECT_NAME := https_mbedtls
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
 

examples/protocols/https_mbedtls/example_test.py

@@ -1,18 +1,7 @@
 #!/usr/bin/env python
 #
-# Copyright 2021 Espressif Systems (Shanghai) CO LTD
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# SPDX-FileCopyrightText: 2021 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
 
 import os
 import re
@@ -33,7 +22,7 @@ def test_examples_protocol_https_mbedtls(env, extra_data):  # type: (tiny_test_f
     app_name = 'https_mbedtls'
     dut1 = env.get_dut(app_name, 'examples/protocols/https_mbedtls', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'https-mbedtls.bin')
+    binary_file = os.path.join(dut1.app.binary_path, 'https_mbedtls.bin')
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance('https_mbedtls_bin_size', '{}KB'.format(bin_size // 1024))
     # start test

examples/protocols/icmp_echo/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(icmp-echo)
+project(icmp_echo)

examples/protocols/icmp_echo/Makefile

@@ -3,7 +3,7 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := icmp-echo
+PROJECT_NAME := icmp_echo
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
 

examples/protocols/mdns/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(mdns-test)
+project(mdns_test)

examples/protocols/mdns/Makefile

@@ -3,7 +3,7 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := mdns-test
+PROJECT_NAME := mdns_test
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
 

examples/protocols/mdns/mdns_example_test.py

@@ -115,7 +115,7 @@ def test_examples_protocol_mdns(env, extra_data):
     """
     dut1 = env.get_dut('mdns-test', 'examples/protocols/mdns', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'mdns-test.bin')
+    binary_file = os.path.join(dut1.app.binary_path, 'mdns_test.bin')
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance('mdns-test_bin_size', '{}KB'.format(bin_size // 1024))
     # 1. start mdns application

examples/protocols/sockets/udp_multicast/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(udp-multicast)
+project(udp_multicast)

examples/protocols/sockets/udp_multicast/Makefile

@@ -3,7 +3,7 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := udp-multicast
+PROJECT_NAME := udp_multicast
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
 

examples/protocols/websocket/CMakeLists.txt

@@ -7,4 +7,4 @@ cmake_minimum_required(VERSION 3.5)
 set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(websocket-example)
+project(websocket_example)

examples/protocols/websocket/Makefile

@@ -2,7 +2,7 @@
 # This is a project Makefile. It is assumed the directory this Makefile resides in is a
 # project subdirectory.
 #
-PROJECT_NAME := websocket-example
+PROJECT_NAME := websocket_example
 
 EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
 

examples/protocols/websocket/example_test.py

@@ -107,7 +107,7 @@ def test_examples_protocol_websocket(env, extra_data):
     """
     dut1 = env.get_dut('websocket', 'examples/protocols/websocket', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'websocket-example.bin')
+    binary_file = os.path.join(dut1.app.binary_path, 'websocket_example.bin')
     bin_size = os.path.getsize(binary_file)
     ttfw_idf.log_performance('websocket_bin_size', '{}KB'.format(bin_size // 1024))
 

examples/storage/custom_flash_driver/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(custom-flash-driver)
+project(custom_flash_driver)

examples/storage/custom_flash_driver/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := custom-flash-driver
+PROJECT_NAME := custom_flash_driver
 
 include $(IDF_PATH)/make/project.mk

examples/storage/nvs_rw_blob/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(nvs-rw-blob)
+project(nvs_rw_blob)

examples/storage/nvs_rw_blob/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := nvs-rw-blob
+PROJECT_NAME := nvs_rw_blob
 
 include $(IDF_PATH)/make/project.mk

examples/storage/nvs_rw_value/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(nvs-rw-value)
+project(nvs_rw_value)

examples/storage/nvs_rw_value/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := nvs-rw-value
+PROJECT_NAME := nvs_rw_value
 
 include $(IDF_PATH)/make/project.mk

examples/storage/nvs_rw_value_cxx/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(nvs-rw-value-cxx)
+project(nvs_rw_value_cxx)

examples/storage/nvs_rw_value_cxx/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := nvs-rw-value-cxx
+PROJECT_NAME := nvs_rw_value_cxx
 
 include $(IDF_PATH)/make/project.mk

examples/system/ota/README.md

@@ -45,7 +45,7 @@ In the `Example Connection Configuration` menu:
 
 In the `Example Configuration` menu:
 
-* Set the URL of the firmware to download in the `Firmware Upgrade URL` option. The format should be `https://<host-ip-address>:<host-port>/<firmware-image-filename>`, e.g. `https://192.168.2.106:8070/hello-world.bin`
+* Set the URL of the firmware to download in the `Firmware Upgrade URL` option. The format should be `https://<host-ip-address>:<host-port>/<firmware-image-filename>`, e.g. `https://192.168.2.106:8070/hello_world.bin`
   * **Note:** The server part of this URL (e.g. `192.168.2.106`) must match the **CN** field used when [generating the certificate and key](#run-https-server)
 
 ### Build and Flash
@@ -68,7 +68,7 @@ After a successful build, we need to create a self-signed certificate and run a
 * To create a new self-signed certificate and key, run the command `openssl req -x509 -newkey rsa:2048 -keyout ca_key.pem -out ca_cert.pem -days 365 -nodes`.
   * When prompted for the `Common Name (CN)`, enter the name of the server that the "ESP-Dev-Board" will connect to. When running this example from a development machine, this is probably the IP address. The HTTPS client will check that the `CN` matches the address given in the HTTPS URL.
 * To start the HTTPS server, run the command `openssl s_server -WWW -key ca_key.pem -cert ca_cert.pem -port 8070`.
-* This directory should contain the firmware (e.g. `hello-world.bin`) to be used in the update process. This can be any valid ESP-IDF application, as long as its filename corresponds to the name configured using `Firmware Upgrade URL` in menuconfig. The only difference to flashing a firmware via the serial interface is that the binary is flashed to the `factory` partition, while OTA update use one of the OTA partitions.
+* This directory should contain the firmware (e.g. `hello_world.bin`) to be used in the update process. This can be any valid ESP-IDF application, as long as its filename corresponds to the name configured using `Firmware Upgrade URL` in menuconfig. The only difference to flashing a firmware via the serial interface is that the binary is flashed to the `factory` partition, while OTA update use one of the OTA partitions.
 * **Note:** Make sure incoming access to port *8070* is not prevented by firewall rules.
 * **Note:** Windows users may encounter issues while running `openssl s_server -WWW`, due to CR/LF translation and/or closing the connection prematurely
   (Some windows builds of openssl translate CR/LF sequences to LF in the served files, leading to corrupted images received by the OTA client; others interpret the `0x1a`/`SUB` character in a binary as an escape sequence, i.e. end of file, and close the connection prematurely thus preventing the OTA client from receiving a complete image).
@@ -100,7 +100,7 @@ If you want to rollback to the `factory` app after the upgrade (or to the first
 ### Output from the HTTPS server
 
 ```bash
-FILE:hello-world.bin
+FILE:hello_world.bin
 ACCEPT
 ```
 
@@ -131,7 +131,7 @@ In ``native_ota_example``, ``$PROJECT_PATH/version.txt`` is used to define the a
 
 * Check that your PC can ping the "ESP-Dev-Board" using its IP, and that the IP, AP and other configuration settings are correctly configured in menuconfig
 * Check if any firewall software is preventing incoming connections on the PC
-* Check whether you can see the configured file (default `hello-world.bin`), by running the command `curl -v https://<host-ip-address>:<host-port>/<firmware-image-filename>`
+* Check whether you can see the configured file (default `hello_world.bin`), by running the command `curl -v https://<host-ip-address>:<host-port>/<firmware-image-filename>`
 * Try viewing the file listing from a separate host or phone
 
 ### Error "ota_begin error err=0x104"

examples/system/ota/advanced_https_ota/main/Kconfig.projbuild

@@ -2,7 +2,7 @@ menu "Example Configuration"
 
     config EXAMPLE_FIRMWARE_UPGRADE_URL
         string "Firmware Upgrade URL"
-        default "https://192.168.2.106:8070/hello-world.bin"
+        default "https://192.168.2.106:8070/hello_world.bin"
         help
             URL of server which hosts the firmware image.
 

examples/system/ota/native_ota_example/main/Kconfig.projbuild

@@ -2,7 +2,7 @@ menu "Example Configuration"
 
     config EXAMPLE_FIRMWARE_UPG_URL
         string "Firmware Upgrade URL"
-        default "https://192.168.2.106:8070/hello-world.bin"
+        default "https://192.168.2.106:8070/hello_world.bin"
         help
             URL of server which hosts the firmware image.
 

examples/system/ota/simple_ota_example/main/Kconfig.projbuild

@@ -2,7 +2,7 @@ menu "Example Configuration"
 
     config EXAMPLE_FIRMWARE_UPGRADE_URL
         string "firmware upgrade url endpoint"
-        default "https://192.168.0.3:8070/hello-world.bin"
+        default "https://192.168.0.3:8070/hello_world.bin"
         help
             URL of server which hosts the firmware
             image.

examples/system/ulp_fsm/ulp/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(ulp-example)
+project(ulp_example)

examples/system/ulp_fsm/ulp/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := ulp-example
+PROJECT_NAME := ulp_example
 
 include $(IDF_PATH)/make/project.mk

examples/system/ulp_fsm/ulp_adc/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(ulp-adc-example)
+project(ulp_adc_example)

examples/system/ulp_fsm/ulp_adc/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := ulp-adc-example
+PROJECT_NAME := ulp_adc_example
 
 include $(IDF_PATH)/make/project.mk

examples/system/ulp_riscv/ds18b20_onewire/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(ulp-riscv-ds18b20-example)
+project(ulp_riscv_ds18b20_example)

examples/system/ulp_riscv/gpio/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(ulp-riscv-example)
+project(ulp_riscv_example)

examples/wifi/wpa2_enterprise/CMakeLists.txt

@@ -6,4 +6,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(wpa2-enterprise)
+project(wpa2_enterprise)

examples/wifi/wpa2_enterprise/Makefile

@@ -3,6 +3,6 @@
 # project subdirectory.
 #
 
-PROJECT_NAME := wpa2-enterprise
+PROJECT_NAME := wpa2_enterprise
 
 include $(IDF_PATH)/make/project.mk

tools/ci/check_copyright_ignore.txt

@@ -3716,9 +3716,7 @@ examples/protocols/esp_local_ctrl/scripts/esp_local_ctrl.py
 examples/protocols/esp_local_ctrl/scripts/proto_lc.py
 examples/protocols/http2_request/components/sh2lib/sh2lib.c
 examples/protocols/http2_request/components/sh2lib/sh2lib.h
-examples/protocols/http2_request/example_test.py
 examples/protocols/http2_request/main/http2_request_example_main.c
-examples/protocols/http_request/example_test.py
 examples/protocols/http_request/main/http_request_example_main.c
 examples/protocols/http_server/advanced_tests/http_server_advanced_test.py
 examples/protocols/http_server/advanced_tests/main/include/tests.h
@@ -3740,7 +3738,6 @@ examples/protocols/http_server/simple/http_server_simple_test.py
 examples/protocols/http_server/simple/main/main.c
 examples/protocols/http_server/ws_echo_server/main/ws_echo_server.c
 examples/protocols/http_server/ws_echo_server/ws_server_example_test.py
-examples/protocols/https_mbedtls/example_test.py
 examples/protocols/https_mbedtls/main/https_mbedtls_example_main.c
 examples/protocols/https_request/example_test.py
 examples/protocols/https_request/main/https_request_example_main.c

tools/ci/test_build_system_cmake.sh

@@ -150,7 +150,7 @@ function run_tests()
     pushd ${IDF_PATH}/examples/get-started/hello_world
     GIT_COMMITTER_NAME="No One" GIT_COMMITTER_EMAIL="noone@espressif.com" git tag mytag -a -m "mytag" || failure "Git cannot create tag"
     idf.py reconfigure &> log.log || failure "Failed to build"
-    str="App \"hello-world\" version: mytag"
+    str="App \"hello_world\" version: mytag"
     grep "${str}" log.log || { cat log.log ; failure "Project version should be the custom tag"; }
     idf_version=$(idf.py --version)
     if [[ "$idf_version" == *"mytag"* ]]; then

tools/idf_size.py

@@ -312,7 +312,7 @@ def load_sections(map_file: TextIO) -> Dict:
     # source file line, ie
     # 0x0000000040080400       0xa4 /home/gus/esp/32/idf/examples/get-started/hello_world/build/esp32/libesp32.a(cpu_start.o)
     # cmake build system links some object files directly, not part of any archive, so make that part optional
-    #  .xtensa.info   0x0000000000000000       0x38 CMakeFiles/hello-world.elf.dir/project_elf_src.c.obj
+    #  .xtensa.info   0x0000000000000000       0x38 CMakeFiles/hello_world.elf.dir/project_elf_src.c.obj
     #  *fill*         0x00000000400e2967        0x1
     RE_FULL_LINE = re.compile(r'\s*(?P<sym_name>\S*) +0x(?P<address>[\da-f]+) +0x(?P<size>[\da-f]+)\s*(?P<file>.*)$')
 

tools/test_apps/system/longjmp_test/CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(hello-world)
+project(longjmp_test)

tools/test_idf_monitor/tests/core1.txt

@@ -3,7 +3,7 @@ I (195) boot: Loaded app from partition at offset 0x10000
 I (195) boot: Disabling RNG early entropy source...
 I (196) cpu_start: Pro cpu up.
 I (200) cpu_start: Application information:
-I (205) cpu_start: Project name:     hello-world
+I (205) cpu_start: Project name:     hello_world
 I (210) cpu_start: App version:      v4.2-dev-172-gc9cc694dbb-dirty
 I (217) cpu_start: Compile time:     Feb  6 2020 17:57:45
 I (223) cpu_start: ELF file SHA256:  83cfeb53c9c00c61...
@@ -25,12 +25,12 @@ I (319) cpu_start: Starting scheduler on PRO CPU.
 I (0) cpu_start: Starting scheduler on APP CPU.
 Guru Meditation Error: Core  0 panic'ed (StoreProhibited). Exception was unhandled.
 Core 0 register dump:
-PC      : 0x400e37f7  PS      : 0x00060430  A0      : 0x800d0c31  A1      : 0x3ffb5db0  
-A2      : 0x00000001  A3      : 0x00000001  A4      : 0x00000001  A5      : 0x00060023  
-A6      : 0x00000001  A7      : 0x00060023  A8      : 0x00000001  A9      : 0x00000000  
-A10     : 0x7fffffff  A11     : 0x8001f880  A12     : 0x06ff1ff8  A13     : 0x00000000  
-A14     : 0x3ffb7d80  A15     : 0x00000000  SAR     : 0x00000014  EXCCAUSE: 0x0000001d  
-EXCVADDR: 0x00000001  LBEG    : 0x00000000  LEND    : 0x00000000  LCOUNT  : 0x00000000  
+PC      : 0x400e37f7  PS      : 0x00060430  A0      : 0x800d0c31  A1      : 0x3ffb5db0
+A2      : 0x00000001  A3      : 0x00000001  A4      : 0x00000001  A5      : 0x00060023
+A6      : 0x00000001  A7      : 0x00060023  A8      : 0x00000001  A9      : 0x00000000
+A10     : 0x7fffffff  A11     : 0x8001f880  A12     : 0x06ff1ff8  A13     : 0x00000000
+A14     : 0x3ffb7d80  A15     : 0x00000000  SAR     : 0x00000014  EXCCAUSE: 0x0000001d
+EXCVADDR: 0x00000001  LBEG    : 0x00000000  LEND    : 0x00000000  LCOUNT  : 0x00000000
 
 ELF file SHA256: 83cfeb53c9c00c61c4e52674e43654e4b452b7592075920977e491e06a4488d8
 

tools/test_idf_monitor/tests/core1_out.txt

@@ -2,7 +2,7 @@ I (195) boot: Loaded app from partition at offset 0x10000
 I (195) boot: Disabling RNG early entropy source...
 I (196) cpu_start: Pro cpu up.
 I (200) cpu_start: Application information:
-I (205) cpu_start: Project name:     hello-world
+I (205) cpu_start: Project name:     hello_world
 I (210) cpu_start: App version:      v4.2-dev-172-gc9cc694dbb-dirty
 I (217) cpu_start: Compile time:     Feb  6 2020 17:57:45
 I (223) cpu_start: ELF file SHA256:  83cfeb53c9c00c61...
@@ -24,12 +24,12 @@ I (319) cpu_start: Starting scheduler on PRO CPU.
 I (0) cpu_start: Starting scheduler on APP CPU.
 Guru Meditation Error: Core  0 panic'ed (StoreProhibited). Exception was unhandled.
 Core 0 register dump:
-PC      : 0x400e37f7  PS      : 0x00060430  A0      : 0x800d0c31  A1      : 0x3ffb5db0  
-A2      : 0x00000001  A3      : 0x00000001  A4      : 0x00000001  A5      : 0x00060023  
-A6      : 0x00000001  A7      : 0x00060023  A8      : 0x00000001  A9      : 0x00000000  
-A10     : 0x7fffffff  A11     : 0x8001f880  A12     : 0x06ff1ff8  A13     : 0x00000000  
-A14     : 0x3ffb7d80  A15     : 0x00000000  SAR     : 0x00000014  EXCCAUSE: 0x0000001d  
-EXCVADDR: 0x00000001  LBEG    : 0x00000000  LEND    : 0x00000000  LCOUNT  : 0x00000000  
+PC      : 0x400e37f7  PS      : 0x00060430  A0      : 0x800d0c31  A1      : 0x3ffb5db0
+A2      : 0x00000001  A3      : 0x00000001  A4      : 0x00000001  A5      : 0x00060023
+A6      : 0x00000001  A7      : 0x00060023  A8      : 0x00000001  A9      : 0x00000000
+A10     : 0x7fffffff  A11     : 0x8001f880  A12     : 0x06ff1ff8  A13     : 0x00000000
+A14     : 0x3ffb7d80  A15     : 0x00000000  SAR     : 0x00000014  EXCCAUSE: 0x0000001d
+EXCVADDR: 0x00000001  LBEG    : 0x00000000  LEND    : 0x00000000  LCOUNT  : 0x00000000
 ELF file SHA256: 83cfeb53c9c00c61c4e52674e43654e4b452b7592075920977e491e06a4488d8
 Backtrace: 0x400e37f4:0x3ffb5db0 0x400d0c2e:0x3ffb5dd0 0x40087015:0x3ffb5df0
 I (401) esp_core_dump_uart: Press Enter to print core dump to UART...