diff options
| author | pennae <github@quasiparticle.net> | 2022-12-30 21:04:52 +0100 |
|---|---|---|
| committer | pennae <82953136+pennae@users.noreply.github.com> | 2023-01-05 02:33:13 +0100 |
| commit | 9da5f12ecffa60f7a4712516177ede318b608f0d (patch) | |
| tree | d3fb619e32d3088515481304a9f8c08697b23534 /nixos/doc/manual/development | |
| parent | 4c1cfbdb844babe1054c7f365eac337396092d60 (diff) | |
| download | nixpkgs-9da5f12ecffa60f7a4712516177ede318b608f0d.tar nixpkgs-9da5f12ecffa60f7a4712516177ede318b608f0d.tar.gz nixpkgs-9da5f12ecffa60f7a4712516177ede318b608f0d.tar.bz2 nixpkgs-9da5f12ecffa60f7a4712516177ede318b608f0d.tar.lz nixpkgs-9da5f12ecffa60f7a4712516177ede318b608f0d.tar.xz nixpkgs-9da5f12ecffa60f7a4712516177ede318b608f0d.tar.zst nixpkgs-9da5f12ecffa60f7a4712516177ede318b608f0d.zip | |
modules: add mkPackageOptionMD
another transitional option factory, like mkAliasOptionModuleMD.
Diffstat (limited to 'nixos/doc/manual/development')
| -rw-r--r-- | nixos/doc/manual/development/option-declarations.section.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/nixos/doc/manual/development/option-declarations.section.md b/nixos/doc/manual/development/option-declarations.section.md index f89aae57306..aa747f47c9c 100644 --- a/nixos/doc/manual/development/option-declarations.section.md +++ b/nixos/doc/manual/development/option-declarations.section.md @@ -88,7 +88,7 @@ lib.mkOption { } ``` -### `mkPackageOption` {#sec-option-declarations-util-mkPackageOption} +### `mkPackageOption`, `mkPackageOptionMD` {#sec-option-declarations-util-mkPackageOption} Usage: @@ -106,6 +106,8 @@ The second argument is the name of the option, used in the description "The \<na You can omit the default path if the name of the option is also attribute path in nixpkgs. +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 .title} Examples: |