Skip to content

Commit 39b3804

Browse files
authored
📚 Build-uenv: consistently use <build-path> (#268)
The documentation section was using both `<build-path>` and `<build-dir>`. This makes it unclear that they are both referring to the same string. Here we choose to consistently use `<build-path>`, since it is a path to a directory.
1 parent cf47e98 commit 39b3804

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

‎docs/build-install/uenv.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ you can provide it as an argument to `uenv-spack`:
198198

199199
### Build the software
200200

201-
Once specs have been added to `spack.yaml`, you can build the image using the `build` script that was generated in `<build-dir>`:
201+
Once specs have been added to `spack.yaml`, you can build the image using the `build` script that was generated in `<build-path>`:
202202

203203
```bash
204204
./build
@@ -216,11 +216,11 @@ The build step generates multiple outputs, described below.
216216

217217
### Installed packages
218218

219-
The packages built by Spack are installed in `<build-dir>/store`.
219+
The packages built by Spack are installed in `<build-path>/store`.
220220

221221
### Spack view
222222

223-
A Spack view is generated in `<build-dir>/view`.
223+
A Spack view is generated in `<build-path>/view`.
224224

225225
### Modules
226226

@@ -229,15 +229,15 @@ Module files are generated in the `module` sub-directory of the `<build-path>`
229229
To use them, add them to the module environment
230230

231231
```bash
232-
module use <build-dir>/modules # (1)!
232+
module use <build-path>/modules # (1)!
233233
module avail # (2)!
234234
```
235235

236236
1. Make modules available.
237237
2. Check that the modules are available.
238238

239239
!!! note
240-
The generation of modules can be customised by editing the `<build-dir>/config/user/modules.yaml` file _before_ running `build`.
240+
The generation of modules can be customised by editing the `<build-path>/config/user/modules.yaml` file _before_ running `build`.
241241
See the [Spack modules] documentation.
242242

243243
### Use the software
@@ -254,7 +254,7 @@ To use the installed software, you have the following options:
254254

255255
* Loading modules
256256
* Activate the Spack view
257-
* `source <build-dir>/spack/share/spack/setup-env.sh` and then use Spack
257+
* `source <build-path>/spack/share/spack/setup-env.sh` and then use Spack
258258

259259
[Chaining Spack Installations]: https://spack.readthedocs.io/en/latest/chain.html
260260
[Spack]: https://spack.readthedocs.io/en/latest/

0 commit comments

Comments
 (0)