[Nix-dev] [PATCH 2/2] Eelco Dolstra and Nicolas Pierron both kept asking me to pay attention to the rendered manual. There is one catch: example settings such as pkgs.kernelPackages_2_6_25 are correct however they don't render properly. Moreover you don't want those examples to be evaluated (maybe compiling a kernel ?) when building the manual only. So use Strings and add a copy & paste note. This is still a hacky. Maybe a kind of typed "verbatim" expression should be added (?)

Marc Weber marco-oweber at gmx.de
Thu Jan 7 04:06:44 CET 2010


---
 .../services/web-servers/apache-httpd/default.nix  |    2 ++
 modules/system/boot/kernel.nix                     |    6 +++++-
 2 files changed, 7 insertions(+), 1 deletions(-)

diff --git a/modules/services/web-servers/apache-httpd/default.nix b/modules/services/web-servers/apache-httpd/default.nix
index bd0172d..cb37d79 100644
--- a/modules/services/web-servers/apache-httpd/default.nix
+++ b/modules/services/web-servers/apache-httpd/default.nix
@@ -471,6 +471,8 @@ in
          '';
 
         example = ''
+        Example code (copy & paste):
+
          phpIni =  pkgs.phpIniBuilder.override {
             appendLines = '''
              sendmail_path = sendmail -t -i
diff --git a/modules/system/boot/kernel.nix b/modules/system/boot/kernel.nix
index 60bc47c..ea93f86 100644
--- a/modules/system/boot/kernel.nix
+++ b/modules/system/boot/kernel.nix
@@ -12,7 +12,11 @@ let kernel = config.boot.kernelPackages.kernel; in
   
     boot.kernelPackages = mkOption {
       default = pkgs.kernelPackages;
-      example = pkgs.kernelPackages_2_6_25;
+      example = ''
+        Example code (copy & paste):
+        pkgs.kernelPackages_2_6_25
+      '';
+
       description = ''
         This option allows you to override the Linux kernel used by
         NixOS.  Since things like external kernel module packages are
-- 
1.6.5.6




More information about the nix-dev mailing list