diff options
| author | pennae <github@quasiparticle.net> | 2023-01-15 15:05:30 +0100 |
|---|---|---|
| committer | pennae <82953136+pennae@users.noreply.github.com> | 2023-01-22 17:08:40 +0100 |
| commit | ad8d5cf731e7d0b2d0cca148fa01b805c4f5d3a3 (patch) | |
| tree | d61e8484b85104c2ef7bd8c4d30972e34777ac74 | |
| parent | df09c21fb262ed07f01099625ef9310a8a8392ae (diff) | |
nixos/manual: clarify mk{Enable,Package}Option MD usage
the examples were incorrect, but not catastrophically. running a docs
build would've issued a warning with the correct instructions.
| -rw-r--r-- | nixos/doc/manual/development/option-declarations.section.md | 6 | ||||
| -rw-r--r-- | nixos/doc/manual/from_md/development/option-declarations.section.xml | 6 |
2 files changed, 6 insertions, 6 deletions
diff --git a/nixos/doc/manual/development/option-declarations.section.md b/nixos/doc/manual/development/option-declarations.section.md index aa747f47c9c8..18ec7ba903a9 100644 --- a/nixos/doc/manual/development/option-declarations.section.md +++ b/nixos/doc/manual/development/option-declarations.section.md @@ -78,7 +78,7 @@ For example: ::: {#ex-options-declarations-util-mkEnableOption-magic .example} ```nix -lib.mkEnableOption "magic" +lib.mkEnableOption (lib.mdDoc "magic") # is like lib.mkOption { type = lib.types.bool; @@ -113,7 +113,7 @@ Examples: ::: {#ex-options-declarations-util-mkPackageOption-hello .example} ```nix -lib.mkPackageOption pkgs "hello" { } +lib.mkPackageOptionMD pkgs "hello" { } # is like lib.mkOption { type = lib.types.package; @@ -125,7 +125,7 @@ lib.mkOption { ::: {#ex-options-declarations-util-mkPackageOption-ghc .example} ```nix -lib.mkPackageOption pkgs "GHC" { +lib.mkPackageOptionMD pkgs "GHC" { default = [ "ghc" ]; example = "pkgs.haskell.packages.ghc92.ghc.withPackages (hkgs: [ hkgs.primes ])"; } diff --git a/nixos/doc/manual/from_md/development/option-declarations.section.xml b/nixos/doc/manual/from_md/development/option-declarations.section.xml index cc4893939c28..af05e61363e4 100644 --- a/nixos/doc/manual/from_md/development/option-declarations.section.xml +++ b/nixos/doc/manual/from_md/development/option-declarations.section.xml @@ -128,7 +128,7 @@ options = { </para> <anchor xml:id="ex-options-declarations-util-mkEnableOption-magic" /> <programlisting language="nix"> -lib.mkEnableOption "magic" +lib.mkEnableOption (lib.mdDoc "magic") # is like lib.mkOption { type = lib.types.bool; @@ -188,7 +188,7 @@ mkPackageOption pkgs "name" { default = [ "path" "in&qu </para> <anchor xml:id="ex-options-declarations-util-mkPackageOption-hello" /> <programlisting language="nix"> -lib.mkPackageOption pkgs "hello" { } +lib.mkPackageOptionMD pkgs "hello" { } # is like lib.mkOption { type = lib.types.package; @@ -199,7 +199,7 @@ lib.mkOption { </programlisting> <anchor xml:id="ex-options-declarations-util-mkPackageOption-ghc" /> <programlisting language="nix"> -lib.mkPackageOption pkgs "GHC" { +lib.mkPackageOptionMD pkgs "GHC" { default = [ "ghc" ]; example = "pkgs.haskell.packages.ghc92.ghc.withPackages (hkgs: [ hkgs.primes ])"; } |