Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Non-Build-Commands:

This section covers all command supported by WAF which are not related to building the CryEngine.

cry_waf.exe --help

Shows the help screen, an overview about all commands and options supported by WAF.

cry_waf.exe configure

Performs a configure step. This operations checks some compiler settings and caches those.

Very much like the ./configure operation used for linux projects.

cry_waf.exe msvs

Generates a Visual Studio Solution and Projects which can be used to build the CryEngine with WAF.

cry_waf.exe generate_uber_files

Generates Uber files which are used to speed up compilation by merging multiple translation units into a single

large translation units.

Build-Commands:

This section covers all commands relevant for building projects with WAF. It features also an overview about all build options, since those are mostly relevant for

building projects.

cry_waf.exe build_<platform>_<configuration>

This command performs a build operation; all dependencies are checked, and all needed compile tasks are executed to generate the final executables and libraries.

<platform>: referrs to one of the supported target platforms on the current host.

<configuration>: referrs to one of the supported build configurations.

 

cry_waf.exe clean_<platform>_<configuration>

This command performs a clean operation; all intermediate files previosly generated by another build command. Follows the same pattern for <platform> and <configuration> as the build command.

 

Build Options:

This section focuses on all options WAF accepts as parameters for the build command.

Most options can also be changed in the configuration files BinTemp/cry_waf.options.

Project Options:

--project-specc=<string>

Project Specc to use during compilation. This is a mandatory options. Please see WAF Commands for valid parameters.

No Default Value.

--targets <string>,<string>

The targets option can be used to only compile a single project instead of the full engine. When providing a target option only the specified projects are compiled and all of theirs required dependencies.

E.g. "cry_waf.exe build_win32_profile --target Cry3DEngine" can be used to only compile the Cry3DEngine for win32 in profile configuration.

Incredibuild Options:

--use-incredibuild=<True/False>

This option specifies of Incredibuild Should be used for compilation.

The default value depends on the assigned Incredibuild licenses.

--use-incredibuild_win=<True/False>

This option specifies of Incredibuild Should be used for compilation of windows platforms.

The default value depends on the assigned Incredibuild licenses.

--use-incredibuild_orbis=<True/False>

This option specifies of Incredibuild Should be used for compilation of Orbis platforms.

The default value depends on the assigned Incredibuild licenses.

--use-incredibuild_durango=<True/False>

This option specifies of Incredibuild Should be used for compilation of Durango platforms.

The default value depends on the assigned Incredibuild licenses.

--incredibuild-max-cores=<N>

Number of parallel threads to create when compiling with incredibuild. Should be larger than the number of processors (64 in case of Incredibuild), but not too large.

The default currently is 128 threads. Don't increase it too much, since python doesn't handle such large thread numbers well.

P4 Branch Bootstrap Options:

--p4user=<string>

Username for Perforce when performing a branch bootstrap operation.

This option is asked for when running WAF for the first time.

--p4client=<string>

Workspace name for Perforce when performing a branch bootstrap operation.

This option is asked for when running WAF for the first time.

--p4host=<string>

Ip address and port of Perforce server for branch bootstrapping.

The default is perforce:1666

--3rdParty-p4user=<string>

Username for Perforce when performing a branch bootstrap operation for the 3rdparty workspace.

This options is asked for when running WAF for the first time.

--3rdParty-p4client=<string>

Workspace name for Perforce when performing a branch bootstrap operation for the 3rdparty workspace.

This options is asked for when running WAF for the first time.

--3rdParty-p4host=<string>

Ip address and port of Perforce server for branch bootstrapping for the 3rdparty workspace.

The default is perforce:1666.

--bootstrap_dat=<string>

Name of the bootstrap.dat file when running branch bootstrap automatically with waf.

The default is bootstrap.dat.

Misc Options:

--support-recode=<True/False>

Should WAF check if recode is enabled, and potentially adjust the compile command according to Recode requirements.

The default is True.

Build Options:

--generate-debug-info=<True/False>

During compilation, should the compiler be instructed to generate debug information?

The default is True.

--use-precompiled-header=<True/False>

Should, if those are provided, precompiled header be used during compilation?

*Note* Currently precompiled headers are automatically disabled for projects using uber files since they don't bring any performance benefit in this case.

The default is True.

--use-uber-files=<True/False>

During compilation, should uber files be used if they are provided?

The default is True.

--output-folder-win32=<string>

Path into which all final build results (executables, dlls etc) from a win32 build are copied

The default is Bin32

--output-folder-win64=<string>

Path into which all final build results (executables, dlls etc) from a win64 build are copied

The default is Bin64

--output-folder-orbis=<string>

Path into which all final build results (executables, dlls etc) from a Orbis build are copied

The default is BinOrbis

--output-folder-durango=<string>

Path into which all final build results (executables, dlls etc) from a Durangobuild are copied

The default is BinDurango

Visual Studio Addin Options:

(those options are designed to be used by the Visual Studio Addin, but can of course be used by the command line interface)

--ask-for-user-input=<True/False>

Inform WAF to not ask about for user input. This flag is needed some the Visual Studio Output Tab doesn't accept inputs.

The default is True

--file-filter=<string>

During compilation, only actually compile files which match this file filter.

The default is ""

--show-includes=<True/False>

Instead of compiling a file, output all files included by the compiled file.

The default is False

--show-preprocessed=<True/False>

Instead of compiling a file, show the preprocessed file.

The default is False

--show-disassembly=<True/False>

Instead of compiling a file, show the disassembly output.

The default is False

--output-file=<string>

Specifiy a single file to write the output to. Used for --show-preprocessed and --show-disassembly

The default is ""

--use-overwrite-file=<True/False>

Try to load the overwrite file (BinTemp/cry_waf.configuration_overwrites) to change project configurations. (This file is generated by the Visual Studio Addin)

The default is "False"

 

  • No labels