Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Update build-from-source docs to favor make commands (#21590) 

* docs: add link to Homebrew install for OSX

* docs: remove go command info in favor of make

* docs: update OSX make command installation
pull/21584/head^2
Dane Strandboge 2021-06-02 16:33:40 -05:00 committed by GitHub
parent b928d3bda4
commit c88fc07451
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
CONTRIBUTING.md
View File

@ -117,7 +117,9 @@ You need a recent stable version of Rust. We recommend using [rustup](https://ru
You also need `clang`, `make`, `pkg-config`, and `protobuf` installed.
- OSX: `brew install make pkg-config protobuf`
- OSX: `brew install pkg-config protobuf`
- For OSX, you must have [HomeBrew](https://brew.sh) installed.
- You will also need the [Developer Tools](https://webkit.org/build-tools/), which includes `make`.
- Linux (Arch): `pacman -S clang make pkgconf protobuf`
- Linux (Ubuntu): `sudo apt install make clang pkg-config protobuf-compiler libprotobuf-dev`
- Linux (RHEL): See below
@ -147,40 +149,6 @@ Logs to stdout by default:
$ bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influxd
```
### Building with the go command
The `Makefile` provides a wrapper around configuring the utilities for building influxdb. For those wanting to use the `go` command directly, one of two things can be done.
First, the `env` script is located in the root of the repository. This script can be used to execute `go` commands with the appropriate environment configuration.
```bash
$ ./env go build ./cmd/influxd
```
Another method is to configure the `pkg-config` utility. Follow the instructions [here](https://github.com/influxdata/flux#getting-started) to install and configure `pkg-config` and then the normal go commands will work.
You should have already installed the pkg-config commands when doing the regular 'make' build.
Install the `pkg-config` wrapper utility of the same name to a different path that is earlier in the PATH.
```bash
# Install the pkg-config wrapper utility
$ go build -o ~/go/bin/ github.com/influxdata/pkg-config
# Ensure the GOBIN directory is on your PATH
$ export PATH=$HOME/go/bin:${PATH}
$ which -a pkg-config
/home/user/go/bin/pkg-config
/usr/bin/pkg-config
```
Then all `go` build commands should work.
```bash
$ go build ./cmd/influxd
$ go test ./...
```
### Testing
This project is built from various languages. To run test for all langauges and components use: