Skip to content

Commit 6a680a7

Browse files
committed
Add note about optional O2 source
1 parent 6021f4e commit 6a680a7

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/gettingstarted/installing.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,25 +204,29 @@ See also [shell rc utilities](../tools/README.md#shell-rc-utilities).
204204

205205
We assume your work area is `~/alice`.
206206
Start with a clean shell where you are not in an `alienv` environment.
207-
Create the directory and move to it (all the following commands need to be executed in this directory):
207+
Create the directory and move to it. (All the following commands need to be executed in this directory.):
208208

209209
```bash
210210
mkdir -p ~/alice
211211
cd ~/alice
212212
```
213213

214-
Download O2 and O2Physics:
214+
Download O2Physics (and optionally O2):
215215

216216
```bash
217-
aliBuild init O2@dev
218217
aliBuild init O2Physics@master
218+
aliBuild init O2@dev # optional
219219
```
220220

221221
If you perform `ls` under your work directory, you will see the packages you have downloaded via
222222
`aliBuild init`, plus the `alidist` directory.
223223

224224
The `alidist` directory contains software recipes, telling aliBuild how the software is built.
225225

226+
```note
227+
You only need the O2 source code if you need to modify it. Otherwise aliBuild will install the O2 version defined in `alidist` as a dependency of O2Physics.
228+
```
229+
226230
```warning
227231
Your `alidist` directory and your software source code are Git repositories **managed by you**. You need to keep them up to date manually.
228232
```
@@ -301,7 +305,7 @@ dependency packages and downloaded `.tar.gz` archives.
301305
In general, it's good practice to run `aliBuild clean` always after `aliBuild build`.
302306

303307
This might not be enough, as aliBuild will not delete any build directory pointed to by a symlink
304-
that has "latest" in its name, even when that build is not needed by any other package anymore.
308+
that has "latest" in its name, even when that build is not needed by any other package any more.
305309
Manual intervention is therefore sometimes needed.
306310

307311
### Deep cleanup

0 commit comments

Comments
 (0)