Add a note about MUROOT in the dependency probe sequence

We will use the $MUROOT envvar to determine where Mu has been installed,
which will by default be /usr/local/mu.  From there, we can access the
predefined library of stacks (underneath $MUROOT/bin/stacks).
This commit is contained in:
joeduffy 2016-11-21 08:39:28 -08:00
parent 58fa832b98
commit 62d1f5c4c1
2 changed files with 4 additions and 0 deletions

View file

@ -104,6 +104,8 @@ For convenience, there is also a global Workspace, under `~/.mu/`, whose structu
shared by all other Workspaces on the machine. There are additional hidden directories, however, like `~/.mu/.cache/`,
that the toolchain uses throughout the course of its business to do things like package caching.
Please refer to [this doc](deps.md) for more information about how dependencies are dealt with and resolved.
### Deployments
TODO(joe): discuss the concept of a deployment.

View file

@ -37,12 +37,14 @@ Roughly speaking, these locations are are searched, in order:
1. The current Workspace, for intra-Workspace but inter-Stack dependencies.
2. The current Workspace's `.mu/stacks/` directory.
3. The global Workspace's `.mu/stacks/` directory.
4. The Mu installation location's `$MUROOT/bin/stacks/` directory (default `/usr/local/mu`).
To be more precise, given a StackRef `r` and a workspace root `w`, we look in these locations:
1. `w/name(r)`
2. `w/.mu/stacks/base(r)/name(r)`
3. `~/.mu/stacks/base(r)/name(r)`
4. `$MUROOT/bin/stacks/base(r)/name(r)`
To illustrate this process, let us imagine we are looking up `https://hub.mu.com/aws/s3/bucket`.