Small Surprise in IDF Project Example: Purposeful or Typographical Error?

[Halfnium]

New to the ESP32, IDF I carefully watched the application build process. I was surprised to note that building the "hello_world" example in "../esp/esp_idf/examples/get-started" generates files named "hello-world" (of types .bin, .elf and .map). That's right, a dash crept into the file names in place of the expected underscore.

Simple to understand: Both the "CMakeLists.txt" and "Makefile" at the project's top level give the project's name as "hello-world" for some reason. That is easy to change and produces the desired result.

As a new user, I would like to understand if this is a subtle, purposeful matter of style in naming projects and intermediate files or a minor typographical error.

Thanks!

[ESP_Angus]

Hi Halfnium,

Sorry for the confusion caused. This is a typographical error. There are a few places in ESP-IDF where the path uses hyphens, and a few where it uses underscores. And the underscores/hyphens in the project names are similarly inconsistent.

We haven't gotten around to fixing/standardizing this yet, but it doesn't exist for any predetermined reason. If you're creating your own project then you can use hyphens or underscores in both the directory name and the project name, in whatever way suits.

Angus