branch master updated: doc: Try to clarify the setuid programs examples.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

lfam pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new 6a7945971d doc: Try to clarify the setuid programs examples.
6a7945971d is described below

commit 6a7945971d3721f1b6464c1beebc9b143c2bc24e
Author: Leo Famulari <leo@famulari.name>
AuthorDate: Mon Jan 3 18:06:50 2022 -0500

    doc: Try to clarify the setuid programs examples.
    
    Based on user feedback, the shadow / passwd example was too obscure for 
those
    who aren't familiar with the shadow collection of tools. And it was also
    considered confusing for the two examples to use different packages.
    
    * doc/guix.texi (Setuid Programs): Use 'nmtui' in the examples.
---
 doc/guix.texi | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 9c1f30e83f..dfb94be74e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -34077,22 +34077,23 @@ should be setuid root.
 The @code{setuid-programs} field of an @code{operating-system}
 declaration contains a list of @code{<setuid-program>} denoting the
 names of programs to have a setuid or setgid bit set (@pxref{Using the
-Configuration System}).  For instance, the @command{passwd} program,
-which is part of the Shadow package, with a setuid root can be
+Configuration System}).  For instance, the @command{nmtui} program,
+which is part of the NetworkManager package, with a setuid root can be
 designated like this:
 
 @example
 (setuid-program
-  (program (file-append shadow "/bin/passwd")))
+  (program (file-append network-manager "/bin/nmtui")))
 @end example
 
-And then it can be added to your operating system declaration by
-appending it to @code{%setuid-programs} like this:
+And then, to make @code{nmtui} setuid on your system, add the previous
+example to your operating system declaration by appending it to
+@code{%setuid-programs} like this:
 
 @example
 (setuid-programs
   (append (list (setuid-program
-                  (program (file-append swaylock "/bin/swaylock"))))
+                  (program (file-append network-manager "/bin/nmtui"))))
                 %setuid-programs))
 @end example