diff options
author | Silvan Mosberger <contact@infinisil.com> | 2023-10-12 03:27:21 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-10-12 03:27:21 +0200 |
commit | 2f01d2020296ffa207897c17f7227bc86eb11851 (patch) | |
tree | 63286538f3bb8663a365a5d6c56ac83dabb1e36c /nixos/doc/manual/development | |
parent | 249fef3d848e45037eaf9fb2f3e8a8ef8652bfde (diff) | |
parent | afb15c65131fe2912e8bc87e3e6c2a6028ae7bb0 (diff) |
Merge pull request #259927 from asymmetric/no-docbook-in-manual
nixos/manual: no DocBook for mkPackageOption
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 ])"; } |