01/09: doc: Clarify instructions for hibernation on a swap file.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit 7d1d5e16da6f1b37b3e0c16adf44b8e305e1e5db
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Fri May 19 17:04:06 2023 +0200

    doc: Clarify instructions for hibernation on a swap file.
    
    Fixes <https://issues.guix.gnu.org/62711>.
    
    * doc/guix.texi (Swap Space): Change 'resume' argument to a device in
    example; add comments.  Update sentence describing 'resume' and
    'resume_offset'.
---
 doc/guix.texi | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index b40870f42b..f4cca66d76 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -17580,14 +17580,15 @@ hibernation via the @code{resume} kernel argument
                             file-systems)))))
 
 (kernel-arguments
-  (cons* "resume=/swapfile"
-         "resume_offset=92514304"
+  (cons* "resume=/dev/sda3"        ;device that holds /swapfile
+         "resume_offset=92514304"  ;offset of /swapfile on device
          %default-kernel-arguments))
 @end lisp
 
 This other snippet of @code{operating-system} enables the swap file
-@file{/swapfile} for hibernation by telling the kernel about the file
-(@code{resume} argument) and its offset on disk (@code{resume_offset}
+@file{/swapfile} for hibernation by telling the kernel about the
+partition containing it
+(@code{resume} argument) and its offset on that partition (@code{resume_offset}
 argument).  The latter value can be found in the output of the command
 @command{filefrag -e} as the first number right under the
 @code{physical_offset} column header (the second command extracts its