Difference between revisions of "Project Settings"
Line 20: | Line 20: | ||
</pre> | </pre> | ||
− | =Settings Description= | + | =Project Settings Description= |
* <code>'''Break'''</code> - Keyboard key to pause debugging in VMS IDE debugger. The extension uses combination <code>CTRL+Key</code> to pause debugging when user press '''Pause''' or <code>F6</code>. | * <code>'''Break'''</code> - Keyboard key to pause debugging in VMS IDE debugger. The extension uses combination <code>CTRL+Key</code> to pause debugging when user press '''Pause''' or <code>F6</code>. | ||
* <code>'''Builders'''</code> - Mask for files used for building the project. Default is "*.{mms,com}". | * <code>'''Builders'''</code> - Mask for files used for building the project. Default is "*.{mms,com}". | ||
Line 34: | Line 34: | ||
* <code>'''Additional libraries'''</code> - list of libraries in ODS-5 format, separated by commas. | * <code>'''Additional libraries'''</code> - list of libraries in ODS-5 format, separated by commas. | ||
* <code>'''Additional include folders'''</code> - list of folders in ODS-5 format, separated by commas. | * <code>'''Additional include folders'''</code> - list of folders in ODS-5 format, separated by commas. | ||
+ | |||
+ | =Adjusting Project Settings= | ||
+ | # Set the <code>'''Root'''</code> directory. For example, if the project is located in '''WORK:[USER.DEMOS.SIMPLE]''' and the home directory is '''WORK:[USER]''', set the parameter value to '''demos/simple'''. | ||
+ | # Select the <code>'''Project Type'''</code> that you need. | ||
+ | # Specify the <code>'''Project Name'''</code>. '''NOTE''': do not use spaces or special characters. | ||
+ | # Check <code>'''Builders'''</code>. These files will be synchronized. | ||
+ | # Check <code>'''Headers'''</code>. These files will be synchronized and included into the [[Auto-generating MMS|auto-generated MMS]] file as header files. Changing any of them will result in full project rebuild. | ||
+ | # Check <code>'''Source'''</code>. These files will be synchronized and included into the [[Auto-generating MMS|auto-generated MMS]] file as source files. | ||
+ | # Check <code>'''Resource'''</code>. These files will be synchronized but not included into the [[Auto-generating MMS|auto-generated MMS]] file. | ||
+ | # Adjust the <code>'''Exclude'''</code> field value to list the files similar to the described above but not to be synchronized and compiled. | ||
+ | # Check <code>'''Listing'''</code>. These files will be downloaded after building the project. Files "*.lis,*.map" are required for debugger. | ||
+ | # If the project depends on already installed libraries, specify the in the <code>'''Additional libraries'''</code> and <code>'''Additional include folders'''</code> | ||
[[Category:VMS IDE]] | [[Category:VMS IDE]] |
Revision as of 19:09, 13 August 2019
Project Configuration Example
{ "project": { "break": "C", "builders": "*.{mms,com}", "exclude": "**/{node_modules,.vscode}/**", "headers": "*.h", "listing": "*.lis", "outdir": "out", "projectName": "project", "projectType": "executable", "resource": "**/resource/**", "root": "project", "source": "*.{cpp,c}", "addLibraries": "sys$library:IMAGELIB.OLB,sys$library:RDBMSGS.OLB", "addIncludes": "sys$library" } }
Project Settings Description
Break
- Keyboard key to pause debugging in VMS IDE debugger. The extension uses combinationCTRL+Key
to pause debugging when user press Pause orF6
.Builders
- Mask for files used for building the project. Default is "*.{mms,com}".Exclude
- Folders excluded from synchronization with OpenVMS system.Headers
- Header files. Default is "*.{h,hpp}".Listing
- Listing files that will be downloaded after the project is built for debugging purpose.Outdir
- Output directory where object, listing and executable files will be stored when built. Is also used for temporary files. NOTE: Should be only the name of the folder, not a full or relative path.Project Name
- Name for the executable file, auto-generated MMS file for builder, OPT file for linker, and COM file for defining logical names. NOTE: Use one word only; do not use spaces or special characters.Project Type
- Type of the project. Available types: executable, library or shareable. The building method depends on the type of the project and its dependencies.Resource
- Files required for the project, but are not involved in the build process.Root
- Directory of the project on the remote OpenVMS machine in UNIX format relative to the home folder.Source
- Mask for the source files, e.g. "*.{c,cpp}".Additional libraries
- list of libraries in ODS-5 format, separated by commas.Additional include folders
- list of folders in ODS-5 format, separated by commas.
Adjusting Project Settings
- Set the
Root
directory. For example, if the project is located in WORK:[USER.DEMOS.SIMPLE] and the home directory is WORK:[USER], set the parameter value to demos/simple. - Select the
Project Type
that you need. - Specify the
Project Name
. NOTE: do not use spaces or special characters. - Check
Builders
. These files will be synchronized. - Check
Headers
. These files will be synchronized and included into the auto-generated MMS file as header files. Changing any of them will result in full project rebuild. - Check
Source
. These files will be synchronized and included into the auto-generated MMS file as source files. - Check
Resource
. These files will be synchronized but not included into the auto-generated MMS file. - Adjust the
Exclude
field value to list the files similar to the described above but not to be synchronized and compiled. - Check
Listing
. These files will be downloaded after building the project. Files "*.lis,*.map" are required for debugger. - If the project depends on already installed libraries, specify the in the
Additional libraries
andAdditional include folders