GBS Logo HELP HOME Generic Build Support (GBS) - User Manual
The gbssys... commands Bottom Doc. Button
Release RMC-06.02
(2024-04-29)


- Home
Getting Started
- Quick Start
- Release Notes
- Install Notes
- Create a GBS-WA/System
- FAQ
- Terms and Conditions (The Fine Print)
Basics
- Definitions & Acronyms
- Introduction
- Top Level Directory Structure
- Full Directory Structure
- Handling SubSystems & Steps
- Procedures
- Software Configuration Management Support

Manual Pages
- The Command-Line Interface
- All Commands
- The gbssys... Commands
- Generating Code (Building)
- Libraries & Executables and Testing
- Exporting Deliverables
- Auditing
- Customisations (Session)
- Customisations (User)
- Customisations (Admin)
- Integration with other Tools
- Plugins (Admin)
- Environment Variables (EnvVars)
User Files
- The GLKBT (glk/glb/glt) Files
Internal (.gbs) Files
- GBS Files - General
- audit.gbs
- broadcast.gbs
- build.gbs
- export.gbs
- flags_*.gbs
- subsys.gbs (.bat/.sh)
- incs_*.gbs
- owners.gbs
- sca_*.gbs
- scope.gbs
- site.gbs (.bat/.sh)
- steps.gbs
- switch.gbs (.bat/.sh)
- system.gbs
- tool.gbs
Various
- Development
- About
- Metrics Help

Full Documentation
- All Docs - Printable


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

gbssysbuild, gbssysmake, gbssysaudit, gbssystool and gbssysall Bottom Doc. Button Top Document Button Down Section Button Blank Down Chapter Button Blank

The gbssys... commands are used to perform actions involving more than one SubSystem.

gbssysbuild   is used to generate a whole or part of a whole System
gbssysmake   is used to 'make' a whole or part of a whole System
gbssysaudit   is used to audit a whole or part of a whole System
gbssystool   is used run a tool on the whole or part of a whole System

gbssysall   is used run all of the above

These commands will perform their functions over various SubSystems in the appropriate order and allows extra steps to be executed.
It is also possible to generate a number of SubSystems selectively.
The generations steps, their required order and allowed options are defined in the steps.gbs file (in $GBS_SYS_PATH).
Execution will be performed in the batch and the output is logged in a log-file.

Usage

gbssys...  [ steps | CUR | ALL ] [ GBS-options ] [ APP-options ] [ GBS-env-variables ] [ other_gbs_options ]
steps
Specifies the names of the steps to be executed
The stepnames are defined in the steps.gbs file.
If no steps are specified, all steps are assumed. Same as ALL.
If CUR is specified only the current SubSystem, with current Build, Audit or Tool is executed.
The '-' can be used to specify 'from - to' steps. It must be surrounded by spaces.
An empty 'from' specifies 'from the first'
An empty 'to' specifies 'to and including the last'
E.g.: step1 - step3 step6 step8 step9 -
-→ step1 step2 step3 step6 step8 step9 step10 step11 ... stepnn

GBS-options
Contain an '='.
Standard GBS-options:
BUILD =...
DEBUGGER =,YES,NO
MODE =,FINAL,ASSERT,DEBUG
OPT =,YES,SPEED,SIZE,NO
MAP =,NO,YES
FLAGS_MAKE =...
FLAGS_src_type =...
e.g.: BUILD=FINAL MODE=DEBUG

APP-options
Contain an '=' As defined in the GBS Customisation (Session) file
e.g. APP_PROFILING=YES

GBS-env-variables
Any assignment that starts with GBS_ is considered a request to define a (temporary) GBS environment-variable with that value.
e.g. GBS_FLAGS_MAKE="-u" will set the GBS_FLAGS_MAKE Environment Variable to the specified value for the duration on the command.

LOG files Bottom Doc. Button Top Document Button Down Section Button Blank Down Chapter Button Up Chapter Button

.log files

Log files are written to $GBS_LOG_PATH, which unless defined in switch.gbs points to $GBS_LOG_ROOT/$GBS_SYSTEM_PARENT.
For each run 2 to 3 files will be generated:
  • logfile_name.log
    The actual logfile
  • logfile_name.log.sum
    A fixed-format summary of the logfile
  • logfile_name.err
    Only in case of errors

The logfile_name

gbssys-command_build-or-tool_audit-or-hyphen_packed-num-date-time
packed-num-date-time := YYYYMMDD-hhmmss
E.g.: gbssysaudit_mingw_pclint_20150214-12:00:00

The .log.sum file

This file contains a summary of the .log file.
It is a fixed-format file. One item per line.
Its layout will never change. Although new items may be added at the end, before the <<EOF>>.
This file can be used for your own tooling to extract information from the run.
Format:
jobname : gbssysbuild gbssysmake gbssysaudit gbssystool'
build_or_tool :
uname : computer name and id
os_root_spec : $GBS_SYSTEM_PATH
os_logfile_spec : $GBS_LOG_PATH/$jobname_$build_$audit_$datetime.log
time_start : YYYY-MM-DD hh:mm:ss
time_end : YYYY-MM-DD hh:mm:ss
time_diff : hhh:mm:ss
timer_diff : "$clock $cpu_system $cpu_user $cpu_all" in seconds
state : NORMAL FAILED KILLED
rc : Return Code (Numeric. 0 == OK)
audit : or '-'
date_time : YYMMDD-hhmmss as used in os_logfile_name
command_args : From the command-line
comment : From the command-line (--c=...)
<<EOF>> :

.html files

These are the Summary files resulting from gbsaudit and not from gbssysaudit

gbssys.html