Merge pull request #1754 from hashicorp/child-exit-ch-comment

Add a comment to clarify the usage of child.ExitCh()
hashicorp · May 29, 2023 · e97a929 · e97a929
2 parents a926131 + 62ccc06
commit e97a929
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/child/child.go b/child/child.go
@@ -175,7 +175,8 @@ func New(i *NewInput) (*Child, error) {
 
 // ExitCh returns the current exit channel for this child process. This channel
 // may change if the process is restarted, so implementers must not cache this
-// value.
+// value. To prevent a potential race condition, this function must be invoked
+// strictly after child.Start().
 func (c *Child) ExitCh() <-chan int {
 	c.RLock()
 	defer c.RUnlock()