Bug 801273

Summary: Document for set-pgroup need to be updated
Product: Red Hat Enterprise Linux 6 Reporter: Qixiang Wan <qwan>
Component: libguestfsAssignee: Richard W.M. Jones <rjones>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.2CC: leiwang, moli, qguan, yuzhou
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: libguestfs-1.16.10-1.el6 Doc Type: Bug Fix
Doc Text:
No Documentation needed
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-06-20 07:01:08 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Qixiang Wan 2012-03-08 06:19:03 UTC
Description of problem:
As the document says, the default value of pgroup should be "false" because users may want to use "^C" to kill the subprocess.
But now the default value is "true".

Version-Release number of selected component (if applicable):
libguestfs-1.16.8-1.el6.x86_64

How reproducible:
100%

Steps to Reproduce:
1. [root@localhost ~]# guestfish get-pgroup
true
2. [root@localhost ~]# guestfish help set-pgroup
NAME
    set-pgroup - set process group flag

SYNOPSIS
     set-pgroup pgroup

DESCRIPTION
    If "pgroup" is true, child processes are placed into their own process
    group.

    The practical upshot of this is that signals like "SIGINT" (from users
    pressing "^C") won't be received by the child process.

    The default for this flag is false, because usually you want "^C" to
    kill the subprocess.

    You can use 'pgroup' as an alias for this command.

  
Actual results:
$ guestfish get-pgroup
true

Expected results:
$ guestfish get-pgroup
false

Additional info:

Comment 1 Richard W.M. Jones 2012-03-08 10:24:21 UTC
guestfish sets pgroup to true on its own handle, when used
interactively:

https://github.com/libguestfs/libguestfs/blob/4504f424f5589f81086f5250674b55708e162e5f/fish/fish.c#L399

If you access the libguestfs API directly then you'll see
it starts off as false:

$ perl -MSys::Guestfs -e 'printf "%d\n", Sys::Guestfs->new()->get_pgroup()'
0

Probably we just need to clarify the documentation.

Comment 2 Qixiang Wan 2012-03-08 10:54:59 UTC
(In reply to comment #1)
> 
> Probably we just need to clarify the documentation.

That sounds reasonable. Changing the bug subject.

Comment 6 Qixiang Wan 2012-03-15 03:15:49 UTC
Verified with libguestfs-1.16.10-1.el6.

The current document for set-pgroup:

><fs> help set-pgroup
NAME
    set-pgroup - set process group flag

SYNOPSIS
     set-pgroup pgroup

DESCRIPTION
    If "pgroup" is true, child processes are placed into their own process
    group.

    The practical upshot of this is that signals like "SIGINT" (from users
    pressing "^C") won't be received by the child process.

    The default for this flag is false, because usually you want "^C" to
    kill the subprocess. Guestfish sets this flag to true when used
    interactively, so that "^C" can cancel long-running commands gracefully
    (see "user_cancel").

    You can use 'pgroup' as an alias for this command.

Comment 7 Richard W.M. Jones 2012-04-26 12:23:49 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
No Documentation needed

Comment 9 errata-xmlrpc 2012-06-20 07:01:08 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHSA-2012-0774.html