jiri-dockergo

Documentation

Overview

Executes a Go command in a docker container. This is primarily aimed at the builds of Linux binaries and libraries where there is a dependence on cgo. This allows for compilation (and cross-compilation) without polluting the host filesystem with compilers, C-headers, libraries etc. as dependencies are encapsulated in the docker image.

The docker image is expected to have the appropriate C-compiler and any pre-built headers/libraries to be linked in. It is also expected to have the appropriate environment variables (such as CGO_ENABLED, CGO_CFLAGS etc) set.

Sample usage on *all* platforms (Linux/OS X):

Build the "./foo" package for the host architecture and linux (command works from OS X as well):

jiri-dockergo build

Build for linux/arm from any host (including OS X):

GOARCH=arm jiri-dockergo build

For more information on docker see https://www.docker.com.

For more information on the design of this particular tool including the definitions of default images, see: https://docs.google.com/document/d/1Ud-QUVOjsaya57kgq0j24wDwTzKKE7o_PShQQs0DR5w/edit?usp=sharing

While the targets are built using the toolchain in the docker image, a local Go installation is still required for Vanadium-specific compilation prep work - such as invoking the VDL compiler on packages to generate up-to-date .go files.

Usage:

jiri dockergo [flags] <arg ...>

<arg ...> is a list of arguments for the go tool.

The jiri dockergo flags are:

-color=true
  Use color to format output.
-env=
  specify an environment variable in the form: <var>=[<val>],...
-merge-policies=+CCFLAGS,+CGO_CFLAGS,+CGO_CXXFLAGS,+CGO_LDFLAGS,+CXXFLAGS,GOARCH,GOOS,GOPATH:,^GOROOT*,+LDFLAGS,:PATH,VDLPATH:
  specify policies for merging environment variables
-profiles=v23:base
  a comma separated list of profiles to use
-profiles-db=$JIRI_ROOT/.jiri_root/profile_db
  the path, relative to JIRI_ROOT, that contains the profiles database.
-skip-profiles=false
  if set, no profiles will be used
-target=<runtime.GOARCH>-<runtime.GOOS>
  specifies a profile target in the following form: <arch>-<os>[@<version>]
-v=false
  Print verbose output.

The global flags are:

-extra-ldflags=
  This tool sets some ldflags automatically, e.g. to set binary metadata.  The
  extra-ldflags are appended to the end of those automatically generated
  ldflags.  Note that if your go command line specifies -ldflags explicitly, it
  will override both the automatically generated ldflags as well as the
  extra-ldflags.
-image=
  Name of the docker image to use. If empty, the tool will automatically select
  an image based on the environment variables, possibly edited by the profile
-metadata=<just specify -metadata to activate>
  Displays metadata for the program and exits.
-time=false
  Dump timing information to stderr before exiting the program.