Sharing the Settings
This guide explains how to share the Jam project configuration files with your team.
The settings are stored in separate files to give better control over what's shared in VCS. These files are normally located under: <project directory>/.idea/.
TL;DR
- Include these files in git:
- jam_project.xml
- jam.xml
- command_parser.xml
- Exclude this file from git:
- workspace.xml
Portable Settings
All of these files can be shared in git, but they can also be independently excluded from it.
They are all meant to be shared, but in some cases, that's not ideal.
jam_project.xml
- This file stores:
- Build targets
- Build types
- Build variants
The working directory and executable path are stored in a portable way: relative to the project directory.
Custom environmental variables are included as well. These are stored without modification. In some cases, this isn't portable.
jam.xml
- This file stores:
- Jam command or path
- Command line arguments for Jam
Share this if the team uses the same Jam variant. Otherwise, these options could vary.
command_parser.xml
- This file stores:
- How to interpret Jam's output
Non-portable Settings
workspace.xml
This file is created by the IDE by default.
- This file stores:
- User settings specific to the project
This file should not be included in git.