Skip to content

Commit

Permalink
Clarify environment variables set in .profile (istio#919)
Browse files Browse the repository at this point in the history
Automatic merge from submit-queue

Clarify environment variables set in .profile

Fixes (istio#918)

Prior to this small change, the .profile settings were not completely
obvious.  Now all profile settings that Istio should expect to use
are set in one place.

**Release note**:

NONE
  • Loading branch information
Steven Dake authored and istio-merge-robot committed Sep 25, 2017
1 parent 402061e commit 977a1af
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions devel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ branch, but release branches should not change.
- [Setting up Go](#setting-up-go)
- [Setting up Bazel](#setting-up-bazel)
- [Setting up Docker](#setting-up-docker)
- [Setting up environment variables](#setting-up-environment-variables)
- [Setting up personal access token](#setting-up-a-personal-access-token)
- [Git workflow](#git-workflow)
- [Fork the main repository](#fork-the-main-repository)
Expand Down Expand Up @@ -62,14 +63,6 @@ Mixer require Go version 1.8. If you haven't set up a Go development
environment, please follow [these instructions](https://golang.org/doc/install)
to install the Go tools.

Set up your GOPATH and add a path entry for Go binaries to your PATH. Typically
added to your ~/.profile:

```shell
export GOPATH=~/go
export PATH=$PATH:$GOPATH/bin
```

### Setting up Bazel

Istio components are built using the Bazel build system. See
Expand All @@ -84,6 +77,27 @@ To run some of Istio's examples and tests, you need to set up Docker server.
Please follow [these instructions](https://docs.docker.com/engine/installation/)
for how to do this for your platform.

### Setting up environment variables

Set up your GOPATH, add a path entry for Go binaries to your PATH, set the ISTIO
path, and set your GITHUB_USER used later in this document. These exports are
typically added to your ~/.profile:

```shell
export GOPATH=~/go
export PATH=$PATH:$GOPATH/bin
export ISTIO=$GOPATH/src/istio.io # eg. ~/go/src/istio.io

# Replace "$GITHUB_USER" below with your github username
export GITHUB_USER=$USER # replace with actual if different
```

Execute a one time operation to contain the Istio source trees.

```shell
mkdir -p $ISTIO
```

### Setting up a personal access token

This is only necessary for core contributors / to push changes to the main repos.
Expand Down Expand Up @@ -116,12 +130,7 @@ Mixer's code into your GOPATH. Note: the commands below will not work if
there is more than one directory in your `$GOPATH`.

```shell
export ISTIO=$GOPATH/src/istio.io # eg. ~/go/src/istio.io
mkdir -p $ISTIO
cd $ISTIO

# Replace "$GITHUB_USER" below with your github username
export GITHUB_USER=$USER # replace with actual if different
git clone https://github.com/$GITHUB_USER/mixer.git
cd mixer
git remote add upstream 'https://github.com/istio/mixer.git'
Expand Down

0 comments on commit 977a1af

Please sign in to comment.