Skip to content

Document all build flags #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bonachea merged 2 commits into from
Dec 8, 2025
Merged

Document all build flags #80

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
353ade0
README: Fix some links that don't render correctly on GitHub
bonachea Dec 5, 2025
d49b66a
README: Add a section documenting build flags
bonachea Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Use Cases
---------
Two common use cases include

1. [Supporting output in pure procedures] for debugging purposes.
2. [Enforcing programming contracts] throughout a project via runtime checks.
1. [Supporting output in pure procedures](#supporting-output-in-pure-procedures) for debugging purposes.
2. [Enforcing programming contracts](#enforcing-programming-contracts) throughout a project via runtime checks.

### Supporting output in pure procedures
Writing pure procedures communicates useful information to a compiler or a developer.
Expand Down Expand Up @@ -79,13 +79,31 @@ See the [./example](./example) subdirectory.
Building and Testing
--------------------

- [General Build Knobs](#general-build-knobs)
- [Cray Compiler Environment (CCE) `ftn`](#cray-compiler-environment-cce-ftn)
- [GNU Compiler Collection (GCC) `gfortran`](#gnu-compiler-collection-gcc-gfortran))
- [Intel `ifx`](#intel-ifx))
- [LFortran `lfortran`](#lfortran-lfortran)
- [LLVM `flang-new`](#llvm-flang-new)
- [Numerical Algorithms Group (NAG) `nagfor`](#numerical-algorithms-group-nag-nagfor)

### General Build Knobs

The following build-time preprocessor knobs can be used to control the behavior of Assert.
When using `fpm` to build, these boolean flags can be passed on the command-line
using syntax like: `fpm --flag "-DASSERTIONS=1"`

* `ASSERTIONS` : Controls the whether assertions are checked/enforced at runtime.
The default is 0 (assertions disabled). Assertions can be enabled using `-DASSERTIONS=1`.

* `ASSERT_MULTI_IMAGE`: Controls whether the library attempts to use multi-image
Fortran features (e.g. to report the image number of an assertion failure).
The default is compiler-specific. Multi-image support can be disabled using
`-DASSERT_MULTI_IMAGE=0`.

* `ASSERT_PARALLEL_CALLBACKS`: Controls the use of a callback interface for
multi-process features. Contact us for more details.

### Cray Compiler Environment (CCE) `ftn`
Because `fpm` uses the compiler name to determine the compiler identity and because
CCE provides one compiler wrapper, `ftn`, for invoking all compilers, you will
Expand Down