UPPER CASE, lower case and Title Case

[jonathanpallant]

In Rust, we typically use TitleCase for types (like struct Uart0 { .. .}), and lower_case for module names (like pac::uart0), method/function names (like my_uart.baudrate()), and field names within structs (like my_uart.baudrate). Things that are UPPER_CASE are typically only static variables and constants.

The code generated by svd2rust currently uses a lot of UPPER_CASE names for types, and also for the field names in struct Peripherals. I think this can be confusing for a newcomer to Embedded Rust.

• Does anyone recall the reason for using UPPER_CASE here?
• Is there any appetite for changing the output to follow a more typical approach for capitalising things?

[burrbull]

You can specify it by ident_formats.peripheral.case = pascal in config. See #794

[jonathanpallant]

That's cool. But why is the default the way it is?

[burrbull]

I don't have answer.
I think there is many factors you should consider: rust style, datasheet (RM) style, real names in SVD.
Any of variants like: Don't change (leave as in SVD), make constant case, make pascal case, etc. have downsides.
I think upper (constant) case was selected by @japaric just because he was working with STM32 when started the project.

[Emilgardis]

Maybe it's worth looking into changing the default to PascalCase, I can't think of any reasons to not do it except that it's a breaking change

[jonathanpallant]

I would support changing the default - it would make teaching easier... (see https://github.com/ferrous-systems/rust-training/blob/main/training-slides/src/pac-svd2rust.md for my slides on this topic).

Anyone who objected to the massive diff next time they rebuild can add a config file to put it back as it was, right?

Also perhaps the config file can help when it comes to removing (or not) the singleton objects.

[burrbull]

We should also split option for peripheral types and peripheral singletons. Now it is one option.

And maybe modules? (Not sure)

[burrbull]

🤦
There is also typos.

svd2rust/src/config.rs

Lines 156 to 159 in 869d34f

	pub fn scake_case(mut self) -> Self {
	self.case = Some(Case::Pascal);
	self
	}