Patchwork One more patch: doc: Add details to the 'guix system switch-generation' section.

login
register
mail settings
Submitter Chris Marusich
Date Nov. 3, 2016, 4:51 a.m.
Message ID <8737j9dv2r.fsf_-_@gmail.com>
Download mbox | patch
Permalink /patch/17141/
State New
Headers show

Comments

Chris Marusich - Nov. 3, 2016, 4:51 a.m.
Hi,

I realized I forgot to include some info in the manual, so here's one
more patch to add the missing info.

Thank you,

Patch

From faee634b5ae6a3033671e6bca07fc5ed1bc699c8 Mon Sep 17 00:00:00 2001
From: Chris Marusich <cmmarusich@gmail.com>
Date: Wed, 2 Nov 2016 20:38:26 -0700
Subject: [PATCH] doc: Add details to the 'guix system switch-generation'
 section.

* doc/guix.texi (Invoking guix system) <switch-generation>: Mention the fact
that we also switch the profile to an existing generation (i.e., flip
symlinks), and that we do it atomically.
---
 doc/guix.texi | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index fbcf3b0..b8cb01f 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -11180,11 +11180,12 @@  once @command{reconfigure} has completed.
 @end quotation
 
 @item switch-generation
-Switch to an existing system generation.  This action rearranges the
-existing GRUB menu entries.  It makes the menu entry for the target
-system generation the default, and it moves the entries for the other
-system generations to a submenu.  The next time the system boots, it
-will use the specified system generation.
+Switch to an existing system generation.  This action atomically
+switches the system profile to the specified system generation.  It also
+rearranges the system's existing GRUB menu entries.  It makes the menu
+entry for the specified system generation the default, and it moves the
+entries for the other generations to a submenu.  The next time the
+system boots, it will use the specified system generation.
 
 The target generation can be specified explicitly by its generation
 number.  For example, the following invocation would switch to system
@@ -11205,11 +11206,12 @@  prevent it from being parsed as an option.  For example:
 guix system switch-generation -- -1
 @end example
 
-Currently, the effect of invoking this action is only to rearrange the
-GRUB menu entries.  To actually start using the target system
-generation, you must reboot after running this action.  In the future,
-it will be updated to do the same things as @command{reconfigure}, like
-activating and deactivating services.
+Currently, the effect of invoking this action is @emph{only} to switch
+the system profile to an existing generation and rearrange the GRUB menu
+entries.  To actually start using the target system generation, you must
+reboot after running this action.  In the future, it will be updated to
+do the same things as @command{reconfigure}, like activating and
+deactivating services.
 
 This action will fail if the specified generation does not exist.
 
-- 
2.10.2