[CmdOpt] add getenv func that also register the description

[tdavidcl]

This pr add two new functions that get environment variable as well as registering their description.

/**
 * @brief Get the content of the environment variable if it exist and register it documentation
 *...
 */
inline std::optional<std::string> getenv_str_register(const char *env_var, std::string desc);

/**
 * @brief Get the content of the environment variable if it exist and register it documentation,
 * otherwise return the default value
 *...
 */
inline std::string
getenv_str_default_register(const char *env_var, std::string default_val, std::string desc);

this pr also use those function to replace some usage of env variable to register it where it is used instead of beign registered in the main function.

[github-actions]

Workflow report

workflow report corresponding to commit 2c50844
Commiter email is timothee.davidcleris@proton.me

Pre-commit check report

Pre-commit check: ✅

trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check for merge conflicts................................................Passed
check that executables have shebangs.....................................Passed
check that scripts with shebangs are executable..........................Passed
check for added large files..............................................Passed
check for case conflicts.................................................Passed
check yaml...............................................................Passed
detect private key.......................................................Passed
Validate GitHub Workflows................................................Passed
clang-format.............................................................Passed
Check doxygen headers....................................................Passed
Check license headers....................................................Passed
Check #pragma once.......................................................Passed
Check SYCL #include......................................................Passed

Test pipeline can run.

Clang-tidy diff report

No relevant changes found.
Well done!

You should now go back to your normal life and enjoy a hopefully sunny day while waiting for the review.

Doxygen diff with main

Removed warnings : 46
New warnings : 49
Warnings count : 5562 → 5565 (0.1%)

Detailed changes :

+ src/shambackends/src/DeviceQueue.cpp:21: warning: Member SHAMROCK_WAIT_AFTER_SUBMIT (variable) of file DeviceQueue.cpp is not documented.
- src/shambackends/src/DeviceQueue.cpp:23: warning: Member build_queue (variable) of namespace sham is not documented.
- src/shambackends/src/DeviceQueue.cpp:23: warning: Member build_queue (variable) of namespace sham is not documented.
+ src/shambackends/src/DeviceQueue.cpp:26: warning: Member build_queue (variable) of namespace sham is not documented.
+ src/shambackends/src/DeviceQueue.cpp:26: warning: Member build_queue (variable) of namespace sham is not documented.
- src/shambackends/src/DeviceQueue.cpp:31: warning: Member parse_wait_after_submit (variable) of namespace sham is not documented.
- src/shambackends/src/DeviceQueue.cpp:31: warning: Member parse_wait_after_submit (variable) of namespace sham is not documented.
+ src/shambackends/src/DeviceQueue.cpp:34: warning: Member parse_wait_after_submit (variable) of namespace sham is not documented.
+ src/shambackends/src/DeviceQueue.cpp:34: warning: Member parse_wait_after_submit (variable) of namespace sham is not documented.
+ src/shambackends/src/DeviceQueue.cpp:44: warning: Member env_var_wait_after_submit_set (variable) of namespace sham is not documented.
+ src/shambackends/src/DeviceQueue.cpp:44: warning: Member env_var_wait_after_submit_set (variable) of namespace sham is not documented.
- src/shambackends/src/DeviceQueue.cpp:52: warning: Member env_var_wait_after_submit_set (variable) of namespace sham is not documented.
- src/shambackends/src/DeviceQueue.cpp:52: warning: Member env_var_wait_after_submit_set (variable) of namespace sham is not documented.
- src/shamsys/src/NodeInstance.cpp:213: warning: Member exception_gen_callback(std::string msg) (function) of namespace logformatter is not documented.
- src/shamsys/src/NodeInstance.cpp:213: warning: Member exception_gen_callback(std::string msg) (function) of namespace logformatter is not documented.
+ src/shamsys/src/NodeInstance.cpp:219: warning: Member exception_gen_callback(std::string msg) (function) of namespace logformatter is not documented.
+ src/shamsys/src/NodeInstance.cpp:219: warning: Member exception_gen_callback(std::string msg) (function) of namespace logformatter is not documented.
- src/shamsys/src/NodeInstance.cpp:242: warning: Member print_device_list() (function) of namespace shamsys::instance::details is not documented.
+ src/shamsys/src/NodeInstance.cpp:248: warning: Member print_device_list() (function) of namespace shamsys::instance::details is not documented.
- src/shamsys/src/NodeInstance.cpp:287: warning: Member initialized (variable) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:289: warning: Member device_compute (variable) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:290: warning: Member device_alt (variable) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:292: warning: Member ctx_compute (variable) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:293: warning: Member ctx_alt (variable) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:293: warning: Member initialized (variable) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:295: warning: Member device_compute (variable) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:295: warning: Member sched_compute (variable) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:296: warning: Member device_alt (variable) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:296: warning: Member sched_alt (variable) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:298: warning: Member ctx_compute (variable) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:298: warning: Member init_device_scheduling() (function) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:299: warning: Member ctx_alt (variable) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:301: warning: Member sched_compute (variable) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:302: warning: Member sched_alt (variable) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:304: warning: Member init_device_scheduling() (function) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:315: warning: Member init_queues_auto(std::string search_key) (function) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:321: warning: Member init_queues_auto(std::string search_key) (function) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:391: warning: Member init_queues(u32 alt_id, u32 compute_id) (function) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:397: warning: Member init_queues(u32 alt_id, u32 compute_id) (function) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:448: warning: Member finalize() (function) of namespace syclinit is not documented.
+ src/shamsys/src/NodeInstance.cpp:454: warning: Member finalize() (function) of namespace syclinit is not documented.
- src/shamsys/src/NodeInstance.cpp:464: warning: Member compute_queue_eu_count (variable) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:466: warning: Member get_compute_queue_eu_count(u32 id=0) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:466: warning: Member get_compute_queue_eu_count(u32 id=0) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:46: warning: Member SHAMLOGFORMATTER (variable) of file NodeInstance.cpp is not documented.
+ src/shamsys/src/NodeInstance.cpp:470: warning: Member compute_queue_eu_count (variable) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:472: warning: Member get_compute_queue_eu_count(u32 id=0) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:472: warning: Member get_compute_queue_eu_count(u32 id=0) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:474: warning: Member print_queue_map() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:474: warning: Member print_queue_map() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:480: warning: Member print_queue_map() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:480: warning: Member print_queue_map() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:49: warning: Member SHAMLOG_ERR_ON_EXCEPT (variable) of file NodeInstance.cpp is not documented.
- src/shamsys/src/NodeInstance.cpp:512: warning: Member print_device_list_debug() (function) of namespace shamsys::instance::tmp is not documented.
+ src/shamsys/src/NodeInstance.cpp:518: warning: Member print_device_list_debug() (function) of namespace shamsys::instance::tmp is not documented.
- src/shamsys/src/NodeInstance.cpp:609: warning: Member start_mpi(MPIInitInfo mpi_info) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:615: warning: Member start_mpi(MPIInitInfo mpi_info) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:706: warning: Member init_auto(std::string search_key, MPIInitInfo mpi_info) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:706: warning: Member init_auto(std::string search_key, MPIInitInfo mpi_info) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:707: warning: Member init_auto(std::string search_key, MPIInitInfo mpi_info) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:707: warning: Member init_auto(std::string search_key, MPIInitInfo mpi_info) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:734: warning: Member get_compute_scheduler() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:734: warning: Member get_compute_scheduler() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:735: warning: Member get_compute_scheduler() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:735: warning: Member get_compute_scheduler() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:736: warning: Member get_alt_scheduler() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:736: warning: Member get_alt_scheduler() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:737: warning: Member get_alt_scheduler() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:737: warning: Member get_alt_scheduler() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:738: warning: Member get_compute_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:738: warning: Member get_compute_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:739: warning: Member get_compute_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:739: warning: Member get_compute_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:742: warning: Member get_alt_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:742: warning: Member get_alt_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:743: warning: Member get_alt_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:743: warning: Member get_alt_scheduler_ptr() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:744: warning: Member print_device_info(const sycl::device &Device) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:745: warning: Member print_device_info(const sycl::device &Device) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:751: warning: Member print_device_list() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:751: warning: Member print_device_list() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:752: warning: Member print_device_list() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:752: warning: Member print_device_list() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:767: warning: Member start_sycl_auto(std::string search_key) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:767: warning: Member start_sycl_auto(std::string search_key) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:768: warning: Member start_sycl_auto(std::string search_key) (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:768: warning: Member start_sycl_auto(std::string search_key) (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:781: warning: Member print_mpi_capabilities() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:781: warning: Member print_mpi_capabilities() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:782: warning: Member print_mpi_capabilities() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:782: warning: Member print_mpi_capabilities() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:783: warning: Member check_dgpu_available() (function) of namespace shamsys::instance is not documented.
- src/shamsys/src/NodeInstance.cpp:783: warning: Member check_dgpu_available() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:784: warning: Member check_dgpu_available() (function) of namespace shamsys::instance is not documented.
+ src/shamsys/src/NodeInstance.cpp:784: warning: Member check_dgpu_available() (function) of namespace shamsys::instance is not documented.