literalExample -> literalExpression

modules/home-environment.nix

@@ -115,7 +115,7 @@ let
           if versionAtLeast config.home.stateVersion "19.09"
           then null
           else "us";
-        defaultText = literalExample "null";
+        defaultText = literalExpression "null";
         description = ''
           Keyboard layout. If <literal>null</literal>, then the system
           configuration will be used.
@@ -149,7 +149,7 @@ let
           if versionAtLeast config.home.stateVersion "19.09"
           then null
           else "";
-        defaultText = literalExample "null";
+        defaultText = literalExpression "null";
         example = "colemak";
         description = ''
           X keyboard variant. If <literal>null</literal>, then the
@@ -182,7 +182,7 @@ in
   options = {
     home.username = mkOption {
       type = types.str;
-      defaultText = literalExample ''
+      defaultText = literalExpression ''
         "$USER"   for state version < 20.09,
         undefined for state version ≥ 20.09
       '';
@@ -192,7 +192,7 @@ in
 
     home.homeDirectory = mkOption {
       type = types.path;
-      defaultText = literalExample ''
+      defaultText = literalExpression ''
         "$HOME"   for state version < 20.09,
         undefined for state version ≥ 20.09
       '';
@@ -321,7 +321,7 @@ in
     home.activation = mkOption {
       type = hm.types.dagOf types.str;
       default = {};
-      example = literalExample ''
+      example = literalExpression ''
         {
           myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] '''
             $DRY_RUN_CMD ln -s $VERBOSE_ARG \

modules/i18n/input-method/fcitx.nix

@@ -17,7 +17,7 @@ in {
       engines = mkOption {
         type = with types; listOf fcitxEngine;
         default = [ ];
-        example = literalExample "with pkgs.fcitx-engines; [ mozc hangul ]";
+        example = literalExpression "with pkgs.fcitx-engines; [ mozc hangul ]";
         description = let
           enginesDrv = filterAttrs (const isDerivation) pkgs.fcitx-engines;
           engines = concatStringsSep ", "

modules/i18n/input-method/fcitx5.nix

@@ -12,7 +12,7 @@ in {
       addons = mkOption {
         type = with types; listOf package;
         default = [ ];
-        example = literalExample "with pkgs; [ fcitx5-rime ]";
+        example = literalExpression "with pkgs; [ fcitx5-rime ]";
         description = ''
           Enabled Fcitx5 addons.
         '';

modules/i18n/input-method/kime.nix

@@ -9,7 +9,7 @@ in {
       config = mkOption {
         type = yamlFormat.type;
         default = { };
-        example = literalExample ''
+        example = literalExpression ''
           {
             daemon = {
               modules = ["Xim" "Indicator"];

modules/lib/file-type.nix

@@ -21,7 +21,7 @@ with lib;
               absPath = if hasPrefix "/" p then p else "${basePath}/${p}";
             in
               removePrefix (homeDirectory + "/") absPath;
-          defaultText = literalExample "<name>";
+          defaultText = literalExpression "<name>";
           description = ''
             Path to target file relative to ${basePathDesc}.
           '';

modules/lib/stdlib-extended.nix

@@ -4,4 +4,10 @@
 nixpkgsLib:
 
 let mkHmLib = import ./.;
-in nixpkgsLib.extend (self: super: { hm = mkHmLib { lib = super; }; })
+in nixpkgsLib.extend (self: super: {
+  hm = mkHmLib { lib = self; };
+
+  # For forward compatibility.
+  literalExpression = super.literalExpression or super.literalExample;
+  literalDocBook = super.literalDocBook or super.literalExample;
+})

modules/lib/types.nix

@@ -37,7 +37,7 @@ in rec {
       package = mkOption {
         type = types.nullOr types.package;
         default = null;
-        example = literalExample "pkgs.dejavu_fonts";
+        example = literalExpression "pkgs.dejavu_fonts";
         description = ''
           Package providing the font. This package will be installed
           to your profile. If <literal>null</literal> then the font

modules/misc/dconf.nix

@@ -27,7 +27,7 @@ in {
       settings = mkOption {
         type = with types; attrsOf (attrsOf hm.types.gvariant);
         default = { };
-        example = literalExample ''
+        example = literalExpression ''
           {
             "org/gnome/calculator" = {
               button-mode = "programming";

modules/misc/gtk.nix

@@ -33,7 +33,7 @@ let
       package = mkOption {
         type = types.nullOr types.package;
         default = null;
-        example = literalExample "pkgs.gnome.gnome_themes_standard";
+        example = literalExpression "pkgs.gnome.gnome_themes_standard";
         description = ''
           Package providing the theme. This package will be installed
           to your profile. If <literal>null</literal> then the theme
@@ -97,9 +97,9 @@ in {
           type = types.path;
           default = "${config.home.homeDirectory}/.gtkrc-2.0";
           defaultText =
-            literalExample ''"''${config.home.homeDirectory}/.gtkrc-2.0"'';
+            literalExpression ''"''${config.home.homeDirectory}/.gtkrc-2.0"'';
           example =
-            literalExample ''"''${config.xdg.configHome}/gtk-2.0/gtkrc"'';
+            literalExpression ''"''${config.xdg.configHome}/gtk-2.0/gtkrc"'';
           description = ''
             The location to put the GTK configuration file.
           '';

modules/misc/nixpkgs.nix

@@ -78,7 +78,7 @@ in {
 
     overlays = mkOption {
       default = null;
-      example = literalExample ''
+      example = literalExpression ''
         [ (self: super: {
             openssh = super.openssh.override {
               hpnSupport = true;

modules/misc/qt.nix

@@ -78,7 +78,7 @@ in {
         package = mkOption {
           type = types.nullOr types.package;
           default = null;
-          example = literalExample "pkgs.adwaita-qt";
+          example = literalExpression "pkgs.adwaita-qt";
           description = "Theme package to be used in Qt5 applications.";
         };
       };

modules/misc/xdg-desktop-entries.nix

@@ -105,7 +105,7 @@ let
           This may override other values.
         '';
         default = { };
-        example = literalExample ''
+        example = literalExpression ''
           {
             Keywords = "calc;math";
             DBusActivatable = "false";
@@ -157,7 +157,7 @@ in {
     '';
     default = { };
     type = types.attrsOf (types.submodule desktopEntry);
-    example = literalExample ''
+    example = literalExpression ''
       {
         firefox = {
           name = "Firefox";

modules/misc/xdg-mime-apps.nix

@@ -30,7 +30,7 @@ in {
     associations.added = mkOption {
       type = types.attrsOf strListOrSingleton;
       default = { };
-      example = literalExample ''
+      example = literalExpression ''
         {
           "mimetype1" = [ "foo1.desktop" "foo2.desktop" "foo3.desktop" ];
           "mimetype2" = "foo4.desktop";
@@ -57,7 +57,7 @@ in {
     defaultApplications = mkOption {
       type = types.attrsOf strListOrSingleton;
       default = { };
-      example = literalExample ''
+      example = literalExpression ''
         {
           "mimetype1" = [ "default1.desktop" "default2.desktop" ];
         }

modules/misc/xdg-mime.nix

@@ -12,7 +12,7 @@ in {
       type = types.bool;
       default = pkgs.hostPlatform.isLinux;
       defaultText =
-        literalExample "true if host platform is Linux, false otherwise";
+        literalExpression "true if host platform is Linux, false otherwise";
       description = ''
         Whether to install programs and files to support the
         XDG Shared MIME-info specification and XDG MIME Applications

modules/misc/xdg-system-dirs.nix

@@ -17,7 +17,7 @@ in {
     config = mkOption {
       type = types.listOf types.str;
       default = [ ];
-      example = literalExample ''[ "/etc/xdg" ]'';
+      example = literalExpression ''[ "/etc/xdg" ]'';
       description = ''
         Directory names to add to <envar>XDG_CONFIG_DIRS</envar>
         in the user session.
@@ -27,7 +27,7 @@ in {
     data = mkOption {
       type = types.listOf types.str;
       default = [ ];
-      example = literalExample ''[ "/usr/share" "/usr/local/share" ]'';
+      example = literalExpression ''[ "/usr/share" "/usr/local/share" ]'';
       description = ''
         Directory names to add to <envar>XDG_DATA_DIRS</envar>
         in the user session.

modules/programs/alacritty.nix

@@ -13,14 +13,14 @@ in {
       package = mkOption {
         type = types.package;
         default = pkgs.alacritty;
-        defaultText = literalExample "pkgs.alacritty";
+        defaultText = literalExpression "pkgs.alacritty";
         description = "The Alacritty package to install.";
       };
 
       settings = mkOption {
         type = yamlFormat.type;
         default = { };
-        example = literalExample ''
+        example = literalExpression ''
           {
             window.dimensions = {
               lines = 3;

modules/programs/alot-accounts.nix

@@ -25,7 +25,7 @@ with lib;
           + "}[,\\]]?'";
         shellcommand_external_filtering = "False";
       };
-      example = literalExample ''
+      example = literalExpression ''
         {
           type = "shellcommand";
           command = "abook --mutt-query";

modules/programs/alot.nix

@@ -200,7 +200,7 @@ in {
           handle_mouse = true;
           prefer_plaintext = true;
         };
-        example = literalExample ''
+        example = literalExpression ''
           {
             auto_remove_unread = true;
             ask_subject = false;

modules/programs/aria2.nix

@@ -31,7 +31,7 @@ in {
         </citerefentry>
         for options.
       '';
-      example = literalExample ''
+      example = literalExpression ''
         {
           listen-port = 60000;
           dht-listen-port = 60000;

modules/programs/astroid.nix

@@ -93,7 +93,7 @@ in {
       extraConfig = mkOption {
         type = jsonFormat.type;
         default = { };
-        example = literalExample ''
+        example = literalExpression ''
           {
             poll.interval = 0;
           }

modules/programs/atuin.nix

@@ -17,7 +17,7 @@ in {
     package = mkOption {
       type = types.package;
       default = pkgs.atuin;
-      defaultText = literalExample "pkgs.atuin";
+      defaultText = literalExpression "pkgs.atuin";
       description = "The package to use for atuin.";
     };
 
@@ -50,7 +50,7 @@ in {
           entries = entryOrAttrsOf (entryOrAttrsOf entry);
         in attrsOf entries // { description = "Atuin configuration"; };
       default = { };
-      example = literalExample ''
+      example = literalExpression ''
         {
           auto_sync = true;
           sync_frequency = "5m";

modules/programs/autorandr.nix

@@ -106,7 +106,7 @@ let
       transform = mkOption {
         type = types.nullOr (matrixOf 3 3 types.float);
         default = null;
-        example = literalExample ''
+        example = literalExpression ''
           [
             [ 0.6 0.0 0.0 ]
             [ 0.0 0.6 0.0 ]
@@ -169,7 +169,7 @@ let
           exclusive.
         '';
         default = null;
-        example = literalExample ''
+        example = literalExpression ''
           {
             x = 1.25;
             y = 1.25;
@@ -280,7 +280,7 @@ in {
         type = globalHooksModule;
         description = "Global hook scripts";
         default = { };
-        example = literalExample ''
+        example = literalExpression ''
           {
             postswitch = {
               "notify-i3" = "''${pkgs.i3}/bin/i3-msg restart";
@@ -312,7 +312,7 @@ in {
         type = types.attrsOf profileModule;
         description = "Autorandr profiles specification.";
         default = { };
-        example = literalExample ''
+        example = literalExpression ''
           {
             "work" = {
               fingerprint = {

modules/programs/bash.nix

@@ -97,7 +97,7 @@ in
       shellAliases = mkOption {
         default = {};
         type = types.attrsOf types.str;
-        example = literalExample ''
+        example = literalExpression ''
           {
             ll = "ls -l";
             ".." = "cd ..";

modules/programs/bat.nix

@@ -33,7 +33,7 @@ in {
     themes = mkOption {
       type = types.attrsOf types.lines;
       default = { };
-      example = literalExample ''
+      example = literalExpression ''
         {
           dracula = builtins.readFile (pkgs.fetchFromGitHub {
             owner = "dracula";

modules/programs/beets.nix

@@ -31,9 +31,9 @@ in {
       package = mkOption {
         type = types.package;
         default = pkgs.beets;
-        defaultText = literalExample "pkgs.beets";
+        defaultText = literalExpression "pkgs.beets";
         example =
-          literalExample "(pkgs.beets.override { enableCheck = true; })";
+          literalExpression "(pkgs.beets.override { enableCheck = true; })";
         description = ''
           The <literal>beets</literal> package to use.
           Can be used to specify extensions.

modules/programs/bottom.nix

@@ -23,7 +23,7 @@ in {
       package = mkOption {
         type = types.package;
         default = pkgs.bottom;
-        defaultText = literalExample "pkgs.bottom";
+        defaultText = literalExpression "pkgs.bottom";
         description = "Package providing <command>bottom</command>.";
       };
 
@@ -38,7 +38,7 @@ in {
           See <link xlink:href="https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml"/>
           for the default configuration.
         '';
-        example = literalExample ''
+        example = literalExpression ''
           {
             flags = {
               avg_cpu = true;

modules/programs/broot.nix

@@ -67,7 +67,7 @@ in {
           execution = "less {file}";
         }
       ];
-      example = literalExample ''
+      example = literalExpression ''
         [
           { invocation = "p"; execution = ":parent"; }
           { invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; }
@@ -124,14 +124,14 @@ in {
     package = mkOption {
       type = types.package;
       default = pkgs.broot;
-      defaultText = literalExample "pkgs.broot";
+      defaultText = literalExpression "pkgs.broot";
       description = "Package providing broot";
     };
 
     skin = mkOption {
       type = types.attrsOf types.str;
       default = { };
-      example = literalExample ''
+      example = literalExpression ''
         {
           status_normal_fg = "grayscale(18)";
           status_normal_bg = "grayscale(3)";