brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From geom...@apache.org
Subject [3/4] brooklyn-client git commit: code review
Date Tue, 25 Apr 2017 08:10:30 GMT
code review


Project: http://git-wip-us.apache.org/repos/asf/brooklyn-client/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-client/commit/b6657c7a
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-client/tree/b6657c7a
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-client/diff/b6657c7a

Branch: refs/heads/master
Commit: b6657c7ae4595faf4088778468343f33cb9a754c
Parents: 1e0268d
Author: Alex Heneveld <alex.heneveld@cloudsoftcorp.com>
Authored: Mon Apr 24 13:30:40 2017 +0100
Committer: Alex Heneveld <alex.heneveld@cloudsoftcorp.com>
Committed: Mon Apr 24 13:30:40 2017 +0100

----------------------------------------------------------------------
 cli/README.md | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-client/blob/b6657c7a/cli/README.md
----------------------------------------------------------------------
diff --git a/cli/README.md b/cli/README.md
index 4039061..532711a 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -24,21 +24,28 @@ Optional:
 
 Go is very particular about the layout of a source tree and the source repository, 
 as it relies on this in the naming of packages.  
-Developers familiar with [`$GOPATH`](http://golang.org/cmd/go/#hdr-GOPATH_environment_variable)
-- or on OS's that don't support soft links --
-may prefer to `go get github.com/apache/brooklyn-client/cli/br` and
-run github commands (branching and adding remote forks) in the that subdir
-under `$GOPATH/src`. However for new users we recommend the instructions here
-setting up Go to work against a normal checked-out project (not under the `GOPATH`).
 
-First ensure that your `GOPATH` is set, for example:
+If you're familiar with Go and just want to develop the `br` tool itself you may simply work
in your usual `GOPATH`, 
+using `go get github.com/apache/brooklyn-client/cli/br` and adding your own fork as a remote.

+If you know `glide` then you probably know what to do and can ignore these instructions;
+`br` is built just like any other Go project. 
+
+If you're new to Go and you want to work on the CLI alongside non-Go components in Apache
Brooklyn,
+then the common Go setup -- where code lives under the `GOPATH` -- may be tedious to work
with.
+A good pattern is to have the requisite `GOPATH` entry linking to the `brooklyn-client` project
+elsewhere on disk, so you have just one copy in the usual space and there is no need to touch
the `GOPATH` thereafter.
+This is the recommended default described by the instructions below.
+
+First ensure that a `GOPATH` is set; this is where Go will store its files. 
+`~/go` is the default, and `~/.go` is acceptable also. For example:
 
 ```bash
 export GOPATH=$HOME/go
 ```
 
-These instructions assume you have `brooklyn-client` checked out and are
+These instructions now assume that you have `brooklyn-client` checked out and are
 in the `cli` subdirectory, where this file resides. 
-Tell Go to use this checked-out folder by linking to it under `GOPATH`:
+Tell Go to use this checked-out project by linking to it under `GOPATH`:
 
 ```bash
 rm -rf $GOPATH/src/github.com/apache/brooklyn-client


Mime
View raw message