Skip to content

Commit

Permalink
doc: write it better
Browse files Browse the repository at this point in the history
  • Loading branch information
c-dilks committed Jan 16, 2024
1 parent e9548ff commit 250e322
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions doc/dependency_resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,9 @@ Any variable defined in `hipo4.pc` is accessible with `pkg-config --variable <va

## Resolving Runtime Dependencies

TODO: change these notes into documentation

- prefer `rpath`s over `$LD_LIBRARY_PATH` or `$DYLD_LIBRARY_PATH` (or other
environment variables), since they are globally mutable
- both `rpaths` and environment variables are OS-dependent
- while `rpaths` are typical in build files, they are usually stripped at
installation, otherwise dependencies cannot be relocated (easily)
- containerization with one installation prefix removes the need of both
`rpath`s and `ld` environment vars since dependency files will all be findable in the
default, assumed places
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).

0 comments on commit 250e322

Please sign in to comment.