From 0513b31f73084c1483e8d6c01f2e96c8079b1ec0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= <ludo@gnu.org>
Date: Sat, 29 Jan 2011 23:07:02 +0000
Subject: [PATCH] Improve the documentation of `generationsDir'.

svn path=/nixos/trunk/; revision=25718
---
 .../installer/generations-dir/generations-dir.nix  | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/modules/installer/generations-dir/generations-dir.nix b/modules/installer/generations-dir/generations-dir.nix
index a56dd6a19ff..db9fa32c55a 100644
--- a/modules/installer/generations-dir/generations-dir.nix
+++ b/modules/installer/generations-dir/generations-dir.nix
@@ -12,8 +12,18 @@ let
           enable = mkOption {
             default = false;
             description = ''
-              Whether to enable the simple preparation of symlinks to the system
-              generations in /boot.
+              Whether to create symlinks to the system generations under
+              <literal>/boot</literal>.  When enabled,
+              <literal>/boot/default/kernel</literal>,
+              <literal>/boot/default/initrd</literal>, etc., are updated to
+              point to the current generation's kernel image, initial RAM
+              disk, and other bootstrap files.
+
+              This optional is not necessary with bootloads such as GNU GRUB
+              for which the menu is updated to point to the latest bootstrap
+              files.  However, it is needed for U-Boot on platforms where the
+              boot command line is stored in flash memory rather than in a
+              menu file.
             '';
           };