MCUXpresso - What To Commit To Repository?

JK_265 — Thu, 12 Jan 2023 17:46:32 GMT

I am using MCXpresso, and of course need to make sure that all of my work ends up in a source code repository.

I am pretty confident that I am capturing all the outputs of the process (such as auto-generated code) as they appear in my workspace,

What I need to confirm is all the INPUTS to the process that produced the output.
The .mex file seems to end up in the workspace, but are there any files outside the workspace that I really need to make sure are committed to the repository?

I just want to make sure if my laptop dies, a new person takes over the project, etc... that any user can drive the MCUXpresso creation process. It seems reasonable that they need to install the version of MCUXpresso and the SDK that I originally used (which they should be able to get from NXP). Then I just want them to have to clone the repository and open the workspace. So, are there any files outside the workspace that I need to explicitly capture?

Thanks!

Re: MCUXpresso - What To Commit To Repository?

ErichStyger — Thu, 12 Jan 2023 18:28:03 GMT

Basically you should ignore the build output folders (Debug, Release).

There has been a debate (see for example https://mcuoneclipse.com/2018/09/30/tutorial-git-with-eclipse/ ) about ignoring the .settings folder too (which I do, but this depends on what extra folders you are using).

So my 'standard' ignore file is like this one:

https://github.com/ErichStyger/mcuoneclipse/blob/master/Examples/MCUXpresso/FRDM-K22F/FRDM-K22F_littleFS/.gitignore

(note: I don't have a 'Release' configuration, but that's another story)

In the above case I'm not using the config too .mex file, otherwise I would Ignore it too, because all the information is stored in the source files, so the .mex is redundant.

There is another special case, if you decide to turn off the auto-generated linker file in the linker project settings. In that case you should not ignore the *.ld files, see for example

https://github.com/ErichStyger/mcuoneclipse/blob/master/Examples/MCUXpresso/LPC55S16-EVK/LPC55S16_PositionIndependentCode/.gitignore

I hope this helps,

Erich

topic MCUXpresso - What To Commit To Repository? in MCUXpresso General

MCUXpresso - What To Commit To Repository?

Re: MCUXpresso - What To Commit To Repository?