Subprojects in a Source Code Control System
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/27/2008
This topic provides information about best practices for managing Windows Embedded CE 6.0 subprojects in a source code control environment.
A subproject file (.pbpxml) is an XML-based file that contains minimal metadata information about the subproject itself. Subprojects utilize other file types to perform the following tasks.
- To bring components into an OS design, a subproject uses its related binary image builder (.bib) and registry (.reg) files.
- To provide build-specific information, a subproject uses sources and dirs files.
Subprojects provide a method where you can create a source code tree that you can share between OS designs. A PBPXML subproject is a subproject located in the OS tree rather than as a subdirectory of an existing OS design. This means that the PBPXML subproject is not dependent on a specific OS design alone.
For more information about subprojects, see Subprojects.
Getting Started with PBPXML Subprojects
To create a PBPXML subproject that enables you to share source code between OS designs, perform the following steps.
- In the OS tree, create a root directory for the project that you want to create.
- In this root directory, use a text editor to create a text file named DIRS.
- In this file, add the following code to the file, and then save the file.
DIRS=
- In the root directory, create .bib, .reg, and .db files for the project file hierarchy.
- Open the OS design to which you want to add the PBPXML subproject and then, from the Project menu, select Add Existing Subproject.
- Browse to the location of the DIRS file for the subproject that you want to add, and then select the file.
- Under this folder, choose Add New Subproject.
This results in the creation of a .pbpxml subproject file for the hierarchy.
You have added the PBPXML subproject to an OS design.
PBPXML Subprojects in Source Code Control
When placing a PBPXML subproject under source code control, these files should be checked into the source code control database.
- Files with the following extensions: BIB, REG, DAT, DB, BAT, PBPXML
- SOURCES or DIRS files
- Any source code files
Do not add the following files to the source code control database.
- The obj directory and its subdirectories
- Build.dat, build.err, build.log, build.wrn
- Any files that have names ending in '.user'