[documentation] Minor fixup.

This commit is contained in:
Ciprian Dorin Craciun 2021-12-22 22:56:39 +02:00
parent 03d52620af
commit fe83a2512f

View file

@ -21,9 +21,11 @@ Installation
Download prebuilt executables Download prebuilt executables
----------------------------- -----------------------------
.. warning :: .. warning ::
No executables are currently available for download! No executables are currently available for download!
Please consult the `build from sources section <#build-from-sources>`__ for now. Please consult the `build from sources section <#build-from-sources>`__ for now.
@ -33,19 +35,24 @@ Build from sources
------------------ ------------------
Install the prerequisites Install the prerequisites
......................... .........................
* Ubuntu / Debian: :: * Ubuntu / Debian: ::
apt-get install git-core apt-get install git-core
apt-get install golang apt-get install golang
* OpenSUSE: :: * OpenSUSE: ::
zypper install git-core zypper install git-core
zypper install go zypper install go
* other Linux / FreeBSD / OpenBSD / OSX: * other Linux / FreeBSD / OpenBSD / OSX:
* fetch and install Go from: https://golang.org/dl * fetch and install Go from: https://golang.org/dl
@ -53,9 +60,12 @@ Install the prerequisites
* install Git; * install Git;
Prepare the environment Prepare the environment
....................... .......................
:: ::
mkdir -- \ mkdir -- \
@ -66,9 +76,12 @@ Prepare the environment
# #
Fetch the sources Fetch the sources
................. .................
Either clone the full Git repository: :: Either clone the full Git repository: ::
git clone \ git clone \
@ -77,6 +90,7 @@ Either clone the full Git repository: ::
/tmp/kawipiko/src \ /tmp/kawipiko/src \
# #
Either fetch and extract the latest sources bundle: :: Either fetch and extract the latest sources bundle: ::
curl \ curl \
@ -93,9 +107,12 @@ Either fetch and extract the latest sources bundle: ::
# #
Build the dynamic executables Build the dynamic executables
............................. .............................
Compile the (dynamic) executables: :: Compile the (dynamic) executables: ::
cd /tmp/kawipiko/src/sources cd /tmp/kawipiko/src/sources
@ -104,8 +121,9 @@ Compile the (dynamic) executables: ::
env \ env \
GOPATH=/tmp/kawipiko/go \ GOPATH=/tmp/kawipiko/go \
go build \ go build \
-ldflags 'all=-s' \
-gcflags 'all=-l=4' \ -gcflags 'all=-l=4' \
-ldflags 'all=-s' \
-trimpath \
-o /tmp/kawipiko/bin/kawipiko \ -o /tmp/kawipiko/bin/kawipiko \
./cmd/wrapper.go \ ./cmd/wrapper.go \
# #
@ -114,8 +132,9 @@ Compile the (dynamic) executables: ::
env \ env \
GOPATH=/tmp/kawipiko/go \ GOPATH=/tmp/kawipiko/go \
go build \ go build \
-ldflags 'all=-s' \
-gcflags 'all=-l=4' \ -gcflags 'all=-l=4' \
-ldflags 'all=-s' \
-trimpath \
-o /tmp/kawipiko/bin/kawipiko-server \ -o /tmp/kawipiko/bin/kawipiko-server \
./cmd/server.go \ ./cmd/server.go \
# #
@ -124,16 +143,20 @@ Compile the (dynamic) executables: ::
env \ env \
GOPATH=/tmp/kawipiko/go \ GOPATH=/tmp/kawipiko/go \
go build \ go build \
-ldflags 'all=-s' \
-gcflags 'all=-l=4' \ -gcflags 'all=-l=4' \
-ldflags 'all=-s' \
-trimpath \
-o /tmp/kawipiko/bin/kawipiko-archiver \ -o /tmp/kawipiko/bin/kawipiko-archiver \
./cmd/archiver.go \ ./cmd/archiver.go \
# #
Build the static executables Build the static executables
............................ ............................
Compile the (static) executables: :: Compile the (static) executables: ::
cd /tmp/kawipiko/src/sources cd /tmp/kawipiko/src/sources
@ -170,16 +193,18 @@ Compile the (static) executables: ::
-gcflags 'all=-l=4' \ -gcflags 'all=-l=4' \
-ldflags 'all=-s' \ -ldflags 'all=-s' \
-trimpath \ -trimpath \
-o /tmp/kawipiko/bin/kawipiko-archiver \
./cmd/archiver.go \ ./cmd/archiver.go \
# #
Deploy the executables Deploy the executables
...................... ......................
(Basically just copy the two executables anywhere on the system, or any compatible remote system.)
:: Just copy the two executables anywhere on the system, or any compatible remote system: ::
cp \ cp \
-t /usr/local/bin \ -t /usr/local/bin \