commit 130d2fa5e54a882ddd22ce8856c8aa81aee1040e · pyrox.dev/nixpkgs

doc/hooks/index.md

···

       29
       29
        
       unzip.section.md

     

       30
       30
        
       validatePkgConfig.section.md

     

       31
       31
        
       waf.section.md

     

       32
       32
       +
       zig.section.md

     

       32
       33
        
       xcbuild.section.md

     

       33
       34
        
       ```

+59

doc/hooks/zig.section.md

···

       1
       1
       +
       # zigHook {#zighook}

     

       2
       2
       +
       

     

       3
       3
       +
       [Zig](https://ziglang.org/) is a general-purpose programming language and toolchain for maintaining robust, optimal and reusable software.

     

       4
       4
       +
       

     

       5
       5
       +
       In Nixpkgs, `zigHook` overrides the default build, check and install phases.

     

       6
       6
       +
       

     

       7
       7
       +
       ## Example code snippet {#example-code-snippet}

     

       8
       8
       +
       

     

       9
       9
       +
       ```nix

     

       10
       10
       +
       { lib

     

       11
       11
       +
       , stdenv

     

       12
       12
       +
       , zigHook

     

       13
       13
       +
       }:

     

       14
       14
       +
       

     

       15
       15
       +
       stdenv.mkDerivation {

     

       16
       16
       +
         # . . .

     

       17
       17
       +
       

     

       18
       18
       +
         nativeBuildInputs = [

     

       19
       19
       +
           zigHook

     

       20
       20
       +
         ];

     

       21
       21
       +
       

     

       22
       22
       +
         zigBuildFlags = [ "-Dman-pages=true" ];

     

       23
       23
       +
       

     

       24
       24
       +
         dontUseZigCheck = true;

     

       25
       25
       +
       

     

       26
       26
       +
         # . . .

     

       27
       27
       +
       }

     

       28
       28
       +
       ```

     

       29
       29
       +
       

     

       30
       30
       +
       ## Variables controlling zigHook {#variables-controlling-zighook}

     

       31
       31
       +
       

     

       32
       32
       +
       ### `dontUseZigBuild` {#dontUseZigBuild}

     

       33
       33
       +
       

     

       34
       34
       +
       Disables using `zigBuildPhase`.

     

       35
       35
       +
       

     

       36
       36
       +
       ### `zigBuildFlags` {#zigBuildFlags}

     

       37
       37
       +
       

     

       38
       38
       +
       Controls the flags passed to the build phase.

     

       39
       39
       +
       

     

       40
       40
       +
       ### `dontUseZigCheck` {#dontUseZigCheck}

     

       41
       41
       +
       

     

       42
       42
       +
       Disables using `zigCheckPhase`.

     

       43
       43
       +
       

     

       44
       44
       +
       ### `zigCheckFlags` {#zigCheckFlags}

     

       45
       45
       +
       

     

       46
       46
       +
       Controls the flags passed to the check phase.

     

       47
       47
       +
       

     

       48
       48
       +
       ### `dontUseZigInstall` {#dontUseZigInstall}

     

       49
       49
       +
       

     

       50
       50
       +
       Disables using `zigInstallPhase`.

     

       51
       51
       +
       

     

       52
       52
       +
       ### `zigInstallFlags` {#zigInstallFlags}

     

       53
       53
       +
       

     

       54
       54
       +
       Controls the flags passed to the install phase.

     

       55
       55
       +
       

     

       56
       56
       +
       ### Variables honored by zigHook {#variablesHonoredByZigHook}

     

       57
       57
       +
       

     

       58
       58
       +
       - `prefixKey`

     

       59
       59
       +
       - `dontAddPrefix`