Add menu labels when generating sdkconfig.defaults with idf.py save-defconfig (IDFGH-8945)

[macksal]

Is your feature request related to a problem?

The addition of idf.py save-defconfig has been incredibly helpful in managing the sdkconfig.defaults file. However, the structure of the file as it is spit out just includes all non-default options without any grouping or labels. This makes the file a more difficult to quickly audit. This is particularly true when many non-default options are present, or for projects which include config options for component dependencies e.g. esp-camera.

Describe the solution you'd like.

Ideally, save-defconfig would write out the sdkconfig.defaults file and include the same group labels that are written to sdkconfig in the build process.

For example:

#
# Partition Table
#
CONFIG_PARTITION_TABLE_TWO_OTA=y
# end of Partition Table

If the file is modified manually, the tool could reorganise the options into appropriate sections in an opinionated way or just leave them as-is. The least opinionated way would be to add a flag to save-defconfig that would choose whether to add the group labels and reformat or leave the existing structure.

Describe alternatives you've considered.

No response

Additional context.

No response

[dobairoland]

Thanks for the feedback and suggestion!

[KaeLL]

The least opinionated way would be to add a flag to save-defconfig that would choose whether to add the group labels and reformat or leave the existing structure.

+1 for this, as I love the uber minimalism in the current version, and I occasionally do some text processing on the file, which is made easier by the fact that it's so simple. So if this is to be introduced, it's better that it be optional.