commit 403e25e3e31319146c3e6ab478485a9c33efa07f · pyrox.dev/nixpkgs

+1 -1

doc/contributing/reviewing-contributions.chapter.md

···

       185
        
       ##### Comments

     

       186
        
       ```

     

       187
        
       

     

       188
       -
       ## Individual maintainer list {#reviewing-contributions-indvidual-maintainer-list}

     

       189
        
       

     

       190
        
       When adding users to `maintainers/maintainer-list.nix`, the following

     

       191
        
       checks should be performed:

···

       185
        
       ##### Comments

     

       186
        
       ```

     

       187
        
       

     

       188
       +
       ## Individual maintainer list {#reviewing-contributions-individual-maintainer-list}

     

       189
        
       

     

       190
        
       When adding users to `maintainers/maintainer-list.nix`, the following

     

       191
        
       checks should be performed:

+1 -1

doc/doc-support/lib-function-docs.nix

···

       1
       -
       # Generates the documentation for library functons via nixdoc. To add

     

       2
        
       # another library function file to this list, the include list in the

     

       3
        
       # file `doc/functions/library.xml` must also be updated.

     

       4

···

       1
       +
       # Generates the documentation for library functions via nixdoc. To add

     

       2
        
       # another library function file to this list, the include list in the

     

       3
        
       # file `doc/functions/library.xml` must also be updated.

     

       4

+1 -1

doc/languages-frameworks/beam.section.md

···

       93
        
       - run `mix2nix > mix_deps.nix` in the upstream repo.

     

       94
        
       - pass `mixNixDeps = with pkgs; import ./mix_deps.nix { inherit lib beamPackages; };` as an argument to mixRelease.

     

       95
        
       

     

       96
       -
       If there are git depencencies.

     

       97
        
       

     

       98
        
       - You'll need to fix the version artificially in mix.exs and regenerate the mix.lock with fixed version (on upstream). This will enable you to run `mix2nix > mix_deps.nix`.

     

       99
        
       - From the mix_deps.nix file, remove the dependencies that had git versions and pass them as an override to the import function.

···

       93
        
       - run `mix2nix > mix_deps.nix` in the upstream repo.

     

       94
        
       - pass `mixNixDeps = with pkgs; import ./mix_deps.nix { inherit lib beamPackages; };` as an argument to mixRelease.

     

       95
        
       

     

       96
       +
       If there are git dependencies.

     

       97
        
       

     

       98
        
       - You'll need to fix the version artificially in mix.exs and regenerate the mix.lock with fixed version (on upstream). This will enable you to run `mix2nix > mix_deps.nix`.

     

       99
        
       - From the mix_deps.nix file, remove the dependencies that had git versions and pass them as an override to the import function.

+1 -1

doc/languages-frameworks/coq.section.md

···

       8
        
       * `customOCamlPackages` (optional, defaults to `null`, which lets Coq choose a version automatically), which can be set to any of the ocaml packages attribute of `ocaml-ng` (such as `ocaml-ng.ocamlPackages_4_10` which is the default for Coq 8.11 for example).

     

       9
        
       * `coq-version` (optional, defaults to the short version e.g. "8.10"), is a version number of the form "x.y" that indicates which Coq's version build behavior to mimic when using a source which is not a release. E.g. `coq.override { version = "d370a9d1328a4e1cdb9d02ee032f605a9d94ec7a"; coq-version = "8.10"; }`.

     

       10
        
       

     

       11
       -
       The associated package set can be optained using `mkCoqPackages coq`, where `coq` is the derivation to use.

     

       12
        
       

     

       13
        
       ## Coq packages attribute sets: `coqPackages` {#coq-packages-attribute-sets-coqpackages}

     

       14

···

       8
        
       * `customOCamlPackages` (optional, defaults to `null`, which lets Coq choose a version automatically), which can be set to any of the ocaml packages attribute of `ocaml-ng` (such as `ocaml-ng.ocamlPackages_4_10` which is the default for Coq 8.11 for example).

     

       9
        
       * `coq-version` (optional, defaults to the short version e.g. "8.10"), is a version number of the form "x.y" that indicates which Coq's version build behavior to mimic when using a source which is not a release. E.g. `coq.override { version = "d370a9d1328a4e1cdb9d02ee032f605a9d94ec7a"; coq-version = "8.10"; }`.

     

       10
        
       

     

       11
       +
       The associated package set can be obtained using `mkCoqPackages coq`, where `coq` is the derivation to use.

     

       12
        
       

     

       13
        
       ## Coq packages attribute sets: `coqPackages` {#coq-packages-attribute-sets-coqpackages}

     

       14

+1 -1

doc/languages-frameworks/cuda.section.md

···

       38
        
       

     

       39
        
       Nixpkgs tries to target support real architecture defaults based on the

     

       40
        
       CUDA toolkit version with PTX support for future hardware.  Experienced

     

       41
       -
       users may optmize this configuration for a variety of reasons such as

     

       42
        
       reducing binary size and compile time, supporting legacy hardware, or

     

       43
        
       optimizing for specific hardware.

     

       44

···

       38
        
       

     

       39
        
       Nixpkgs tries to target support real architecture defaults based on the

     

       40
        
       CUDA toolkit version with PTX support for future hardware.  Experienced

     

       41
       +
       users may optimize this configuration for a variety of reasons such as

     

       42
        
       reducing binary size and compile time, supporting legacy hardware, or

     

       43
        
       optimizing for specific hardware.

     

       44

+2 -2

doc/languages-frameworks/cuelang.section.md

···

       37
        
       ```

     

       38
        
       

     

       39
        
       - The first parameter is the Cue schema file.

     

       40
       -
       - The second paramter is an options parameter, currently, only: `document` can be passed.

     

       41
        
       

     

       42
       -
       `document` : match your input data against this fragment of structure or definition, e.g. you may use the same schema file but differents documents based on the data you are validating.

     

       43
        
       

     

       44
        
       Another example, given the following `validator.nix` :

     

       45
        
       ```

···

       37
        
       ```

     

       38
        
       

     

       39
        
       - The first parameter is the Cue schema file.

     

       40
       +
       - The second parameter is an options parameter, currently, only: `document` can be passed.

     

       41
        
       

     

       42
       +
       `document` : match your input data against this fragment of structure or definition, e.g. you may use the same schema file but different documents based on the data you are validating.

     

       43
        
       

     

       44
        
       Another example, given the following `validator.nix` :

     

       45
        
       ```

+2 -2

doc/languages-frameworks/hy.section.md

···

       4
        
       

     

       5
        
       ### Installation without packages {#installation-without-packages}

     

       6
        
       

     

       7
       -
       You can install `hy` via nix-env or by adding it to `configuration.nix` by reffering to it as a `hy` attribute. This kind of installation adds `hy` to your environment and it succesfully works with `python3`.

     

       8
        
       

     

       9
        
       ::: {.caution}

     

       10
       -
       Packages that are installed with your python derivation, are not accesible by `hy` this way.

     

       11
        
       :::

     

       12
        
       

     

       13
        
       ### Installation with packages {#installation-with-packages}

···

       4
        
       

     

       5
        
       ### Installation without packages {#installation-without-packages}

     

       6
        
       

     

       7
       +
       You can install `hy` via nix-env or by adding it to `configuration.nix` by referring to it as a `hy` attribute. This kind of installation adds `hy` to your environment and it successfully works with `python3`.

     

       8
        
       

     

       9
        
       ::: {.caution}

     

       10
       +
       Packages that are installed with your python derivation, are not accessible by `hy` this way.

     

       11
        
       :::

     

       12
        
       

     

       13
        
       ### Installation with packages {#installation-with-packages}

+1 -1

doc/languages-frameworks/index.xml

···

       3
        
                xml:id="chap-language-support">

     

       4
        
        <title>Languages and frameworks</title>

     

       5
        
        <para>

     

       6
       -
         The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.

     

       7
        
        </para>

     

       8
        
        <xi:include href="agda.section.xml" />

     

       9
        
        <xi:include href="android.section.xml" />

···

       3
        
                xml:id="chap-language-support">

     

       4
        
        <title>Languages and frameworks</title>

     

       5
        
        <para>

     

       6
       +
         The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accommodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.

     

       7
        
        </para>

     

       8
        
        <xi:include href="agda.section.xml" />

     

       9
        
        <xi:include href="android.section.xml" />

+2 -2

doc/languages-frameworks/python.section.md

···

       605
        
       `test` command for a `checkPhase` which runs `pytest`. This is also beneficial

     

       606
        
       when a package may need many items disabled to run the test suite.

     

       607
        
       

     

       608
       -
       Using the example above, the analagous `pytestCheckHook` usage would be:

     

       609
        
       

     

       610
        
       ```

     

       611
        
         checkInputs = [ pytestCheckHook ];

     
···

       624
        
         ];

     

       625
        
       ```

     

       626
        
       

     

       627
       -
       This is expecially useful when tests need to be conditionally disabled,

     

       628
        
       for example:

     

       629
        
       

     

       630
        
       ```

···

       605
        
       `test` command for a `checkPhase` which runs `pytest`. This is also beneficial

     

       606
        
       when a package may need many items disabled to run the test suite.

     

       607
        
       

     

       608
       +
       Using the example above, the analogous `pytestCheckHook` usage would be:

     

       609
        
       

     

       610
        
       ```

     

       611
        
         checkInputs = [ pytestCheckHook ];

     
···

       624
        
         ];

     

       625
        
       ```

     

       626
        
       

     

       627
       +
       This is especially useful when tests need to be conditionally disabled,

     

       628
        
       for example:

     

       629
        
       

     

       630
        
       ```

+1 -1

doc/languages-frameworks/rust.section.md

···

       319
        
       However, please check if it's possible to disable a problematic subset of the

     

       320
        
       test suite and leave a comment explaining your reasoning.

     

       321
        
       

     

       322
       -
       This can be achived with `--skip` in `checkFlags`:

     

       323
        
       

     

       324
        
       ```nix

     

       325
        
       rustPlatform.buildRustPackage {

···

       319
        
       However, please check if it's possible to disable a problematic subset of the

     

       320
        
       test suite and leave a comment explaining your reasoning.

     

       321
        
       

     

       322
       +
       This can be achieved with `--skip` in `checkFlags`:

     

       323
        
       

     

       324
        
       ```nix

     

       325
        
       rustPlatform.buildRustPackage {

+1 -1

doc/old/cross.txt

···

       303
        
       This is used by the Nix build process to set the dynamic linker, glibc

     

       304
        
       in the case of i686-linux using the default Nix packages collection.

     

       305
        
       

     

       306
       -
       Obiously, since we need to compile libstc++ for arm-linux with uClibc linking

     

       307
        
       will not be done correctly: you can't link object files built for arm-linux

     

       308
        
       with a glibc built for i686-linux.

     

       309

···

       303
        
       This is used by the Nix build process to set the dynamic linker, glibc

     

       304
        
       in the case of i686-linux using the default Nix packages collection.

     

       305
        
       

     

       306
       +
       Obviously, since we need to compile libstc++ for arm-linux with uClibc linking

     

       307
        
       will not be done correctly: you can't link object files built for arm-linux

     

       308
        
       with a glibc built for i686-linux.

     

       309

+1 -1

doc/stdenv/multiple-output.chapter.md

···

       29
        
       `nix-env` lacks an easy way to select the outputs to install. When installing a package, `nix-env` always installs the outputs listed in `meta.outputsToInstall`, even when the user explicitly selects an output.

     

       30
        
       

     

       31
        
       ::: {.warning}

     

       32
       -
       `nix-env` silenty disregards the outputs selected by the user, and instead installs the outputs from `meta.outputsToInstall`. For example,

     

       33
        
       

     

       34
        
       ```ShellSession

     

       35
        
       $ nix-env -iA nixpkgs.coreutils.info

···

       29
        
       `nix-env` lacks an easy way to select the outputs to install. When installing a package, `nix-env` always installs the outputs listed in `meta.outputsToInstall`, even when the user explicitly selects an output.

     

       30
        
       

     

       31
        
       ::: {.warning}

     

       32
       +
       `nix-env` silently disregards the outputs selected by the user, and instead installs the outputs from `meta.outputsToInstall`. For example,

     

       33
        
       

     

       34
        
       ```ShellSession

     

       35
        
       $ nix-env -iA nixpkgs.coreutils.info

+2 -2

doc/stdenv/stdenv.chapter.md

···

       719
        
       

     

       720
        
       ##### `dontStripHost` {#var-stdenv-dontStripHost}

     

       721
        
       

     

       722
       -
       Like `dontStrip`, but only affects the `strip` command targetting the package’s host platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       723
        
       

     

       724
        
       ##### `dontStripTarget` {#var-stdenv-dontStripTarget}

     

       725
        
       

     

       726
       -
       Like `dontStrip`, but only affects the `strip` command targetting the packages’ target platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       727
        
       

     

       728
        
       ##### `dontMoveSbin` {#var-stdenv-dontMoveSbin}

     

       729

···

       719
        
       

     

       720
        
       ##### `dontStripHost` {#var-stdenv-dontStripHost}

     

       721
        
       

     

       722
       +
       Like `dontStrip`, but only affects the `strip` command targeting the package’s host platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       723
        
       

     

       724
        
       ##### `dontStripTarget` {#var-stdenv-dontStripTarget}

     

       725
        
       

     

       726
       +
       Like `dontStrip`, but only affects the `strip` command targeting the packages’ target platform. Useful when supporting cross compilation, but otherwise feel free to ignore.

     

       727
        
       

     

       728
        
       ##### `dontMoveSbin` {#var-stdenv-dontMoveSbin}

     

       729