commit 70ec3b9f545e9c681e5dfcac10fcde3c4ff1eb87 · pyrox.dev/nixpkgs

+1

nixos/doc/manual/default.nix

···

       63
       63
        
             };

     

       64
       64
        
             documentType = "none";

     

       65
       65
        
             variablelistId = "test-options-list";

     

       66
       66
       +
             optionIdPrefix = "test-opt-";

     

       66
       67
        
           };

     

       67
       68
        
       

     

       68
       69
        
         sources = lib.sourceFilesBySuffices ./. [".xml"];

+2 -2

nixos/doc/manual/development/running-nixos-tests-interactively.section.md

···

       39
       39
        
       ## Interactive-only test configuration {#sec-nixos-test-interactive-configuration}

     

       40
       40
        
       

     

       41
       41
        
       The `.driverInteractive` attribute combines the regular test configuration with

     

       42
       42
       -
       definitions from the [`interactive` submodule](#opt-interactive). This gives you

     

       42
       42
       +
       definitions from the [`interactive` submodule](#test-opt-interactive). This gives you

     

       43
       43
        
       a more usable, graphical, but slightly different configuration.

     

       44
       44
        
       

     

       45
       45
        
       You can add your own interactive-only test configuration by adding extra

     

       46
       46
       -
       configuration to the [`interactive` submodule](#opt-interactive).

     

       46
       46
       +
       configuration to the [`interactive` submodule](#test-opt-interactive).

     

       47
       47
        
       

     

       48
       48
        
       To interactively run only the regular configuration, build the `<test>.driver` attribute

     

       49
       49
        
       instead, and call it with the flag `result/bin/nixos-test-driver --interactive`.

+6 -6

nixos/doc/manual/development/writing-nixos-tests.section.md

···

       22
       22
        
       ```

     

       23
       23
        
       

     

       24
       24
        
       We refer to the whole test above as a test module, whereas the values

     

       25
       25
       -
       in [`nodes.<name>`](#opt-nodes) are NixOS modules themselves.

     

       25
       25
       +
       in [`nodes.<name>`](#test-opt-nodes) are NixOS modules themselves.

     

       26
       26
        
       

     

       27
       27
       -
       The option [`testScript`](#opt-testScript) is a piece of Python code that executes the

     

       27
       27
       +
       The option [`testScript`](#test-opt-testScript) is a piece of Python code that executes the

     

       28
       28
        
       test (described below). During the test, it will start one or more

     

       29
       29
        
       virtual machines, the configuration of which is described by

     

       30
       30
       -
       the option [`nodes`](#opt-nodes).

     

       30
       30
       +
       the option [`nodes`](#test-opt-nodes).

     

       31
       31
        
       

     

       32
       32
        
       An example of a single-node test is

     

       33
       33
        
       [`login.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix).

     
···

       171
       171
        
           least one will be returned.

     

       172
       172
        
       

     

       173
       173
        
           ::: {.note}

     

       174
       174
       -
           This requires [`enableOCR`](#opt-enableOCR) to be set to `true`.

     

       174
       174
       +
           This requires [`enableOCR`](#test-opt-enableOCR) to be set to `true`.

     

       175
       175
        
           :::

     

       176
       176
        
       

     

       177
       177
        
       `get_screen_text`

     
···

       180
       180
        
           machine\'s screen using optical character recognition.

     

       181
       181
        
       

     

       182
       182
        
           ::: {.note}

     

       183
       183
       -
           This requires [`enableOCR`](#opt-enableOCR) to be set to `true`.

     

       183
       183
       +
           This requires [`enableOCR`](#test-opt-enableOCR) to be set to `true`.

     

       184
       184
        
           :::

     

       185
       185
        
       

     

       186
       186
        
       `send_monitor_command`

     
···

       291
       291
        
           `get_screen_text` and `get_screen_text_variants`).

     

       292
       292
        
       

     

       293
       293
        
           ::: {.note}

     

       294
       294
       -
           This requires [`enableOCR`](#opt-enableOCR) to be set to `true`.

     

       294
       294
       +
           This requires [`enableOCR`](#test-opt-enableOCR) to be set to `true`.

     

       295
       295
        
           :::

     

       296
       296
        
       

     

       297
       297
        
       `wait_for_console_text`

+2 -2

nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml

···

       44
       44
        
           <para>

     

       45
       45
        
             The <literal>.driverInteractive</literal> attribute combines the

     

       46
       46
        
             regular test configuration with definitions from the

     

       47
       47
       -
             <link linkend="opt-interactive"><literal>interactive</literal>

     

       47
       47
       +
             <link linkend="test-opt-interactive"><literal>interactive</literal>

     

       48
       48
        
             submodule</link>. This gives you a more usable, graphical, but

     

       49
       49
        
             slightly different configuration.

     

       50
       50
        
           </para>

     

       51
       51
        
           <para>

     

       52
       52
        
             You can add your own interactive-only test configuration by adding

     

       53
       53
        
             extra configuration to the

     

       54
       54
       -
             <link linkend="opt-interactive"><literal>interactive</literal>

     

       54
       54
       +
             <link linkend="test-opt-interactive"><literal>interactive</literal>

     

       55
       55
        
             submodule</link>.

     

       56
       56
        
           </para>

     

       57
       57
        
           <para>

+6 -6

nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml

···

       24
       24
        
         <para>

     

       25
       25
        
           We refer to the whole test above as a test module, whereas the

     

       26
       26
        
           values in

     

       27
       27
       -
           <link linkend="opt-nodes"><literal>nodes.&lt;name&gt;</literal></link>

     

       27
       27
       +
           <link linkend="test-opt-nodes"><literal>nodes.&lt;name&gt;</literal></link>

     

       28
       28
        
           are NixOS modules themselves.

     

       29
       29
        
         </para>

     

       30
       30
        
         <para>

     

       31
       31
        
           The option

     

       32
       32
       -
           <link linkend="opt-testScript"><literal>testScript</literal></link>

     

       32
       32
       +
           <link linkend="test-opt-testScript"><literal>testScript</literal></link>

     

       33
       33
        
           is a piece of Python code that executes the test (described below).

     

       34
       34
        
           During the test, it will start one or more virtual machines, the

     

       35
       35
        
           configuration of which is described by the option

     

       36
       36
       -
           <link linkend="opt-nodes"><literal>nodes</literal></link>.

     

       36
       36
       +
           <link linkend="test-opt-nodes"><literal>nodes</literal></link>.

     

       37
       37
        
         </para>

     

       38
       38
        
         <para>

     

       39
       39
        
           An example of a single-node test is

     
···

       263
       263
        
                 <note>

     

       264
       264
        
                   <para>

     

       265
       265
        
                     This requires

     

       266
       266
       -
                     <link linkend="opt-enableOCR"><literal>enableOCR</literal></link>

     

       266
       266
       +
                     <link linkend="test-opt-enableOCR"><literal>enableOCR</literal></link>

     

       267
       267
        
                     to be set to <literal>true</literal>.

     

       268
       268
        
                   </para>

     

       269
       269
        
                 </note>

     
···

       281
       281
        
                 <note>

     

       282
       282
        
                   <para>

     

       283
       283
        
                     This requires

     

       284
       284
       -
                     <link linkend="opt-enableOCR"><literal>enableOCR</literal></link>

     

       284
       284
       +
                     <link linkend="test-opt-enableOCR"><literal>enableOCR</literal></link>

     

       285
       285
        
                     to be set to <literal>true</literal>.

     

       286
       286
        
                   </para>

     

       287
       287
        
                 </note>

     
···

       522
       522
        
                 <note>

     

       523
       523
        
                   <para>

     

       524
       524
        
                     This requires

     

       525
       525
       -
                     <link linkend="opt-enableOCR"><literal>enableOCR</literal></link>

     

       525
       525
       +
                     <link linkend="test-opt-enableOCR"><literal>enableOCR</literal></link>

     

       526
       526
        
                     to be set to <literal>true</literal>.

     

       527
       527
        
                   </para>

     

       528
       528
        
                 </note>

+3

nixos/lib/make-options-doc/default.nix

···

       26
       26
        
         # If you include more than one option list into a document, you need to

     

       27
       27
        
         # provide different ids.

     

       28
       28
        
       , variablelistId ? "configuration-variable-list"

     

       29
       29
       +
         # Strig to prefix to the option XML/HTML id attributes.

     

       30
       30
       +
       , optionIdPrefix ? "opt-"

     

       29
       31
        
       , revision ? "" # Specify revision for the options

     

       30
       32
        
       # a set of options the docs we are generating will be merged into, as if by recursiveUpdate.

     

       31
       33
        
       # used to split the options doc build into a static part (nixos/modules) and a dynamic part

     
···

       183
       185
        
             --stringparam documentType '${documentType}' \

     

       184
       186
        
             --stringparam revision '${revision}' \

     

       185
       187
        
             --stringparam variablelistId '${variablelistId}' \

     

       188
       188
       +
             --stringparam optionIdPrefix '${optionIdPrefix}' \

     

       186
       189
        
             -o intermediate.xml ${./options-to-docbook.xsl} sorted.xml

     

       187
       190
        
           ${pkgs.libxslt.bin}/bin/xsltproc \

     

       188
       191
        
             -o "$out" ${./postprocess-option-descriptions.xsl} intermediate.xml

+2 -1

nixos/lib/make-options-doc/options-to-docbook.xsl

···

       15
       15
        
         <xsl:param name="documentType" />

     

       16
       16
        
         <xsl:param name="program" />

     

       17
       17
        
         <xsl:param name="variablelistId" />

     

       18
       18
       +
         <xsl:param name="optionIdPrefix" />

     

       18
       19
        
       

     

       19
       20
        
       

     

       20
       21
        
         <xsl:template match="/expr/list">

     
···

       36
       37
        
             <xsl:attribute name="id" namespace="http://www.w3.org/XML/1998/namespace"><xsl:value-of select="$variablelistId"/></xsl:attribute>

     

       37
       38
        
               <xsl:for-each select="attrs">

     

       38
       39
        
                 <xsl:variable name="id" select="

     

       39
       39
       -
                   concat('opt-',

     

       40
       40
       +
                   concat($optionIdPrefix,

     

       40
       41
        
                     translate(

     

       41
       42
        
                       attr[@name = 'name']/string/@value,

     

       42
       43
        
                       '*&lt; >[]:',

+3 -3

nixos/lib/testing/driver.nix

···

       120
       120
        
           };

     

       121
       121
        
       

     

       122
       122
        
           qemu.package = mkOption {

     

       123
       123
       -
             description = mdDoc "Which qemu package to use for the virtualisation of [{option}`nodes`](#opt-nodes).";

     

       123
       123
       +
             description = mdDoc "Which qemu package to use for the virtualisation of [{option}`nodes`](#test-opt-nodes).";

     

       124
       124
        
             type = types.package;

     

       125
       125
        
             default = hostPkgs.qemu_test;

     

       126
       126
        
             defaultText = "hostPkgs.qemu_test";

     
···

       152
       152
        
             description = mdDoc ''

     

       153
       153
        
               Extra arguments to pass to the test driver.

     

       154
       154
        
       

     

       155
       155
       -
               They become part of [{option}`driver`](#opt-driver) via `wrapProgram`.

     

       155
       155
       +
               They become part of [{option}`driver`](#test-opt-driver) via `wrapProgram`.

     

       156
       156
        
             '';

     

       157
       157
        
             type = types.listOf types.str;

     

       158
       158
        
             default = [];

     
···

       172
       172
        
             description = mdDoc ''

     

       173
       173
        
               Disable type checking. This must not be enabled for new NixOS tests.

     

       174
       174
        
       

     

       175
       175
       -
               This may speed up your iteration cycle, unless you're working on the [{option}`testScript`](#opt-testScript).

     

       175
       175
       +
               This may speed up your iteration cycle, unless you're working on the [{option}`testScript`](#test-opt-testScript).

     

       176
       176
        
             '';

     

       177
       177
        
           };

     

       178
       178
        
         };

+2 -2

nixos/lib/testing/meta.nix

···

       24
       24
        
                   type = types.nullOr types.int;

     

       25
       25
        
                   default = null; # NOTE: null values are filtered out by `meta`.

     

       26
       26
        
                   description = mdDoc ''

     

       27
       27
       -
                     The [{option}`test`](#opt-test)'s [`meta.timeout`](https://nixos.org/manual/nixpkgs/stable/#var-meta-timeout) in seconds.

     

       27
       27
       +
                     The [{option}`test`](#test-opt-test)'s [`meta.timeout`](https://nixos.org/manual/nixpkgs/stable/#var-meta-timeout) in seconds.

     

       28
       28
        
                   '';

     

       29
       29
        
                 };

     

       30
       30
        
                 broken = lib.mkOption {

     

       31
       31
        
                   type = types.bool;

     

       32
       32
        
                   default = false;

     

       33
       33
        
                   description = mdDoc ''

     

       34
       34
       -
                     Sets the [`meta.broken`](https://nixos.org/manual/nixpkgs/stable/#var-meta-broken) attribute on the [{option}`test`](#opt-test) derivation.

     

       34
       34
       +
                     Sets the [`meta.broken`](https://nixos.org/manual/nixpkgs/stable/#var-meta-broken) attribute on the [{option}`test`](#test-opt-test) derivation.

     

       35
       35
        
                   '';

     

       36
       36
        
                 };

     

       37
       37
        
               };

+1 -1

nixos/lib/testing/name.nix

···

       7
       7
        
           description = mdDoc ''

     

       8
       8
        
             The name of the test.

     

       9
       9
        
       

     

       10
       10
       -
             This is used in the derivation names of the [{option}`driver`](#opt-driver) and [{option}`test`](#opt-test) runner.

     

       10
       10
       +
             This is used in the derivation names of the [{option}`driver`](#test-opt-driver) and [{option}`test`](#test-opt-test) runner.

     

       11
       11
        
           '';

     

       12
       12
        
           type = types.str;

     

       13
       13
        
         };

+4 -4

nixos/lib/testing/nodes.nix

···

       44
       44
        
             description = mdDoc ''

     

       45
       45
        
               An attribute set of NixOS configuration modules.

     

       46
       46
        
       

     

       47
       47
       -
               The configurations are augmented by the [`defaults`](#opt-defaults) option.

     

       47
       47
       +
               The configurations are augmented by the [`defaults`](#test-opt-defaults) option.

     

       48
       48
        
       

     

       49
       49
        
               They are assigned network addresses according to the `nixos/lib/testing/network.nix` module.

     

       50
       50
        
       

     
···

       54
       54
        
       

     

       55
       55
        
           defaults = mkOption {

     

       56
       56
        
             description = mdDoc ''

     

       57
       57
       -
               NixOS configuration that is applied to all [{option}`nodes`](#opt-nodes).

     

       57
       57
       +
               NixOS configuration that is applied to all [{option}`nodes`](#test-opt-nodes).

     

       58
       58
        
             '';

     

       59
       59
        
             type = types.deferredModule;

     

       60
       60
        
             default = { };

     
···

       62
       62
        
       

     

       63
       63
        
           extraBaseModules = mkOption {

     

       64
       64
        
             description = mdDoc ''

     

       65
       65
       -
               NixOS configuration that, like [{option}`defaults`](#opt-defaults), is applied to all [{option}`nodes`](#opt-nodes) and can not be undone with [`specialisation.<name>.inheritParentConfig`](https://search.nixos.org/options?show=specialisation.%3Cname%3E.inheritParentConfig&from=0&size=50&sort=relevance&type=packages&query=specialisation).

     

       65
       65
       +
               NixOS configuration that, like [{option}`defaults`](#test-opt-defaults), is applied to all [{option}`nodes`](#test-opt-nodes) and can not be undone with [`specialisation.<name>.inheritParentConfig`](https://search.nixos.org/options?show=specialisation.%3Cname%3E.inheritParentConfig&from=0&size=50&sort=relevance&type=packages&query=specialisation).

     

       66
       66
        
             '';

     

       67
       67
        
             type = types.deferredModule;

     

       68
       68
        
             default = { };

     
···

       82
       82
        
             type = types.bool;

     

       83
       83
        
             default = false;

     

       84
       84
        
             description = mdDoc ''

     

       85
       85
       -
               Enable to configure all [{option}`nodes`](#opt-nodes) to run with a minimal kernel.

     

       85
       85
       +
               Enable to configure all [{option}`nodes`](#test-opt-nodes) to run with a minimal kernel.

     

       86
       86
        
             '';

     

       87
       87
        
           };

     

       88
       88