What is the .mxproject used for?

[peks]

Hi

The .mxproject is generated by STM32CubeMX in the code generation step.  What is this file used for? 

Thank you.

Pieter.

[Mahmoud Ben Romdhane]

Hello @peks

First let me thank you for posting and welcome to ST Community.

The main purpose of the .mxproject file is to save parameters, configurations and pin mappings. This file is considered as the heart of the STM32 project. It contains information about the microcontroller selected like peripherals settings and middleware parameters. 

Thx.

Mahmoud.

 

[Pavel A.]

@Mahmoud Ben Romdhane is there a more detailed or recent explanation on this file? 

I use CubeMX for few years already, and .mxproject once was known to make trouble when re-generating projects, especially after move to a different path or rename. So I've learned to consider it harmful, delete it ASAP, and have never seen anything negative.  Of course, not checking it into version control.

 

[peks]

Thanks guys. 

[Leoz]

It is really a headache. When checkout to another git branch, file .mxproject frequently leads to compile failure. 

[Nick Alexeev]

Should .mxproject file be checked into source control?  Or is it generated from .ioc file?

[Pavel A.]

Cube creates this file when it edits or upgrades .ioc.

Don't check it in. I never check it, never seen any problem.