feat(esp_commands): Sort static commands for all targets

Author: SoucheSouche

esp_commands/CMakeLists.txt

@@ -1,15 +1,15 @@
 idf_build_get_property(idf_target IDF_TARGET)
 
-set(srcs "esp_commands.c"
-         "esp_dynamic_commands.c"
-         "esp_commands_helpers.c")
+set(srcs "src/esp_commands.c"
+         "src/esp_dynamic_commands.c"
+         "src/esp_commands_helpers.c")
 
 idf_component_register(
     SRCS ${srcs}
     INCLUDE_DIRS include
     PRIV_INCLUDE_DIRS private_include
     LDFRAGMENTS linker.lf
-)
+    WHOLE_ARCHIVE)
 
 if(${idf_target} STREQUAL "linux")
     # Add custom ld file 

esp_commands/include/esp_commands.h

@@ -13,7 +13,7 @@ extern "C" {
 #include "esp_heap_caps.h"
 #include "esp_err.h"
 
-#define ESP_COMMAND_STRINGIFY(name) #name
+#define _STRINGIFY(name) #name
 
 /**
  * @brief Function pointer type for writing bytes.
@@ -187,21 +187,24 @@ esp_err_t esp_commands_update_config(const esp_commands_config_t *config);
  * @brief macro registering a command and placing it in a specific section of flash.rodata
  * @note see the linker.lf file for more information concerning the section characteristics
  */
-#define ESP_COMMAND_REGISTER(cmd_name, cmd_group, cmd_help, cmd_func, cmd_func_ctx, cmd_hint_cb, cmd_glossary_cb) \
+#define _ESP_REPL_STRINGIFY(x) #x
+#define ESP_REPL_STRINGIFY(x) _ESP_REPL_STRINGIFY(x)
+
+#define _ESP_COMMAND_REGISTER(cmd_name, cmd_group, cmd_help, cmd_func, cmd_func_ctx, cmd_hint_cb, cmd_glossary_cb) \
     static_assert((cmd_func) != NULL); \
-    /* Alignment attribute is required when building on linux target to prevent each input section */ \
-    /* from inheriting its alignment from the object's file default one thus preventing gaps between */ \
-    /* commands in the section. */ \
-    static const esp_command_t cmd_name __attribute__((used, section(".esp_commands" "." ESP_COMMAND_STRINGIFY(cmd_name)), aligned(4))) = { \
-        .name = #cmd_name, \
-        .group = #cmd_group, \
+    static const esp_command_t cmd_name __attribute__((used, section(".esp_commands" "." _ESP_REPL_STRINGIFY(cmd_name)), aligned(4))) = { \
+        .name = _ESP_REPL_STRINGIFY(cmd_name), \
+        .group = _ESP_REPL_STRINGIFY(cmd_group), \
         .help = cmd_help, \
         .func = cmd_func, \
         .func_ctx = cmd_func_ctx, \
         .hint_cb = cmd_hint_cb, \
         .glossary_cb = cmd_glossary_cb \
     };
 
+#define ESP_COMMAND_REGISTER(cmd_name, cmd_group, cmd_help, cmd_func, cmd_func_ctx, cmd_hint_cb, cmd_glossary_cb) \
+    _ESP_COMMAND_REGISTER(cmd_name, cmd_group, cmd_help, cmd_func, cmd_func_ctx, cmd_hint_cb, cmd_glossary_cb)
+
 /**
  * @brief Register a command
  *

esp_commands/linker.lf

@@ -1,6 +1,6 @@
 [sections:esp_commands]
 entries:
-    .esp_command+
+    .esp_commands+
 
 [scheme:esp_commands_default]
 entries:

esp_commands/esp_commands.c esp_commands/src/esp_commands.cesp_commands/esp_commands.c renamed to esp_commands/src/esp_commands.c

@@ -536,26 +536,26 @@ static void print_arg_help(esp_commands_exec_arg_t *cmd_args, esp_command_t *it)
     /* First line: command name and hint
      * Pad all the hints to the same column
      */
-    FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "%-s",  it->name);
+    FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "%s",  it->name);
 
     const char *hint = NULL;
     if (it->hint_cb) {
         hint = it->hint_cb(it->func_ctx);
     }
 
     if (hint) {
-        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "%s\n", it->hint_cb(it->func_ctx));
+        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, " %s\n", it->hint_cb(it->func_ctx));
     } else {
-        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "\n");
+        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, " -\n");
     }
 
     /* Second line: print help */
     /* TODO: replace the simple print with a function that
      * replaces arg_print_formatted */
     if (it->help) {
-        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "  %s\n", it->help);
+        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, " %s\n", it->help);
     } else {
-        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "  -\n");
+        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, " -\n");
     }
 
     /* Third line: print the glossary*/
@@ -567,7 +567,7 @@ static void print_arg_help(esp_commands_exec_arg_t *cmd_args, esp_command_t *it)
     if (glossary) {
         FDPRINTF(cmd_args->out_fd, cmd_args->write_func, " %s\n", it->glossary_cb(it->func_ctx));
     } else {
-        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "  -\n");
+        FDPRINTF(cmd_args->out_fd, cmd_args->write_func, " -\n");
     }
 
     FDPRINTF(cmd_args->out_fd, cmd_args->write_func, "\n");