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

     1  // Copyright 2020 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 ledcli implements the subcommands for the `led` command line tool.
    16  //
    17  // Each file here roughly corresponds to one of the subcommands of `led`. A
    18  // `led` subcommand manipulates a `job definition` object (a proto, see the
    19  // `job` subpackage).
    20  //
    21  // The `get*` subcommands writes a job definition from some external source.
    22  // The `launch` subcommand reads a job definition and launches it in Swarming.
    23  // The `edit*` subcommands reads a job definition, manipulates it, then writes
    24  //
    25  //	the evolved job definition out.
    26  //
    27  // led subcommands are meant to be connected in a UNIX pipeline, starting with
    28  // a 'get' subcommand, and ending with the 'launch' subcommand.
    29  package ledcli