commit a0b25e2566f205e11402d0caba4b48eb520873b1 · pyrox.dev/nixpkgs

+29 -21
doc/hooks/waf.section.md
···

       1
       1
       -
       # waf.hook {#wafhook}

     

       1
       1
       +
       # wafHook {#waf-hook}

     

       2
       2
        
       

     

       3
       3
        
       [Waf](https://waf.io) is a Python-based software building system.

     

       4
       4
        
       

     

       5
       5
       -
       In Nixpkgs, `waf.hook` overrides the default configure, build, and install phases.

     

       5
       5
       +
       In Nixpkgs, `wafHook` overrides the default configure, build, and install phases.

     

       6
       6
        
       

     

       7
       7
       -
       ## Variables controlling waf.hook {#variablesControllingWafHook}

     

       7
       7
       +
       ## Variables controlling wafHook {#waf-hook-variables-controlling}

     

       8
       8
        
       

     

       9
       9
       -
       ### `wafPath` {#wafPath}

     

       9
       9
       +
       ### `wafHook` Exclusive Variables {#waf-hook-exclusive-variables}

     

       10
       10
        
       

     

       11
       11
       -
       Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.

     

       11
       11
       +
       The variables below are exclusive of `wafHook`.

     

       12
       12
        
       

     

       13
       13
       -
       If `wafPath` doesn't exist, then `waf.hook` will copy the `waf` provided from Nixpkgs to it.

     

       13
       13
       +
       #### `wafPath` {#waf-path}

     

       14
       14
        
       

     

       15
       15
       -
       ### `wafConfigureFlags` {#wafConfigureFlags}

     

       15
       15
       +
       Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees.

     

       16
       16
        
       

     

       17
       17
       -
       Controls the flags passed to waf tool during configure phase.

     

       17
       17
       +
       If `wafPath` doesn't exist, then `wafHook` will copy the `waf` provided from Nixpkgs to it.

     

       18
       18
        
       

     

       19
       19
       -
       ### `wafFlags` {#wafFlags}

     

       19
       19
       +
       #### `wafFlags` {#waf-flags}

     

       20
       20
        
       

     

       21
       21
       -
       Controls the flags passed to waf tool during build and install phases.

     

       21
       21
       +
       Controls the flags passed to waf tool during build and install phases. For settings specific to build or install phases, use `wafBuildFlags` or `wafInstallFlags` respectively.

     

       22
       22
        
       

     

       23
       23
       -
       ### `dontAddWafCrossFlags` {#dontAddWafCrossFlags}

     

       23
       23
       +
       #### `dontAddWafCrossFlags` {#dont-add-waf-cross-flags}

     

       24
       24
        
       

     

       25
       25
        
       When set to `true`, don't add cross compilation flags during configure phase.

     

       26
       26
        
       

     

       27
       27
       -
       ### `dontUseWafConfigure` {#dontUseWafConfigure}

     

       27
       27
       +
       #### `dontUseWafConfigure` {#dont-use-waf-configure}

     

       28
       28
        
       

     

       29
       29
        
       When set to true, don't use the predefined `wafConfigurePhase`.

     

       30
       30
        
       

     

       31
       31
       -
       ### `dontUseWafBuild` {#dontUseWafBuild}

     

       31
       31
       +
       #### `dontUseWafBuild` {#dont-use-waf-build}

     

       32
       32
        
       

     

       33
       33
        
       When set to true, don't use the predefined `wafBuildPhase`.

     

       34
       34
        
       

     

       35
       35
       -
       ### `dontUseWafInstall` {#dontUseWafInstall}

     

       35
       35
       +
       #### `dontUseWafInstall` {#dont-use-waf-install}

     

       36
       36
        
       

     

       37
       37
        
       When set to true, don't use the predefined `wafInstallPhase`.

     

       38
       38
        
       

     

       39
       39
       -
       ### Variables honored by waf.hook {#variablesHonoredByWafHook}

     

       39
       39
       +
       ### Similar variables {#waf-hook-similar-variables}

     

       40
       40
       +
       

     

       41
       41
       +
       The following variables are similar to their `stdenv.mkDerivation` counterparts.

     

       42
       42
       +
       

     

       43
       43
       +
       | `wafHook` Variable    | `stdenv.mkDerivation` Counterpart |

     

       44
       44
       +
       |-----------------------|-----------------------------------|

     

       45
       45
       +
       | `wafConfigureFlags`   | `configureFlags`                  |

     

       46
       46
       +
       | `wafConfigureTargets` | `configureTargets`                |

     

       47
       47
       +
       | `wafBuildFlags`       | `buildFlags`                      |

     

       48
       48
       +
       | `wafBuildTargets`     | `buildTargets`                    |

     

       49
       49
       +
       | `wafInstallFlags`     | `installFlags`                    |

     

       50
       50
       +
       | `wafInstallTargets`   | `installTargets`                  |

     

       40
       51
        
       

     

       41
       41
       -
       The following variables commonly used by `stdenv.mkDerivation` are also honored by `waf.hook`.

     

       52
       52
       +
       ### Honored variables {#waf-hook-honored-variables}

     

       53
       53
       +
       

     

       54
       54
       +
       The following variables commonly used by `stdenv.mkDerivation` are honored by `wafHook`.

     

       42
       55
        
       

     

       43
       56
        
       - `prefixKey`

     

       44
       44
       -
       - `configureTargets`

     

       45
       57
        
       - `enableParallelBuilding`

     

       46
       58
        
       - `enableParallelInstalling`

     

       47
       47
       -
       - `buildFlags`

     

       48
       48
       -
       - `buildTargets`

     

       49
       49
       -
       - `installFlags`

     

       50
       50
       -
       - `installTargets`