Skip to content
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

doc: runtime dependency resolution #78

Merged
merged 4 commits into from
Jan 16, 2024
Merged

doc: runtime dependency resolution #78

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2de81b
doc: runtime dependency resolution
c-dilks Jan 13, 2024
e9548ff
doc: typo
c-dilks Jan 16, 2024
250e322
doc: write it better
c-dilks Jan 16, 2024
56bad7b
fix: link
c-dilks Jan 16, 2024
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
24 changes: 21 additions & 3 deletions doc/dependency_resolution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,20 @@ Assuming a dependency is installed in `$prefix`, it uses one or more of the foll
Take a look at each dependency's installation prefix to see which of these options
are available.

## Resolving Build Dependencies

To use these dependencies with your software, they must be findable by its build system.
The following sections explain how to do so with each.

### Meson
### :large_blue_diamond: Meson
For `iguana`, the build system is `meson`, which accepts the build options
```bash
-Dpkg_config_path=$prefix/lib/pkgconfig
-Dcmake_prefix_path=$prefix
```
(where multiple paths are delimited by commas).

### CMake
### :large_blue_diamond: CMake
For `cmake`, the `pkg-config` path can be combined with the `cmake` path, so only the
build option
```bash
Expand All @@ -31,10 +33,26 @@ is needed; this assumes:
- all dependencies are in `$prefix` (delimit multiple paths with semicolons)
- `PKG_CONFIG_USE_CMAKE_PREFIX_PATH` has not been disabled.

### General Case
### :large_blue_diamond: General Case
Environment variables may be used instead of build options for a general approach:
```bash
export PKG_CONFIG_PATH=$prefix/lib/pkgconfig
export CMAKE_PREFIX_PATH=$prefix
```
(where multiple paths are delimited by colons).

`pkg-config` files (`.pc`) allow for usage of the `pkg-config` command. Assuming the package is `hipo4` and `hipo4.pc` is found in `PKG_CONFIG_PATH`, compiler flags may be found by
```bash
pkg-config --libs hipo4
pkg-config --cflags hipo4
```
Any variable defined in `hipo4.pc` is accessible with `pkg-config --variable <variable>`.

## Resolving Runtime Dependencies

Depending on how the software was built, dependencies may also need to be findable at runtime. In `iguana`, we try to avoid this by
setting [rpath variables](https://en.wikipedia.org/wiki/Rpath); this is preferred to avoid the usage of environment variables
such as `LD_LIBRARY_PATH` or `DYLD_LIBRARY_PATH`, since they are globally mutable.

However, depending on your local setup and the current state of your environment variables, you may need to set some variables
such that `iguana` is prioritized. See [the Environment Variables section in the setup guide for more details](setup.md#env).