diff options
author | Alyssa Ross <hi@alyssa.is> | 2023-10-12 09:08:12 +0000 |
---|---|---|
committer | Alyssa Ross <hi@alyssa.is> | 2023-10-12 09:08:12 +0000 |
commit | 1bb67a90bad7f80ece76b3166ac7ab05c36304b0 (patch) | |
tree | 7a8c648f62d833a4dafb531ecfa6c9b00efc1e25 /nixos/doc/manual/development | |
parent | b51626e173687365d695e1d2c6769a66753bc00e (diff) | |
parent | df4a0780679e3874984c3cf269278c90f4d2ab9b (diff) |
Merge remote-tracking branch 'origin/master' into staging-next
Conflicts: pkgs/development/python-modules/bambi/default.nix pkgs/development/python-modules/jaxopt/default.nix
Diffstat (limited to 'nixos/doc/manual/development')
-rw-r--r-- | nixos/doc/manual/development/option-declarations.section.md | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/nixos/doc/manual/development/option-declarations.section.md b/nixos/doc/manual/development/option-declarations.section.md index 3448b07722b85..762070416187d 100644 --- a/nixos/doc/manual/development/option-declarations.section.md +++ b/nixos/doc/manual/development/option-declarations.section.md @@ -90,7 +90,7 @@ lib.mkOption { ``` ::: -### `mkPackageOption`, `mkPackageOptionMD` {#sec-option-declarations-util-mkPackageOption} +### `mkPackageOption` {#sec-option-declarations-util-mkPackageOption} Usage: @@ -121,15 +121,13 @@ valid attribute path in pkgs (if name is a list). If you wish to explicitly provide no default, pass `null` as `default`. -During the transition to CommonMark documentation `mkPackageOption` creates an option with a DocBook description attribute, once the transition is completed it will create a CommonMark description instead. `mkPackageOptionMD` always creates an option with a CommonMark description attribute and will be removed some time after the transition is completed. - []{#ex-options-declarations-util-mkPackageOption} Examples: ::: {#ex-options-declarations-util-mkPackageOption-hello .example} ### Simple `mkPackageOption` usage ```nix -lib.mkPackageOptionMD pkgs "hello" { } +lib.mkPackageOption pkgs "hello" { } # is like lib.mkOption { type = lib.types.package; @@ -143,7 +141,7 @@ lib.mkOption { ::: {#ex-options-declarations-util-mkPackageOption-ghc .example} ### `mkPackageOption` with explicit default and example ```nix -lib.mkPackageOptionMD pkgs "GHC" { +lib.mkPackageOption pkgs "GHC" { default = [ "ghc" ]; example = "pkgs.haskell.packages.ghc92.ghc.withPackages (hkgs: [ hkgs.primes ])"; } |