Skip to content

Commit 0f6ccb4

Browse files
Pierre-FrançoisPierre-François
Pierre-François
authored and
Pierre-François
committed
[Docs] Documentation changes to reflect the new nxcShell nxcShellLite naming scheme.
Basically, nxcShell -> nxcShellLite and nxcShellFull -> nxcShell. All instances were changed, as they all seemed to predate the naming convention change.
1 parent 9b099dd commit 0f6ccb4

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

docs/src/install/grid5000.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,5 @@ As seen in the local installation it is preferable to use the same `nxc` version
7272

7373
```shell
7474
./nix-user-chroot.sh #activate Nix
75-
nix develop .#nxcShell
75+
nix develop .#nxcShellLite
7676
```

docs/src/install/local.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ The following commands will drop you in a shell where the `nxc` command is avail
4444
```shell
4545
git clone https://gitlab.inria.fr/nixos-compose/nixos-compose.git
4646
cd nixos-compose
47-
nix develop .#nxcShellFull
47+
nix develop .#nxcShell
4848
```
4949
## Alternative
5050

5151
You can take advantage of the full potential of Nix's flakes. The following command will drop you in the same shell without having to clone the repository.
5252
```shell
53-
nix develop https://gitlab.inria.fr/nixos-compose/nixos-compose.git#nxcShellFull
53+
nix develop https://gitlab.inria.fr/nixos-compose/nixos-compose.git#nxcShell
5454
```
5555

5656
~~~admonish tip
@@ -60,7 +60,7 @@ nix registry add nxc git+https://gitlab.inria.fr/nixos-compose/nixos-compose.git
6060
```
6161
The command becomes :
6262
```shell
63-
nix develop nxc#nxcShellFull
63+
nix develop nxc#nxcShell
6464
```
6565
~~~
6666

@@ -69,21 +69,21 @@ nix develop nxc#nxcShellFull
6969
A project that is already using _NixOSCompose_ in its experiments process provides an easy access to a shell that gives access to the `nxc` tool and its runtime dependencies if needed. This is achieved thanks to Nix and its flakes feature. By default, a project has a line in its `flake.nix` similar to this :
7070

7171
```nix
72-
devShell.${system} = nxc.devShells.${system}.nxcShellFull;
72+
devShell.${system} = nxc.devShells.${system}.nxcShell;
7373
```
7474

7575
It exposes the shell of _NixOSCompose_ as in the previous section but with the specific revision thanks to the `flake.lock` file. The shell is accessible with the command `nix develop`. It is useful to explore what shells are available in the project, to list them you use `nix flake show`. Then to access the devShell of your choice use this command :
7676

7777
```shell
78-
nix develop .#nxcShellFull
78+
nix develop .#nxcShell
7979
```
8080

8181
```admonish info
8282
Two shells availables :
83-
- `nxcShell`
83+
- `nxcShellLite`
8484
- python app `nxc`
8585
86-
- `nxcShellFull`
86+
- `nxcShell`
8787
- python app `nxc`
8888
- docker-compose
8989
- vde2

docs/src/quick-start.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For the following, we are using the `basic` template. It is a composition that d
4040
Using your locally installed _NixOSCompose_ the commands are the following.
4141
```shell
4242
cd nixos-compose
43-
nix develop .#nxcShell
43+
nix develop .#nxcShellLite
4444
cd path/to/projectFolder
4545
nxc init -t basic
4646
```
@@ -97,11 +97,11 @@ testScript = ''
9797

9898
## Local development and usage
9999

100-
First enter the `nxc` shell. Here we choose `nxcShellFull` because it provides all necessary dependencies to run the composition locally (e.g. docker-compose).
100+
First enter the `nxc` shell. Here we choose `nxcShell` because it provides all necessary dependencies to run the composition locally (e.g. docker-compose).
101101

102102
```shell
103103
cd path/to/projectFolder
104-
nix develop .#nxcShellFull
104+
nix develop .#nxcShell
105105
```
106106

107107
```admonest info
@@ -180,7 +180,7 @@ This phase requires the reservation of a node in interactive mode with `oarsub -
180180
Enter the `nix-shell` that provides the `nxc` command.
181181
```shell
182182
cd path/to/project
183-
nix develop .#nxcShell
183+
nix develop .#nxcShellLite
184184
```
185185

186186
You can now to build the `g5k-ramdisk` flavour.

docs/src/slow-start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ webserver/
7575
defaultPackage.${system} =
7676
self.packages.${system}."composition::vm";
7777
78-
devShell.${system} = nxc.devShells.${system}.nxcShell;
78+
devShell.${system} = nxc.devShells.${system}.nxcShellLite;
7979
};
8080
}
8181
```

0 commit comments

Comments
 (0)