go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/exec/doc.go (about)

     1  // Copyright 2023 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package exec is intended to be a drop-in replacement for "os/exec"
    16  // which can be mocked.
    17  //
    18  // See the docs in `go.chromium.org/luci/common/exec/execmock` for information
    19  // on how mocking exec works.
    20  //
    21  // NOTE: `Command` now takes a context; this context will only be used for
    22  // the purpose of mocking, but still allows you to make a Command which is not
    23  // bound to the lifetime of the context (i.e. will not be automatically killed
    24  // when the context is Done()).
    25  package exec