commit a3626a459db332151d5a9f85712e57bc08aa57a4 · pyrox.dev/nixpkgs

doc/hooks/index.md

···

       17
       17
        
       gnome.section.md

     

       18
       18
        
       haredo.section.md

     

       19
       19
        
       installShellFiles.section.md

     

       20
       20
       +
       just.section.md

     

       20
       21
        
       libiconv.section.md

     

       21
       22
        
       libxml2.section.md

     

       22
       23
        
       meson.section.md

+23

doc/hooks/just.section.md

···

       1
       1
       +
       # `just` {#just-hook}

     

       2
       2
       +
       

     

       3
       3
       +
       This setup hook attempts to use [the `just` command runner](https://just.systems/man/en/) to build, check, and install the package. The hook overrides `buildPhase`, `checkPhase`, and `installPhase` by default.

     

       4
       4
       +
       

     

       5
       5
       +
       []{#just-hook-justFlags} The `justFlags` variable can be set to a list of strings to add additional flags passed to all invocations of `just`.

     

       6
       6
       +
       

     

       7
       7
       +
       ## `buildPhase` {#just-hook-buildPhase}

     

       8
       8
       +
       

     

       9
       9
       +
       This phase attempts to invoke `just` with [the default recipe](https://just.systems/man/en/chapter_23.html).

     

       10
       10
       +
       

     

       11
       11
       +
       []{#just-hook-dontUseJustBuild} This behavior can be disabled by setting `dontUseJustBuild` to `true`.

     

       12
       12
       +
       

     

       13
       13
       +
       ## `checkPhase` {#just-hook-checkPhase}

     

       14
       14
       +
       

     

       15
       15
       +
       This phase attempts to invoke the `just test` recipe, if it is available. This can be overrided by setting `checkTarget` to a string.

     

       16
       16
       +
       

     

       17
       17
       +
       []{#just-hook-dontUseJustCheck} This behavior can be disabled by setting `dontUseJustCheck` to `true`.

     

       18
       18
       +
       

     

       19
       19
       +
       ## `installPhase` {#just-hook-installPhase}

     

       20
       20
       +
       

     

       21
       21
       +
       This phase attempts to invoke the `just install` recipe.

     

       22
       22
       +
       

     

       23
       23
       +
       []{#just-hook-dontUseJustInstall} This behavior can be disabled by setting `dontUseJustInstall` to `true`.