GBS Logo HOME Generic Build Support (GBS) - User Manual
Environment Variables (EnvVars) Bottom Doc. Button

Description Bottom Doc. Button Top Document Button Down Section Button Blank

GBS relies heavily on Environment Variables (EnvVars)
They are all controlled by GBS.
There is a lot of inter dependency between the GBS EnvVars and they must be set as a group.
Some EnvVars (most) are intrinsically set by GBS, others (a few) may be set by the User and that has to be done by using the proper GBS functionality that supports that.

Changing EnvVars by just setting them may lead to unexpected results and may cause GBS to crash or loose integrity
All GBS EnvVar are prefixed by either GBS_, GBSEXT_ or GBSALLEXT_
Index

GBS_ EnvVars Bottom Doc. Button Top Document Button Down Section Button Blank Down Chapter Button Blank

Note that the following table is sortable by the items in the top row.
Level EnvVar Name Possible Values Usage More
Info
Set by Changed
by
Remarks
1 Pre GBS_PERL_PATH directory path Define location of Perl More User User Optional
1 Pre GBS_BASE_PATH directory path Define location of .gbs   gbsinit N/A Internal
1 Pre GBS_HOME directory path Define a HOME-path   User User Deprecated
1 Pre GBS_XTITLE text Define Window Title More User User Deprecated
2 GBS GBS_RC Number Scripts return status   various scripts  
2 GBS GBS_SITE Short name in uppercase Name your Site More gbsinit gbssetup  
2 GBS GBS_LOG_ROOT directory path Log Files Root Location More gbsinit gbssetup Contains GBS_LOG_PATHs per GBS_ROOT_PARENT
2 GBS GBS_LOG_PATH directory path Log Files Location More gbsinit switch.gbs Set to $GBS_LOG_ROOT/$GBS_ROOT_PARENT
2 GBS GBS_BEEPS YES NO Beep More gbsinit gbssetup  
2 GBS GBS_EDITOR command_path Editor to be used More gbsinit gbssetup  
2 GBS GBS_BROWSER command_path Browser to be used More gbsinit gbssetup  
2 GBS GBS_VIEWER command_path File viewer to be used More gbsinit gbssetup  
2 GBS GBS_ADMINISTRATOR System-names List Defines Administrator More gbsinit gbssetup Internal
2 GBS GBS_INTEGRATOR System-names List Defines Integrator More gbsinit gbssetup Internal
2 GBS GBS_TEMPLATES_PATH directory path User Templates path (OPT) More gbsinit swr gbsall
switch.gbs
2 GBS GBS_MAKE command_path Alternative 'make' (OPT) More gbsinit swr gbsall
switch.gbs
2 GBS GBS_SUBMIT command_path Alternative Submit (Background) (OPT) More gbsinit swr gbsall
switch.gbs
2 GBS GBS_SUBWIN command_path Alternative Submit (Foreground) (OPT) More gbsinit swr gbsall
switch.gbs
2 GBS GBS_BATCH command_path Alternative Batch command (OPT) More gbsinit swr gbsall
switch.gbs
2 GBS GBS_BG_NOTIFIER command_path Notifier for Submit completion (OPT) More gbsinit swr gbsall
switch.gbs
2 GBS GBS_BUILD RVVYYMMDD Current Release/Build More gbsinit Predefined  
2 GBS GBS_EXEC_MODE INTERACTIVE FOREGROUND
BACKGROUND
Execution Mode   gbsinit gbssys* Internal
2 GBS GBS_GUI Tkx None Available Perl GUI   gbsinit Predefined Internal
2 GBS GBS_PERL_CMD perl with or without path Direct Perl execution command   gbsinit Predefined  
2 GBS GBS_WPERL_CMD perl with or without path Command to start Perl GUI   gbsinit Predefined  
2 GBS GBS_PID number PID of toplevel process   gbsinit Predefined Internal
2 GBS GBS_PLATFORM Linux Win32 Current platform More gbsinit Predefined Scripts
2 GBS GBS_SCRIPTS_ROOT directory path Where GBS versions are installed More gbsinit gbssetup Internal
2 GBS GBS_SCRIPTS_REL version version_build The current GBS version directory More gbsinit gbssetup Internal
2 GBS GBS_SCRIPTS_PATH Root/Rel The current GBS scripts location More gbsinit gbssetup  
2 GBS GBS_SHELL_FILETYPE .bat .sh The current shell filetype   gbsinit gbssetup  
2 GBS GBS_VERSION version (e.g.: 4.00) The current GBS version number More gbsinit Predefined  
2 GBS GBS_VERBOSE 0 1 Verbose logging More gbsinit All Commands (Internally) Always 1 in BATCH jobs (gbssys*)
3 Root GBS_SYSTEM_NAME name Name of the System/Root More swr    
3 Root GBS_ROOT_PATH directory path Current system root More swr    
3 Root GBS_ROOT_PARENT directory name Parent dir of current Root More swr    
3 Root GBS_ALL_AUDITS names list All platform Audits   swr    
3 Root GBS_AUDITS names list All Audits for this Platform   swr    
3 Root GBS_AUDIT name Current Audit   swr gbsaudit  
3 Root GBS_AUDIT_PLUGIN name Current Audit Plugin   swr gbsaudit  
3 Root GBS_ALL_TARGETS names list All platform Targets   swr    
3 Root GBS_TARGETS names list All Targets for this Platform   swr    
3 Root GBS_TARGET name Current Target   swr swt  
3 Root GBS_TARGET_PLUGIN name Current Target Plugin   swr swt  
3 Root GBS_ALL_TOOLS names list All platform Tools   swr    
3 Root GBS_TOOLS names list All Tools for this Platform   swr    
3 Root GBS_TOOL name Current Tool   swr gbssystool  
3 Root GBS_TOOL_PLUGIN name Current Tool Plugin   swr gbssystool  
3 Root GBS_ALL_SUBSYSTEMS names list All SubSystems   swr sws --new  
3 Root GBS_IS_ADMINISTRATOR 0 1 User is Administrator More swr gbssetup  
3 Root GBS_IS_INTEGRATOR 0 1 User is Integrator More swr gbssetup  
3 Root GBS_SKIPTYPES regexp List Filetypes to be skipped   swr   Internal
3 Root GBS_PLATFORMS Platform list Platforms this root generates for       Internal
3 Root GBS_SCMS None Subversion Git CVS ... Current SCMS More swr   Internal
3 Root GBS_SCMS_DATA path Internal Path More swr   Internal
3 Root GBS_SCMS_REPOSITORY file/directory path/URL SCMS Repository location More swr   Internal
3 Root GBS_SCM_SKIPTYPES Regexp List Filetypes for Current SCMS More swr   Internal
3 Root GBS_DEV_PATH directory path ROOT/dev More swr    
3 Root GBS_EXT_PATH directory path ROOT/ext More swr    
3 Root GBS_RES_PATH directory path ROOT/res More swr    
3 Root GBS_SILO_PATH directory path ROOT/silo More swr   Internal
3 Root GBS_SYS_PATH directory path ROOT/sys More swr    
3 Root GBS_SYSAUDIT_PATH directory path ROOT/sysaudit More swr    
3 Root GBS_SYSBUILD_PATH directory path ROOT/sysbuild More swr    
3 Root GBS_SYSTOOLS_PATH directory path ROOT/systools More swr    
3 Root GBS_TMP_PATH directory path ROOT/tmp More swr   Internal
4 Sub GBS_SUBSYS name Current SubSys More sws    
4 Sub GBS_SSTYPE GBS make MSVS Other Current SubSystem Type More sws    
4 Sub GBS_SUBSYS_PATH directory path ROOT/dev/SUBSYS More sws    
4 Sub GBS_AUDIT_PATH directory path ROOT/dev/SUBSYS/audit More sws    
4 Sub GBS_BUILD_PATH directory path ROOT/dev/SUBSYS/build More sws    
4 Sub GBS_TOOLS_PATH directory path ROOT/dev/SUBSYS/tools More sws    
4 Sub GBS_EXPORT_PATH directory path ROOT/dev/SUBSYS/export (OPT) More sws    
4 Sub GBS_IMPORT_PATH directory path ROOT/dev/SUBSYS/import (OPT) More sws    
4 Sub GBS_COMP_PATH directory path ROOT/dev/SUBSYS/comp More sws   SSTYPE==GBS
4 Sub GBS_APP_PATH directory path ROOT/dev/SUBSYS/app More sws   SSTYPE!=GBS
5 Cmp GBS_COMPONENT name Current Component More swc   SSTYPE==GBS
4 Cmp GBS_COMPONENT_PATH directory path ROOT/dev/SUBSYS/comp/COMPONENT More swc   SSTYPE==GBS
5 Ses GBS_DEBUGGER YES NO Include Debugger (build) More User User Scripts
5 Ses GBS_MAP YES NO Produce a memory map (linking) More User User Scripts
5 Ses GBS_MODE FINAL ASSERT DEBUG PROFILING Override Build mode More User User Scripts
5 Ses GBS_OPT YES SPEED SIZE DEBUG NO Override Optimisation More User User Scripts
5 Ses GBS_FLAGS_type flags Predefine flags (-D...) More User User Scripts
6 Exe GBS_BLD_src_type File type Derived Object filetype More gbsgen gbsmake   Scripts
6 Exe GBS_IGNORE_ERRORS 0 1 --i was specified More gbssysgen gbssysmake   Scripts
6 Exe GBS_FLAGS_type flags or flags_file ref Flags (-D...) More gbssys* gbsgen gbsaudit   Scripts
6 Exe GBS_SYSFLAGS_type flags or flags_file ref System Flags (-D...) More gbssys* gbsgen gbsaudit   Scripts
6 Exe GBS_INCS_type includes or includes_file ref Include Flags (-I...) More gbssys* gbsgen gbsaudit   Scripts
6 Exe GBS_SYSFLAGS_type includes or includes_file ref System Include Flags (-I...) More gbssys* gbsgen gbsaudit   Scripts
6 Exe GBS_MAKE_FLAGS -i or empty -i if GBS_IGNORE_ERRORS == 1 More gbssysgen   Scripts
SSTYPE==make
6 Exe GBS_MSBUILD_CONFIG Debug Release or empty Depends on GBS_MODE More gbssysgen   Scripts
SSTYPE==MSVS

GBSEXT_ EnvVars For SCMS Bottom Doc. Button Top Document Button Down Section Button Blank Down Chapter Button Up Chapter Button

The value must be either the directory where the SCMS is installed or PATH if the SCMS command(s) are in the PATH.

Note that the following table is sortable by the items in the top row.
EnvVar Name Required for
GBSEXT_CC_PATH ClearCase
GBSEXT_CCM_PATH IBM Rational Synergy
GBSEXT_CVS_PATH CVS
GBSEXT_GIT_PATH Git
GBSEXT_SVN_PATH Subversion
GBSEXT_VSS_PATH Visual Source Safe

GBSEXT_ EnvVars For Plugins Bottom Doc. Button Top Document Button Blank Blank Blank Up Chapter Button

GBSEXT_... EnvVars define the location of external stuff (Plugins and External Data).
Usually 3 EnvVars are defined (Hard versioned directories): Just before executing the plugin the following GBSEXT_ EnvVar will be defined:
Note that the following table is sortable by the items in the top row.
Type Plugin EnvVar Required Platform Remarks
Builder MinGW C GBSEXT_MINGW_GCC REL and PATH Win32  
Builder MinGW C/C++ GBSEXT_MINGW_CPP REL and PATH Win32  
Builder Microsoft Visual Studio 2012 - Simple Console C/C++ GBSEXT_MSVS2012_CONS REL and PATH Win32  
Builder Green Hills - BlackFin C/C++ GBSEXT_GHSBF REL and PATH Win32  
Builder GNU C GBSEXT_LGNU_GCC REL and PATH Linux  
Builder GNU C/C++ GBSEXT_LGNU_CPP REL and PATH Linux  
Audit PC-Lint C/C++ GBSEXT_PCLINT REL and PATH Win32  
Audit QAC GBSEXT_QAC REL and PATH Both  
Audit QAC++ GBSEXT_QACPP REL and PATH Both  
Tool Doxygen GBSEXT_DOXYGEN REL and PATH Both