Before logging an issue, please update to the latest release of Visual Micro from the Downloads Page.

When Logging a Support Issue in the Forum, please ensure you have also:-

  • Enabled vMicro > Compiler > Show Build Properties
  • Re-Compile your program with these settings enabled
 
Save the new Output to a Text File and....
  • Click the Reply button and attach as .txt file OR
  • Click here to Email us with the file attached, and a link to your post
Support requests without the output above may be impossible to answer, so please help us to help you
 
Page Index Toggle Pages: 1 Send TopicPrint
Normal Topic What to include in .gitignore? (Read 8040 times)
tarsier
Newbies
*
Offline


Posts: 1
Joined: Jun 3rd, 2016
What to include in .gitignore?
Jun 3rd, 2016 at 2:39am
Print Post  
I like to keep my Arduino projects under version control on GitHub. All I had to worry about was adding my .ino, .h, and .cpp files. Now with the Arduino Extension there are lots of new files being created and I was wondering which ones are vital to put under version control and which ones are easily re-created?

It seems obvious that I don't want to put the binaries under version control, but I probably do want the .sln file. What about .vcxproj, and .filters? And the __vm folder?

I suppose all I really need are the files I was adding before: .ino, .h, .cpp since everything else really is easily re-created when opening the project with the Arduino Extension. But what are the best practices for the Arduino Extension and the .gitignore file?
  
Back to top
 
IP Logged
 
Tim@Visual Micro
Administrator
*****
Offline


Posts: 12187
Location: United Kingdom
Joined: Apr 10th, 2010
Re: What to include in .gitignore?
Reply #1 - Jun 3rd, 2016 at 2:49am
Print Post  
Hi,

Yes you are right and it's up to you but this info will help.

If you use a simple arduino structure with all sources in the project folder being part of your project then you are right the .sln and .vcx... files are not important. However, the selected board and serial port are stored in the vcxproj

If you use sub folders for your source code and include/exclude certain sources into the project. Or use linked/shared sources between multiple projects then you will want to keep the vcproj.

The .sln simply holds a list of paths for vcxproj files (projects) and also, annoyingly, stores debugger breakpoints.

The .vsarduino.h in the _vm folder can also be ignored. The xml files in the _vm folder store the project settings such as extra defines, compiler switches, debugger settings that you have added manually. If you haven't changed any of the defaults then the files have no use. If you are using the debugger the xml files also keep track of the what the settings were after the last upload.

Vs creates some files/folders sometimes and they can be ignored.

The Release/debug folders can be ignored unless, as you say, you want to keep versions of previous binaries.

  
Back to top
IP Logged
 
Page Index Toggle Pages: 1
Send TopicPrint