Use _CONFIG_ to separate config prefix and key
#2848
Conversation
bugadani
force-pushed
the
prefix
branch
4 times, most recently
from
65afc4b to
04edbe8
Compare
examples/.cargo/config.toml
Outdated
| @@ -33,7 +33,7 @@ PASSWORD = "PASSWORD" | |||
| STATIC_IP = "1.1.1.1 " | |||
| GATEWAY_IP = "1.1.1.1" | |||
| HOST_IP = "1.1.1.1" | |||
| ESP_WIFI_CSI_ENABLE = "true" | |||
| ESP_WIFI__CSI_ENABLE = "true" | |||
There was a problem hiding this comment.
looking at this changed line I wonder if a less subtle prefix would be more user-friendly.
I can imagine users missing the second underscore and having a hard time to figure out why setting cfg-value doesn't have any effect - they won't get any indication of an error
There was a problem hiding this comment.
I'm just dropping this in as the "McDonald's idea" of solutions. If anyone knows anything better, let's do that, but until then, this is a fallback :)
We are limited to what we can encode in an environment variable's name, unfortunately.
There was a problem hiding this comment.
Sure but something like _CFG_ is less likely to be unspotted
There was a problem hiding this comment.
Yeah I agree with @bjoernQ, __ is likely to be missed. I think either _CFG_ or personally I'd prefer _CONFIG_ but either is fine with me.
There was a problem hiding this comment.
There's also the tedious option of renaming the esp-hal-embassy crate to esp-embassy, which would be consistent with literally every other crate (except the procmacros one).
(Unless there's a naming convention I'm missing)
There was a problem hiding this comment.
(Unless there's a naming convention I'm missing)
https://github.com/esp-rs/esp-hal-community?tab=readme-ov-file#contributing-a-crate
bugadani
force-pushed
the
prefix
branch
2 times, most recently
from
09f77b3 to
6a00c53
Compare
bugadani
changed the title
_CONFIG_ to separate config prefix and key
A lazy attempt to resolve #2846