Command Line Options Reference
Contents
Command Line Options Reference#
This topic shows the command line options, current deprecated options, and information for working with source files.
Command Line Options#
The following table lists all current Intel® DPC++ Compatibility Tool command line options in alphabetical order.
Option |
Description |
---|---|
|
Use async exception handler when creating new |
|
The directory path for the analysis scope of the source tree that needs
to be migrated. Default: the value of |
|
Provides a hint to the tool on the dimensionality of nd_range to use in generated code. The values are:
|
|
Specifies the name of generated makefile for migrated file(s). Default name:
|
|
Limit extension change to |
|
Enable detection and warnings about Unicode constructs that can be exploited by
using bi-directional formatting codes and homoglyphs in identifiers. Default: |
|
Insert comments explaining the generated code. Default: |
|
The directory path for the compilation database (compile_commands.json). When no
path is specified, a search for compile_commands.json is attempted through all
parent directories of the first input source file. Same as |
|
The directory path of the CUDA* header files. |
|
DEPRECATED: Specifies the helper headers folder name and main helper header file
name. Default: |
|
Use a C++17 class template argument deduction (CTAD) in your generated code. |
|
Enable SYCL* queue profiling in helper functions. Default: |
|
Specify additional arguments to append to the migration command line. The option accepts a comma-separated list of extra arguments and may be used multiple times in a command. For example: dpct xx.cu --extra-arg="-I /path, -I /path2" --extra-arg="-I /path/to/header"
Use the |
|
Sets the range of formatting. The values are:
|
|
Sets the formatting style. The values are:
Example for the .clang-format file content: BasedOnStyle:
LLVM IndentWidth: 4
TabWidth: 4
UseTab: ForIndentation
|
|
Generates makefile for migrated file(s) in |
|
Generates helper function files in the |
|
Provides a list of |
|
Print the installation directory for helper function header files. |
|
The preference of helper function usage in migration. Value:
|
|
The directory path for the root of the source tree that needs to be migrated. Only files under this root are migrated. Default:
Details:
|
|
Excludes the specified directory or file from processing. |
|
Keeps the original code in the comments of generated SYCL files. Default: |
|
DEPRECATED: Do not use |
|
A comma-separated list of extensions not to be used in migrated code. By default, these extensions are used in migrated code. The values are:
|
|
Do not use a Don’t Repeat Yourself (DRY) pattern when functions from the
|
|
Tells the tool to not perform an incremental migration. Default: |
|
Generates SYCL code applying more aggressive assumptions that
potentially may alter the semantics of your program. Default: |
|
The directory path for root of generated files. A directory is created if
it does not exist. Default: The relative paths for the generated files are maintained. By default, file extensions are changed as follows:
To limit file extension changes to |
|
Redirects the |
|
Sets the output verbosity level:
|
|
Alias for |
|
Migrates or copies all files, except hidden, from the Details: If
|
|
Query functionally-compatible SYCL API to migrate CUDA API. |
|
Prefix for the report file names. The full file name will have a suffix
derived from the |
|
Format of the reports:
|
|
Only reports are generated. No SYCL code is generated. Default: |
|
Specifies the type of report. Values are:
|
|
Specifies the rule file path that contains rules used for migration. |
|
Stop migration and generation of reports if parsing errors happened. Default: |
|
A comma-separated list of migration warnings to suppress. Valid warning IDs
range from 1000 to 1118. Hyphen-separated ranges are also allowed. For
example: |
|
Suppresses all migration warnings. Default: |
|
Generates kernels with the kernel name. Default: |
|
DEPRECATED: Customize the helper header files for migrated code. The values are:
|
|
A comma-separated list of extensions to be used in migrated code. By default, these extensions are not used in migrated code.
|
|
A comma-separated list of experimental features to be used in migrated code. By default, experimental features will not be used in migrated code. The values are:
|
|
Defines the namespaces to use explicitly in generated code. The value is
a comma-separated list. Default: Possible values are:
|
|
Sets the Unified Shared Memory (USM) level to use in source code generation:
|
|
The file path of |
|
Shows the version of the tool. |
Note
Specifying any of the following options will trigger report generation:
--report-file-prefix
--report-type
--report-format
--report-only
Deprecated Command Line Options#
The following table lists Intel® DPC++ Compatibility Tool command line options that are deprecated.
Deprecated Option |
Suggested Replacement |
---|---|
|
No replacement |
|
|
|
No replacement |
intercept-build Options#
The following table lists all current intercept-build tool command line options in alphabetical order.
Option |
Description |
---|---|
–append |
Extend existing compilation database with new entries. Duplicate entries are detected and not present in the final output. The output is not continuously updated; it’s done when the build command finished. Default: disabled. |
–cdb <file> |
The JSON compilation database. Default name: compile_commands.json. |
–linker-entry |
Generate linker entry in compilation database if the –linker-entry option is present. Default: enabled. |
–no-linker-entry |
Do not generate linker entry in compilation database if the –no-linker-entry option is present. Default: disabled. |
–parse-build-log <file> |
Specifies the file path of the build log. |
–verbose, -v |
Enable verbose output from intercept-build. A second, third, and fourth flag increases verbosity. |
–work-directory <path> |
Specifies the working directory of the command that generates the build log specified by option -parse-build-log. Default: the directory of build log file specified by option -parse-build-log. |