Skip to content

Commit 056dfb0

Browse files
authored
Update lux-package-conflicts.md
1 parent 0971cec commit 056dfb0

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/explanations/lux-package-conflicts.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,20 @@ First, let's quickly break down what problems we're trying to solve as a package
1212
a rock (the name for a package in Lua land), unpack it, put the Lua files in the correct place and ensure all dependencies are installed. As will be evident soon,
1313
managing these dependencies is not an easy feat.
1414

15-
In Lux, packages are installed in something called a rock tree. This tree contains a lockfile, which describes which packages
16-
are installed and how they all relate with one another. The tree also contains a `lux/` directory - it's here that all Lua files are unpacked so that they can be used in
17-
your scripts. There are three types of rock trees - those that are created for each Lua project (which hold local packages like
15+
In Lux, packages are installed in something called a rock tree. This tree contains a lockfile, which describes which packages (rocks)
16+
are installed and how they all relate with one another. There are three types of rock trees - those that are created for each Lua project (which hold local packages like
1817
dependencies for a given project), those that are installed for the current user (for things like local binaries or helper packages)
1918
and those that are system-wide.
2019

2120
A rock tree is structured as follows:
22-
- `/lux/<lua-version>` - contains lux for a given Lua version
23-
- `/lux/<lua-version>/<rock>/etc` - documentation and supplementary files for the rock
24-
- `/lux/<lua-version>/<rock>/lib` - shared libraries (.so files)
25-
- `/lux/<lua-version>/<rock>/src` - actual code of the rock
26-
- `/bin` - binary files produced by various packages
21+
- `tree/<lua-version>` - contains rocks for a given Lua version
22+
- `tree/<lua-version>/<rock>/etc` - documentation and supplementary files for the rock
23+
- `tree/<lua-version>/<rock>/lib` - shared libraries (.so files)
24+
- `tree/<lua-version>/<rock>/src` - actual code of the rock
25+
- `tree/<lua-version>/bin` - binary files produced by various packages
2726

2827
`<lua-version>` can be any of `5.1`, `5.2`, `5.3`, `5.4` - simple! Here's a question that might throw you for a loop - what
29-
should `<rock>` be? Should it just be the name and version of the rock: `/lux/5.1/[email protected]/...`? As we're
28+
should `<rock>` be? Should it just be the name and version of the rock: `tree/5.1/[email protected]/...`? As we're
3029
about to find out, it's much, *much* more complicated.
3130

3231
Let's consider the following case: `rock1` is already installed in the user-wide rock tree. `rock1` relies on a hypothetical rock called

0 commit comments

Comments
 (0)