Command Line Options Reference¶
This topic shows the command line options with a short description, 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: |
|
A set of functions from the C and C++ standard libraries that are allowed to be used in SYCL device code. |
|
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 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. |
|
Additional argument to append to the migration command line, example:
|
|
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 |
|
Provides a list of |
|
The directory path for the root of the source tree that needs to be migrated. Only files under this root are migrated. Default:
Details: Any source within the directory specified by |
|
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 will be used in migrated code.
|
|
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, and the extension is changed as follows:
|
|
Redirects the |
|
Sets the output verbosity level:
|
|
The directory path for the compilation database ( |
|
Migrates or copies all files, except hidden, from the Details: If
|
|
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 1100. 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 these 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 currently deprecated.
Deprecated Options |
Suggested Replacement |
---|---|
|
|
Source Files¶
To work with source files use <source0> ...
to create paths
for your input source files. These paths can be found in the
compilation database.
Examples:
Migrate single source file:
dpct source.cpp
Migrate single source file with C++11 features:
dpct --extra-arg="-std=c++11" source.cpp
Migrate all files available in compilation database:
dpct -p=<path to location of compilation database file>
Migrate one file in compilation database:
dpct -p=<path to location of compilation database file> source.cpp