From fa479f7a8a0abbc35b7dcffbed2d8853e42b364f Mon Sep 17 00:00:00 2001 From: Dominic Della Valle Date: Wed, 15 May 2019 15:02:31 -0400 Subject: [PATCH] docs+mk: update guidance for unsupported platforms License: MIT Signed-off-by: Dominic Della Valle --- README.md | 7 +++++-- Rules.mk | 5 +++++ docs/openbsd.md | 37 ------------------------------------- 3 files changed, 10 insertions(+), 39 deletions(-) delete mode 100644 docs/openbsd.md diff --git a/README.md b/README.md index e7706770173..11e63a11485 100644 --- a/README.md +++ b/README.md @@ -138,12 +138,15 @@ $ cd go-ipfs $ make install ``` -If you are building on FreeBSD instead of `make install` use `gmake install`. +If you are building on a non-GNU system, use `gmake` in place of `make`. +Unsupported platforms (run `(g)make supported` for a list) will also need to set the `nofuse` gotag during build. +``` +$ GOTAGS=nofuse (g)make install +``` #### Troubleshooting - Separate [instructions are available for building on Windows](docs/windows.md). -- Also, [instructions for OpenBSD](docs/openbsd.md). - `git` is required in order for `go get` to fetch all dependencies. - Package managers often contain out-of-date `golang` packages. Ensure that `go version` reports at least 1.10. See above for how to install go. diff --git a/Rules.mk b/Rules.mk index f4f739365d9..48ec401aa7c 100644 --- a/Rules.mk +++ b/Rules.mk @@ -108,6 +108,11 @@ uninstall: $(GOCC) clean -i ./cmd/ipfs .PHONY: uninstall +supported: + @echo "Currently supported platforms:" + @for p in ${SUPPORTED_PLATFORMS}; do echo $$p; done +.PHONY: supported + help: @echo 'DEPENDENCY TARGETS:' @echo '' diff --git a/docs/openbsd.md b/docs/openbsd.md deleted file mode 100644 index 686061001b2..00000000000 --- a/docs/openbsd.md +++ /dev/null @@ -1,37 +0,0 @@ -# Building on OpenBSD - -## Prepare your system - -Make sure you have `git`, `go` and `gmake` installed on your system. - -``` -$ doas pkg_add -v git go gmake -``` - -## Prepare go environment - -Make sure your gopath is set: - -``` -$ export GOPATH=~/go -$ echo "$GOPATH" -$ export PATH="$PATH:$GOPATH/bin" -``` - -## Build - -The `install_unsupported` target works nicely for openbsd. This will install -`gx`, `gx-go` and run `go install -tags nofuse ./cmd/ipfs`. - -``` -$ go get -v -u -d github.com/ipfs/go-ipfs - -$ cd $GOPATH/src/github.com/ipfs/go-ipfs -$ gmake install_unsupported -``` - -if everything went well, your ipfs binary should be ready at `$GOPATH/bin/ipfs`. - -``` -$ ipfs version -```