commit d3a197a33d872e9fccf094da96a824e528ffe579 · pyrox.dev/nixpkgs

doc/hooks/index.md

···

       35
       35
        
       scons.section.md

     

       36
       36
        
       tauri.section.md

     

       37
       37
        
       tetex-tex-live.section.md

     

       38
       38
       +
       udevCheckHook.section.md

     

       38
       39
        
       unzip.section.md

     

       39
       40
        
       validatePkgConfig.section.md

     

       40
       41
        
       versionCheckHook.section.md

+36

doc/hooks/udevCheckHook.section.md

···

       1
       1
       +
       # udevCheckHook {#udevcheckhook}

     

       2
       2
       +
       

     

       3
       3
       +
       The `udevCheckHook` derivation adds `udevCheckPhase` to the [`preInstallCheckHooks`](#ssec-installCheck-phase),

     

       4
       4
       +
       which finds all udev rules in all outputs and verifies them using `udevadm verify --resolve-names=never --no-style`.

     

       5
       5
       +
       It should be used in any package that has udev rules outputs to ensure the rules are and stay valid.

     

       6
       6
       +
       

     

       7
       7
       +
       The hook runs in `installCheckPhase`, requiring `doInstallCheck` is enabled for the hook to take effect:

     

       8
       8
       +
       ```nix

     

       9
       9
       +
       {

     

       10
       10
       +
         lib,

     

       11
       11
       +
         stdenv,

     

       12
       12
       +
         udevCheckHook,

     

       13
       13
       +
       # ...

     

       14
       14
       +
       }:

     

       15
       15
       +
       

     

       16
       16
       +
       stdenv.mkDerivation (finalAttrs: {

     

       17
       17
       +
         # ...

     

       18
       18
       +
       

     

       19
       19
       +
         nativeInstallCheckInputs = [

     

       20
       20
       +
           udevCheckHook

     

       21
       21
       +
         ];

     

       22
       22
       +
         doInstallCheck = true;

     

       23
       23
       +
       

     

       24
       24
       +
         # ...

     

       25
       25
       +
       })

     

       26
       26
       +
       ```

     

       27
       27
       +
       Note that for [`buildPythonPackage`](#buildpythonpackage-function) and [`buildPythonApplication`](#buildpythonapplication-function), `doInstallCheck` is enabled by default.

     

       28
       28
       +
       

     

       29
       29
       +
       All outputs are scanned for their `/{etc,lib}/udev/rules.d` paths.

     

       30
       30
       +
       If no rule output is found, the hook is basically a no-op.

     

       31
       31
       +
       

     

       32
       32
       +
       The `udevCheckHook` adds a dependency on `systemdMinimal`.

     

       33
       33
       +
       It is internally guarded behind `hostPlatform` supporting udev and `buildPlatform` being able to execute `udevadm`.

     

       34
       34
       +
       The hook does not need explicit platform checks in the places where it is used.

     

       35
       35
       +
       

     

       36
       36
       +
       The hook can be disabled using `dontUdevCheck`, which is necessary if you want to run some different task in `installCheckPhase` on a package with broken udev rule outputs.

doc/redirects.json

···

       2429
       2429
        
         "tetex-tex-live": [

     

       2430
       2430
        
           "index.html#tetex-tex-live"

     

       2431
       2431
        
         ],

     

       2432
       2432
       +
         "udevcheckhook": [

     

       2433
       2433
       +
           "index.html#udevcheckhook"

     

       2434
       2434
       +
         ],

     

       2432
       2435
        
         "unzip": [

     

       2433
       2436
        
           "index.html#unzip"

     

       2434
       2437
        
         ],