From: Patrick Mézard <patrick@mezard.eu>
Date: Sun, 23 Feb 2014 20:53:02 +0000 (-0800)
Subject: os/exec: explicitly mention Cmd.Wait() has to be called eventually
X-Git-Tag: go1.3beta1~627
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=d4b6a198b3b44c8c9617c72ceca9c32ba089b5a8;p=gostls13.git

os/exec: explicitly mention Cmd.Wait() has to be called eventually

LGTM=minux.ma, r
R=golang-codereviews, minux.ma, r
CC=golang-codereviews
https://golang.org/cl/67280043
---

diff --git a/src/pkg/os/exec/exec.go b/src/pkg/os/exec/exec.go
index 4680036fdd..d2cee03fcd 100644
--- a/src/pkg/os/exec/exec.go
+++ b/src/pkg/os/exec/exec.go
@@ -238,6 +238,9 @@ func (c *Cmd) Run() error {
 }
 
 // Start starts the specified command but does not wait for it to complete.
+//
+// The Wait method will return the exit code and release associated resources
+// once the command exits.
 func (c *Cmd) Start() error {
 	if c.lookPathErr != nil {
 		c.closeDescriptors(c.closeAfterStart)
@@ -304,6 +307,8 @@ func (e *ExitError) Error() string {
 // If the command fails to run or doesn't complete successfully, the
 // error is of type *ExitError. Other error types may be
 // returned for I/O problems.
+//
+// Wait releases any resources associated with the Cmd.
 func (c *Cmd) Wait() error {
 	if c.Process == nil {
 		return errors.New("exec: not started")