Compiler Flags - odin-lang/Odin GitHub Wiki
Running the odin executable without any arguments (or faulty input) will print the following help description:
odin is a tool for managing Odin source code.
Usage:
odin command [arguments]
Commands:
build Compiles directory of .odin files, as an executable.
One must contain the program's entry point, all must be in the same package.
run Same as 'build', but also then runs the newly compiled executable.
bundle Bundles a directory in a specific layout for that platform.
check Parses and type checks a directory of .odin files.
strip-semicolon Parses, type checks, and removes unneeded semicolons from the entire program.
test Builds and runs procedures with the attribute @(test) in the initial package.
doc Generates documentation from a directory of .odin files.
version Prints version.
report Prints information useful to reporting a bug.
root Prints the root path where Odin looks for the builtin collections.
For further details on a command, invoke command help:
e.g. `odin build -help` or `odin help build`
For further details on a command, invoke command help:
e.g. `odin build -help` or `odin help build`
Most flags are of the form -foo:BAR.
Invoking odin build -help will print the following help descriptions and flags:
odin is a tool for managing Odin source code.
Usage:
odin build [arguments]
build Compiles directory of .odin files as an executable.
One must contain the program's entry point, all must be in the same package.
Use `-file` to build a single file instead.
Examples:
odin build . Builds package in current directory.
odin build <dir> Builds package in <dir>.
odin build filename.odin -file Builds single-file package, must contain entry point.
Flags
-build-mode:<mode>
Sets the build mode.
Available options:
-build-mode:exe Builds as an executable.
-build-mode:test Builds as an executable that executes tests.
-build-mode:dll Builds as a dynamically linked library.
-build-mode:shared Builds as a dynamically linked library.
-build-mode:dynamic Builds as a dynamically linked library.
-build-mode:lib Builds as a statically linked library.
-build-mode:static Builds as a statically linked library.
-build-mode:obj Builds as an object file.
-build-mode:object Builds as an object file.
-build-mode:assembly Builds as an assembly file.
-build-mode:assembler Builds as an assembly file.
-build-mode:asm Builds as an assembly file.
-build-mode:llvm-ir Builds as an LLVM IR file.
-build-mode:llvm Builds as an LLVM IR file.
-collection:<name>=<filepath>
Defines a library collection used for imports.
Example: -collection:shared=dir/to/shared
Usage in Code:
import "shared:foo"
-custom-attribute:<string>
Add a custom attribute which will be ignored if it is unknown.
This can be used with metaprogramming tools.
Examples:
-custom-attribute:my_tag
-custom-attribute:my_tag,the_other_thing
-custom-attribute:my_tag -custom-attribute:the_other_thing
-debug
Enables debug information, and defines the global constant ODIN_DEBUG to be 'true'.
-default-to-nil-allocator
Sets the default allocator to be the nil_allocator, an allocator which does nothing.
-default-to-panic-allocator
Sets the default allocator to be the panic_allocator, an allocator which calls panic() on any allocation attempt.
-define:<name>=<value>
Defines a scalar boolean, integer or string as global constant.
Example: -define:SPAM=123
Usage in code:
#config(SPAM, default_value)
-disable-assert
Disables the code generation of the built-in run-time 'assert' procedure, and defines the global constant ODIN_DISABLE_ASSERT to be 'true'.
-disable-red-zone
Disables red zone on a supported freestanding target.
-disallow-do
Disallows the 'do' keyword in the project.
-dynamic-map-calls
Uses dynamic map calls to minimize code generation at the cost of runtime execution.
-error-pos-style:<string>
Available options:
-error-pos-style:unix file/path:45:3:
-error-pos-style:odin file/path(45:3)
-error-pos-style:default (Defaults to 'odin'.)
-export-defineables:<filename>
Exports an overview of all the #config/#defined usages in CSV format to the given file path.
Example: -export-defineables:defineables.csv
-export-dependencies:<format>
Exports dependencies to one of a few formats. Requires `-export-dependencies-file`.
Available options:
-export-dependencies:make Exports in Makefile format
-export-dependencies:json Exports in JSON format
-export-dependencies-file:<filename>
Specifies the filename for `-export-dependencies`.
Example: -export-dependencies-file:dependencies.d
-export-timings:<format>
Exports timings to one of a few formats. Requires `-show-timings` or `-show-more-timings`.
Available options:
-export-timings:json Exports compile time stats to JSON.
-export-timings:csv Exports compile time stats to CSV.
-export-timings-file:<filename>
Specifies the filename for `-export-timings`.
Example: -export-timings-file:timings.json
-extra-assembler-flags:<string>
Adds extra assembler specific flags in a string.
-extra-linker-flags:<string>
Adds extra linker specific flags in a string.
-file
Tells `C:\Users\FColor04\scoop\apps\odin\current\odin.exe build` to treat the given file as a self-contained package.
This means that `<dir>/a.odin` won't have access to `<dir>/b.odin`'s contents.
-foreign-error-procedures
States that the error procedures used in the runtime are defined in a separate translation unit.
-ignore-unknown-attributes
Ignores unknown attributes.
This can be used with metaprogramming tools.
-ignore-vs-search
[Windows only]
Ignores the Visual Studio search for library paths.
-ignore-warnings
Ignores warning messages.
-json-errors
Prints the error messages as json to stderr.
-keep-temp-files
Keeps the temporary files generated during compilation.
-keep-executable
Keep the executable generated by `odin test` or `odin run` after running it. We clean it up by default.
If you build your program or test using `odin build`, the compiler does not automatically execute
the resulting program, and this option is not applicable.
-linker:<string>
Specify the linker to use.
Choices:
default
lld
radlink
-lld
Uses the LLD linker rather than the default.
-max-error-count:<integer>
Sets the maximum number of errors that can be displayed before the compiler terminates.
Must be an integer >0.
If not set, the default max error count is 36.
-microarch:<string>
Specifies the specific micro-architecture for the build in a string.
Examples:
-microarch:sandybridge
-microarch:native
-microarch:"?" for a list
-min-link-libs
If set, the number of linked libraries will be minimized to prevent duplications.
This is useful for so called "dumb" linkers compared to "smart" linkers.
-minimum-os-version:<string>
Sets the minimum OS version targeted by the application.
Default: -minimum-os-version:11.0.0
Only used when target is Darwin or subtarget is Android, if given, linking mismatched versions will emit a warning.
-no-bounds-check
Disables bounds checking program wide.
-no-crt
Disables automatic linking with the C Run Time.
-no-entry-point
Removes default requirement of an entry point (e.g. main procedure).
-no-rpath
Disables automatic addition of an rpath linked to the executable directory.
-no-thread-local
Ignores @thread_local attribute, effectively treating the program as if it is single-threaded.
-no-threaded-checker
Disables multithreading in the semantic checker stage.
-no-type-assert
Disables type assertion checking program wide.
-o:<string>
Sets the optimization mode for compilation.
Available options:
-o:none
-o:minimal
-o:size
-o:speed
-o:aggressive (use this with caution)
The default is -o:minimal.
-source-code-locations:<string>
Processes the file and procedure strings, and line and column numbers, stored with a 'runtime.Source_Code_Location' value.
Available options:
-source-code-locations:normal
-source-code-locations:obfuscated
-source-code-locations:filename
-source-code-locations:none
The default is -source-code-locations:normal.
-out:<filepath>
Sets the file name of the outputted executable.
Example: -out:foo.exe
-pdb-name:<filepath>
[Windows only]
Defines the generated PDB name when -debug is enabled.
Example: -pdb-name:different.pdb
-print-linker-flags
Prints the all of the flags/arguments that will be passed to the linker.
-radlink
Uses the RAD linker rather than the default.
-reloc-mode:<string>
Specifies the reloc mode.
Available options:
-reloc-mode:default
-reloc-mode:static
-reloc-mode:pic
-reloc-mode:dynamic-no-pic
-resource:<filepath>
[Windows only]
Defines the resource file for the executable.
Example: -resource:path/to/file.rc
or: -resource:path/to/file.res for a precompiled one.
-sanitize:<string>
Enables sanitization analysis.
Available options:
-sanitize:address
-sanitize:memory
-sanitize:thread
-show-defineables
Shows an overview of all the #config/#defined usages in the project.
-show-system-calls
Prints the whole command and arguments for calls to external tools like linker and assembler.
-show-timings
Shows basic overview of the timings of different stages within the compiler in milliseconds.
-show-more-timings
Shows an advanced overview of the timings of different stages within the compiler in milliseconds.
-strict-style
This enforces parts of same style as the Odin compiler, prefer '-vet-style -vet-semicolon' if you do not want to match it exactly.
Errs on unneeded tokens, such as unneeded semicolons.
Errs on missing trailing commas followed by a newline.
Errs on deprecated syntax.
Errs when the attached-brace style in not adhered to (also known as 1TBS).
Errs when 'case' labels are not in the same column as the associated 'switch' token.
-strict-target-features
Makes @(enable_target_features="...") behave the same way as @(require_target_features="...").
This enforces that all generated code uses features supported by the combination of -target, -microarch, and -target-features.
-subsystem:<option>
[Windows only]
Defines the subsystem for the application.
Available options:
-subsystem:console
-subsystem:windows
-subtarget:<subtarget>
[Darwin and Linux only]
Available subtargets:
-subtarget:ios
-subtarget:android
-target-features:<string>
Specifies CPU features to enable on top of the enabled features implied by -microarch.
Examples:
-target-features:atomics
-target-features:"sse2,aes"
-target-features:"?" for a list
-target:<string>
Sets the target for the executable to be built in.
-terse-errors
Prints a terse error message without showing the code on that line and the location in that line.
-thread-count:<integer>
Overrides the number of threads the compiler will use to compile with.
Example: -thread-count:2
-use-separate-modules
The backend generates multiple build units which are then linked together.
This is the default behaviour for '-o:none' and '-o:minimal' builds.
Normally, a single build unit is generated for a standard project for '-o:speed' or '-o:size'.
-use-single-module
The backend generates only a single build unit.
This is the default behaviour for '-o:speed' or '-o:size'.
-vet
Does extra checks on the code.
Extra checks include:
-vet-unused
-vet-unused-variables
-vet-unused-imports
-vet-shadowing
-vet-using-stmt
-vet-cast
Errs on casting a value to its own type or using `transmute` rather than `cast`.
-vet-packages:<comma-separated-strings>
Sets which packages by name will be vetted.
Files with specific +vet tags will not be ignored if they are not in the packages set.
-vet-semicolon
Errs on unneeded semicolons.
-vet-shadowing
Checks for variable shadowing within procedures.
-vet-style
Errs on missing trailing commas followed by a newline.
Errs on deprecated syntax.
Does not err on unneeded tokens (unlike -strict-style).
-vet-tabs
Errs when the use of tabs has not been used for indentation.
-vet-unused
Checks for unused declarations (variables and imports).
-vet-unused-imports
Checks for unused import declarations.
-vet-unused-procedures
Checks for unused procedures.
Must be used with -vet-packages or specified on a per file with +vet tags.
-vet-unused-variables
Checks for unused variable declarations.
-vet-using-param
Checks for the use of 'using' on procedure parameters.
'using' is considered bad practice outside of immediate refactoring.
-vet-using-stmt
Checks for the use of 'using' as a statement.
'using' is considered bad practice outside of immediate refactoring.
-warnings-as-errors
Treats warning messages as error messages.