Blame doc/src/build_chain/fpga_api/api_build.md
|
Packit |
534379 |
Building OPAE SDK Artifacts
|
|
Packit |
534379 |
===========================
|
|
Packit |
534379 |
|
|
Packit |
534379 |
Steps
|
|
Packit |
534379 |
-----
|
|
Packit |
534379 |
|
|
Packit |
534379 |
1. Fetch the OPAE SDK source tree
|
|
Packit |
534379 |
2. Configure the OPAE SDK CMake project
|
|
Packit |
534379 |
3. Build OPAE SDK targets
|
|
Packit |
534379 |
|
|
Packit |
534379 |
The example below lists commands that can be used to fetch and build OPAE SDK.
|
|
Packit |
534379 |
|
|
Packit |
534379 |
``` {.bash}
|
|
Packit |
534379 |
# fetch the source
|
|
Packit |
534379 |
git clone https://github.com/OPAE/opae-sdk.git
|
|
Packit |
534379 |
cd opae-sdk
|
|
Packit |
534379 |
# configure CMake
|
|
Packit |
534379 |
cmake ..
|
|
Packit |
534379 |
# build
|
|
Packit |
534379 |
make
|
|
Packit |
534379 |
|
|
Packit |
534379 |
|
|
Packit |
534379 |
```
|
|
Packit |
534379 |
|
|
Packit |
534379 |
For a list of targets that can be built, type `make help` from the build
|
|
Packit |
534379 |
directory.
|
|
Packit |
534379 |
|
|
Packit |
534379 |
CMake options that may be set during the configuration include the following:
|
|
Packit |
534379 |
|
|
Packit |
534379 |
|
|
Packit |
534379 |
```
|
|
Packit |
534379 |
|----------------------------|-----------------------|-------------------------------------|---------------------------------------|----------------|
|
|
Packit |
534379 |
| cmake flag | Optional or Mandatory | Purpose | Valid values | Default value |
|
|
Packit |
534379 |
|----------------------------|-----------------------|-------------------------------------|---------------------------------------|----------------|
|
|
Packit |
534379 |
| -DCMAKE_BUILD_TYPE | Optional | Set compiler flags | Debug/Release/Coverage/RelWithDebInfo | RelWithDebInfo |
|
|
Packit |
534379 |
| -DOPAE_BUILD_LEGACY | Optional | Enable/disable opae-legacy.git | ON/OFF | OFF |
|
|
Packit |
534379 |
| -DOPAE_BUILD_SPHINX_DOC | Optional | Enable/disable documentation build | ON/OFF | OFF |
|
|
Packit |
534379 |
| -DOPAE_BUILD_TESTS | Optional | Enable/disable building unit tests | ON/OFF | OFF |
|
|
Packit |
534379 |
| -DOPAE_INSTALL_RPATH | Optional | Enable/disable rpath for install | ON/OFF | OFF |
|
|
Packit |
534379 |
| -DOPAE_BUILD_LIBOPAE_CXX | Optional | Enable/disable OPAE C++ bindings | ON/OFF | ON |
|
|
Packit |
534379 |
| -DOPAE_BUILD_LIBOPAE_PY | Optional | Enable/disable OPAE Python bindings | ON/OFF | ON |
|
|
Packit |
534379 |
| -DOPAE_BUILD_PYTHON_DIST | Optional | Enable/disable Python Distribution | ON/OFF | OFF |
|
|
Packit |
534379 |
| -DOPAE_ENABLE_MOCK | Optional | Enable/disable mocks for unit tests | ON/OFF | OFF |
|
|
Packit |
534379 |
| -DOPAE_BUILD_SIM | Optional | Enable/disable opae-sim.git | ON/OFF | OFF |
|
|
Packit |
534379 |
|
|
Packit |
534379 |
```
|
|
Packit |
534379 |
|
|
Packit |
534379 |
|