OVERVIEW: Swift API Digester
USAGE: swift-frontend
OPTIONS:
-abi Dumping ABI interface
-abort-on-module-fail Abort if a module failed to load
-avoid-location Avoid serializing the file paths of SDK nodes.
-avoid-tool-args Avoid serializing the arguments for invoking the tool.
-baseline-dir <value> The path to a directory containing baseline files: macos.json, iphoneos.json, appletvos.json, watchos.json, and iosmac.json
-baseline-path <value> The path to the Json file that we should use as the baseline
-BF <value> add a directory to the baseline framework search path
-BI <value> add a module for baseline input
-breakage-allowlist-path <value>
An allowlist of breakages to not complain about
-bsdk <value> path to the baseline SDK to import frameworks
-clang-target <value> Separately set the target we should use for internal Clang instance
-compiler-style-diags Print compiler style diagnostics to stderr.
-debug-mapping Dumping information for debug purposes
-deserialize-diff Deserialize diff items in a JSON file
-deserialize-sdk Deserialize sdk digester in a JSON file
-diagnose-sdk Diagnose SDK content in JSON file
-disable-fail-on-error Don't exit with a nonzero status if errors are emitted
-disable-os-checks Skip OS related diagnostics
-disable-remove-deprecated-check
Skip diagnosing removal of deprecated symbols
-dump-sdk Dump SDK content to JSON file
-empty-baseline Use empty baseline for diagnostics
-enable-remove-deprecated-check
Diagnosing removal of deprecated symbols
-external-plugin-path <path>#<plugin-server-path>
Add directory to the plugin search path with a plugin server executable
-find-usr Find USR for decls by given condition
-F <value> Add directory to framework search path
-generate-empty-baseline
Generate an empty baseline
-generate-migration-script
Compare SDK content in JSON file and generate migration script
-generate-name-correction
Generate name correction template
-help Display available options
-iframework <value> add a directory to the clang importer system framework search path
-ignore-spi-group <value>
SPI group name to not diagnose about
-ignored-usrs <path> the file containing USRs of removed decls that the digester should ignore
-input-paths <path> The SDK contents under comparison
-I <value> Add directory to the import search path
-json Print output in JSON format.
-location <location> Filter nodes with the given location.
-migrator Dump Json suitable for generating migration script
-module-cache-path <value>
Specifies the module cache path
-module-list-file <value>
File containing a new-line separated list of modules
-module <name> Names of modules
-output-dir <dir> Output directory
-o <file> Write output to <file>
-plugin-path <value> Add directory to the plugin search path
-print-module Print module names in diagnostics
-protocol-requirement-allow-list <path>
File containing a new-line separated list of protocol names
-resource-dir </usr/lib/swift>
The directory that holds the compiler resource files
-sdk <sdk> Compile against <sdk>
-serialize-diagnostics-path <path>
Emit a serialized diagnostics file to <path>
-swift-only Only include APIs defined from Swift source
-swift-version <vers> Interpret input according to a specific Swift language version number
-target <triple> Generate code for the given target <triple>, such as x86_64-apple-macos10.9
-use-interface-for-module <name>
Prefer loading these modules via interface
-visualc-tools-root <root>
VisualC++ Tools Root
-visualc-tools-version <version>
VisualC++ ToolSet Version
-v Show commands to run and use verbose output
-windows-sdk-root <root>
Windows SDK Root
-windows-sdk-version <version>
Windows SDK Version
Options (55)
| Option | Description | Source |
|---|---|---|
-abi | Dumping ABI interface | help |
-abort-on-module-fail | Abort if a module failed to load | help |
-avoid-location | Avoid serializing the file paths of SDK nodes. | help |
-avoid-tool-args | Avoid serializing the arguments for invoking the tool. | help |
-baseline-dir value | The path to a directory containing baseline files: macos.json, iphoneos.json, appletvos.json, watchos.json, and iosmac.json | help |
-BF value | add a directory to the baseline framework search path | help |
-BI value | add a module for baseline input | help |
-breakage-allowlist-path value | An allowlist of breakages to not complain about | help |
-bsdk value | path to the baseline SDK to import frameworks | help |
-clang-target value | Separately set the target we should use for internal Clang instance | help |
-compiler-style-diags | Print compiler style diagnostics to stderr. | help |
-debug-mapping | Dumping information for debug purposes | help |
-deserialize-diff | Deserialize diff items in a JSON file | help |
-deserialize-sdk | Deserialize sdk digester in a JSON file | help |
-diagnose-sdk | Diagnose SDK content in JSON file | help |
-disable-os-checks | Skip OS related diagnostics | help |
-disable-remove-deprecated-check | Skip diagnosing removal of deprecated symbols | help |
-dump-sdk | Dump SDK content to JSON file | help |
-empty-baseline | Use empty baseline for diagnostics | help |
-enable-remove-deprecated-check | Diagnosing removal of deprecated symbols | help |
-external-plugin-path path>#<plugin-server-path | Add directory to the plugin search path with a plugin server executable | help |
-find-usr | Find USR for decls by given condition | help |
-F value | Add directory to framework search path | help |
-generate-empty-baseline | Generate an empty baseline | help |
-generate-migration-script | Compare SDK content in JSON file and generate migration script | help |
-generate-name-correction | Generate name correction template | help |
-help | Display available options | help |
-iframework value | add a directory to the clang importer system framework search path | help |
-ignore-spi-group value | SPI group name to not diagnose about | help |
-ignored-usrs path | the file containing USRs of removed decls that the digester should ignore | help |
-input-paths path | The SDK contents under comparison | help |
-I value | Add directory to the import search path | help |
-json | Print output in JSON format. | help |
-location location | Filter nodes with the given location. | help |
-migrator | Dump Json suitable for generating migration script | help |
-module-cache-path value | Specifies the module cache path | help |
-module-list-file value | File containing a new-line separated list of modules | help |
-module name | Names of modules | help |
-output-dir dir | Output directory | help |
-o file | Write output to <file> | help |
-plugin-path value | Add directory to the plugin search path | help |
-print-module | Print module names in diagnostics | help |
-protocol-requirement-allow-list path | File containing a new-line separated list of protocol names | help |
-resource-dir /usr/lib/swift | The directory that holds the compiler resource files | help |
-sdk sdk | Compile against <sdk> | help |
-serialize-diagnostics-path path | Emit a serialized diagnostics file to <path> | help |
-swift-only | Only include APIs defined from Swift source | help |
-swift-version vers | Interpret input according to a specific Swift language version number | help |
-target triple | Generate code for the given target <triple>, such as x86_64-apple-macos10.9 | help |
-use-interface-for-module name | Prefer loading these modules via interface | help |
-visualc-tools-root root | VisualC++ Tools Root | help |
-visualc-tools-version version | VisualC++ ToolSet Version | help |
-v | Show commands to run and use verbose output | help |
-windows-sdk-root root | Windows SDK Root | help |
-windows-sdk-version version | Windows SDK Version | help |