cmd/binapi-generator/doc.go

   1 //  Copyright (c) 2020 Cisco and/or its affiliates.
   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 // Context of Go structs out of the VPP binary API definitions in JSON format.
  16 //
  17 // The JSON input can be specified as a single file (using the `input-file`
  18 // CLI flag), or as a directory that will be scanned for all `.json` files
  19 // (using the `input-dir` CLI flag). The generated Go bindings will  be
  20 // placed into `output-dir` (by default the current working directory),
  21 // where each Go package will be placed into its own separate directory,
  22 // for example:
  23 //
  24 //    binapi-generator --input-file=/usr/share/vpp/api/core/interface.api.json --output-dir=.
  25 //
  26 package main