doc: add usage for `cataclysmDDA.attachPkgs`
This commit is contained in:
parent
0c02a5599c
commit
cdfbdb0b2c
|
@ -34,6 +34,41 @@ cataclysm-dda.override {
|
|||
}
|
||||
```
|
||||
|
||||
## Important note for overriding packages
|
||||
|
||||
After applying `overrideAttrs`, you need to fix `passthru.pkgs` and
|
||||
`passthru.withMods` attributes either manually or by using `attachPkgs`:
|
||||
|
||||
```nix
|
||||
let
|
||||
# You enabled parallel building.
|
||||
myCDDA = cataclysm-dda-git.overrideAttrs (_: {
|
||||
enableParallelBuilding = true;
|
||||
});
|
||||
|
||||
# Unfortunately, this refers to the package before overriding and
|
||||
# parallel building is still disabled.
|
||||
badExample = myCDDA.withMods (_: []);
|
||||
|
||||
inherit (cataclysmDDA) attachPkgs pkgs wrapCDDA;
|
||||
|
||||
# You can fix it by hand
|
||||
goodExample1 = myCDDA.overrideAttrs (old: {
|
||||
passthru = old.passthru // {
|
||||
pkgs = pkgs.override { build = goodExample1; };
|
||||
withMods = wrapCDDA goodExample1;
|
||||
};
|
||||
});
|
||||
|
||||
# or by using a helper function `attachPkgs`.
|
||||
goodExample2 = attachPkgs pkgs myCDDA;
|
||||
in
|
||||
|
||||
# badExample # parallel building disabled
|
||||
# goodExample1.withMods (_: []) # parallel building enabled
|
||||
goodExample2.withMods (_: []) # parallel building enabled
|
||||
```
|
||||
|
||||
## Customizing with mods
|
||||
|
||||
To install Cataclysm DDA with mods of your choice, you can use `withMods`
|
||||
|
|
Loading…
Reference in New Issue