code review 92340043: os: document that Interrupt might not work on every os

os: document that Interrupt might not work on every os

Fixes issue 6720.

[brainman, 2014-05-14 07:14:46]

Hello golang-codereviews@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[iant, 2014-05-14 13:09:15]

https://codereview.appspot.com/92340043/diff/40001/src/pkg/os/exec_posix.go
File src/pkg/os/exec_posix.go (right):

https://codereview.appspot.com/92340043/diff/40001/src/pkg/os/exec_posix.go#n...
src/pkg/os/exec_posix.go:15: // the process to exit). Interrupt might not work
on every os.
This is vague.  We just said that Interrupt is defined on every system.  We
didn't say anything about what it means.  When you say that it might not work,
what do you really mean?  If you mean that it doesn't always work with
Process.Signal, then I think we should document that fact with Process.Signal.

[brainman, 2014-05-16 02:54:19]

https://codereview.appspot.com/92340043/diff/40001/src/pkg/os/exec_posix.go
File src/pkg/os/exec_posix.go (right):

https://codereview.appspot.com/92340043/diff/40001/src/pkg/os/exec_posix.go#n...
src/pkg/os/exec_posix.go:15: // the process to exit). Interrupt might not work
on every os.
On 2014/05/14 13:09:15, iant wrote:
> ...  When you say that it might not work,
> what do you really mean? ...

It is impossible to implement that functionality for a general case on windows
(see the issue for details).

> ... I think we should document that fact with Process.Signal.

Agreed. Documented.

[brainman, 2014-05-16 02:54:32]

Hello golang-codereviews@googlegroups.com, iant@golang.org (cc:
golang-codereviews@googlegroups.com),

Please take another look.

[brainman, 2014-05-22 12:13:18]

Ping

[bradfitz, 2014-05-22 16:08:55]

LGTM

https://codereview.appspot.com/92340043/diff/60001/src/pkg/os/doc.go
File src/pkg/os/doc.go (right):

https://codereview.appspot.com/92340043/diff/60001/src/pkg/os/doc.go#newcode49
src/pkg/os/doc.go:49: // Sending Interrupt on windows is not implemented.
I'd capitalize Windows here when it's not a GOOS value.

[brainman, 2014-05-23 02:29:36]

*** Submitted as https://code.google.com/p/go/source/detail?r=e165495e81bf ***

os: document that Interrupt might not work on every os

Fixes issue 6720.

LGTM=bradfitz
R=golang-codereviews, iant, bradfitz
CC=golang-codereviews
https://codereview.appspot.com/92340043

https://codereview.appspot.com/92340043/diff/60001/src/pkg/os/doc.go
File src/pkg/os/doc.go (right):

https://codereview.appspot.com/92340043/diff/60001/src/pkg/os/doc.go#newcode49
src/pkg/os/doc.go:49: // Sending Interrupt on windows is not implemented.
On 2014/05/22 16:08:55, bradfitz wrote:
> I'd capitalize Windows here when it's not a GOOS value.

Done.