blob: 0980385e0e9844e4eabb68cbd2e3dade446b4f1c [file] [log] [blame]
Jiri Simsa3f4e92d2015-03-24 21:26:37 -07001// Copyright 2015 The Vanadium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
Todd Wang0d12d712014-10-06 17:25:41 -07005// This file was auto-generated via go generate.
6// DO NOT UPDATE MANUALLY
7
8/*
Suharsh Sivakumard1cc6e02015-03-16 13:58:49 -07009The build tool tool facilitates interaction with the vanadium build server.
Todd Wang0d12d712014-10-06 17:25:41 -070010
11Usage:
12 build <command>
13
14The build commands are:
Suharsh Sivakumard1cc6e02015-03-16 13:58:49 -070015 build Build vanadium Go packages
Todd Wang0d12d712014-10-06 17:25:41 -070016 help Display help for commands or topics
17Run "build help [command]" for command usage.
18
19The global flags are:
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080020 -alsologtostderr=true
21 log to standard error as well as files
22 -log_backtrace_at=:0
23 when logging hits line file:N, emit a stack trace
24 -log_dir=
25 if non-empty, write log files to this directory
26 -logtostderr=false
27 log to standard error instead of files
28 -max_stack_buf_size=4292608
29 max size in bytes of the buffer to use for logging stack traces
30 -stderrthreshold=2
31 logs at or above this threshold go to stderr
32 -v=0
33 log level for V logs
Jiri Simsa3540e3a2014-12-26 07:54:09 -080034 -vanadium.i18n_catalogue=
35 18n catalogue files to load, comma separated
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080036 -veyron.credentials=
37 directory to use for storing security credentials
Robin Thellend8fea01c2014-12-11 13:48:10 -080038 -veyron.namespace.root=[/ns.dev.v.io:8101]
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080039 local namespace root; can be repeated to provided multiple roots
Jiri Simsae44e74e2015-02-03 16:04:48 -080040 -veyron.proxy=
41 object name of proxy service to use to export services across network
42 boundaries
43 -veyron.tcp.address=
44 address to listen on
Cosmos Nicolaouf016f4a2015-03-24 12:10:26 -070045 -veyron.tcp.protocol=wsh
Jiri Simsae44e74e2015-02-03 16:04:48 -080046 protocol to listen with
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080047 -veyron.vtrace.cache_size=1024
48 The number of vtrace traces to store in memory.
Jiri Simsa7fc22712015-02-03 11:27:02 -080049 -veyron.vtrace.collect_regexp=
50 Spans and annotations that match this regular expression will trigger trace
51 collection.
52 -veyron.vtrace.dump_on_shutdown=true
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080053 If true, dump all stored traces on runtime shutdown.
54 -veyron.vtrace.sample_rate=0
55 Rate (from 0.0 to 1.0) to sample vtrace traces.
56 -vmodule=
57 comma-separated list of pattern=N settings for file-filtered logging
Todd Wang0d12d712014-10-06 17:25:41 -070058
59Build Build
60
Suharsh Sivakumard1cc6e02015-03-16 13:58:49 -070061Build vanadium Go packages using a remote build server. The command collects all
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080062source code files that are not part of the Go standard library that the target
63packages depend on, sends them to a build server, and receives the built
64binaries.
Todd Wang0d12d712014-10-06 17:25:41 -070065
66Usage:
67 build build [flags] <name> <packages>
68
Suharsh Sivakumard1cc6e02015-03-16 13:58:49 -070069<name> is a vanadium object name of a build server <packages> is a list of
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080070packages to build, specified as arguments for each command. The format is
71similar to the go tool. In its simplest form each package is an import path;
Suharsh Sivakumar8646ba62015-03-18 15:22:28 -070072e.g. "v.io/x/ref/cmd/build". A package that ends with "..." does a wildcard
73match against all packages with that prefix.
Todd Wang0d12d712014-10-06 17:25:41 -070074
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080075The build build flags are:
Jiri Simsa6cb0d942015-03-11 21:33:26 -070076 -arch=${GOARCH}
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080077 Target architecture.
Jiri Simsa6cb0d942015-03-11 21:33:26 -070078 -os=${GOOS}
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080079 Target operating system.
Todd Wang0d12d712014-10-06 17:25:41 -070080
81Build Help
82
83Help with no args displays the usage of the parent command.
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080084
Todd Wang0d12d712014-10-06 17:25:41 -070085Help with args displays the usage of the specified sub-command or help topic.
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080086
Todd Wang0d12d712014-10-06 17:25:41 -070087"help ..." recursively displays help for all commands and topics.
88
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -080089The output is formatted to a target width in runes. The target width is
90determined by checking the environment variable CMDLINE_WIDTH, falling back on
91the terminal width from the OS, falling back on 80 chars. By setting
92CMDLINE_WIDTH=x, if x > 0 the width is x, if x < 0 the width is unlimited, and
93if x == 0 or is unset one of the fallbacks is used.
94
Todd Wang0d12d712014-10-06 17:25:41 -070095Usage:
96 build help [flags] [command/topic ...]
97
98[command/topic ...] optionally identifies a specific sub-command or help topic.
99
Cosmos Nicolaoud83b90b2014-11-30 15:01:31 -0800100The build help flags are:
Jiri Simsae8a44a22015-03-13 17:35:39 -0700101 -style=default
102 The formatting style for help output, either "default" or "godoc".
Todd Wang0d12d712014-10-06 17:25:41 -0700103*/
104package main