From 3e719a63b4bbae57d774c34e6c8cff882a328e14 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Tue, 16 Jan 2018 10:50:11 +0100 Subject: Only one location for dependencies install instructions. Signed-off-by: Sebastien Douheret --- docs/part-2/0_Abstract.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ docs/part-2/1_xds-server.md | 34 +++++++++------------------------- docs/part-2/2_xds-agent.md | 29 +++-------------------------- docs/part-2/3_xds-cli.md | 6 +++--- docs/part-2/4_xds-gdb.md | 6 +++--- 5 files changed, 63 insertions(+), 57 deletions(-) diff --git a/docs/part-2/0_Abstract.md b/docs/part-2/0_Abstract.md index 45f5f40..aa7ddc4 100644 --- a/docs/part-2/0_Abstract.md +++ b/docs/part-2/0_Abstract.md @@ -4,3 +4,48 @@ This 2nd part is the "technical" documentation of all XDS pieces/tools that allows for example to fine tune XDS configuration or rebuild all XDS tools from scratch. + +## Prerequisites + +To build xds binaries you need to install first [Go](https://golang.org/doc/install) version 1.8.1 or higher and some other tools. To build `xds-server` and `xds-agent` +you also need to install in addition `nodejs`. + +**Ubuntu:** + +```bash +# Install various tools +sudo apt-get install git make npm curl git zip unzip + +# Install Go +source /etc/os-release +wget -O- "http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x52B59B1571A79DBC054901C0F6BC817356A3D45E" | sudo apt-key add - +sudo bash -c "cat >> /etc/apt/sources.list.d/golang.list <**Note:** for Ubuntu, you can use a PPA, see [https://github.com/golang/go/wiki/Ubuntu](https://github.com/golang/go/wiki/Ubuntu) - -Install [npm](https://www.npmjs.com/), [nodejs](https://nodejs.org/en/) and -some other tools - -Ubuntu: - -```bash - sudo apt-get install golang npm curl git zip unzip - sudo npm install --global n @angular/cli # Angular Command Line Interface - # Install LTS version of nodejs - sudo n lts -``` - -openSUSE: - -```bash - sudo zypper install go npm git curl zip unzip - sudo npm install --global n @angular/cli # Angular Command Line Interface - # Install LTS version of nodejs - sudo n lts -``` - -Don't forget to open new user session after installing the packages. +Install [Go](https://golang.org/doc/install), [npm](https://www.npmjs.com/), +[nodejs](https://nodejs.org/en/) and some other tools. +Refer to [Prerequisites chapter](./0_Abstract.html#prerequisites) for more details. ### Building diff --git a/docs/part-2/3_xds-cli.md b/docs/part-2/3_xds-cli.md index 3820b22..a4ccca5 100644 --- a/docs/part-2/3_xds-cli.md +++ b/docs/part-2/3_xds-cli.md @@ -165,10 +165,10 @@ xds-cli misc sts ## How to build -### Prerequisites +### Dependencies - You must install and setup [Go](https://golang.org/doc/install) version 1.8.1 or - higher to compile this tool. +Install [Go](https://golang.org/doc/install) and some other tools. +Refer to [Prerequisites chapter](./0_Abstract.html#prerequisites) for more details. ### Building diff --git a/docs/part-2/4_xds-gdb.md b/docs/part-2/4_xds-gdb.md index 8bb47aa..6185ce9 100644 --- a/docs/part-2/4_xds-gdb.md +++ b/docs/part-2/4_xds-gdb.md @@ -94,10 +94,10 @@ Example of gdb init file where we define project and sdk ID: ## How to build xds-gdb from scratch -### Prerequisites +### Dependencies - You must install and setup [Go](https://golang.org/doc/install) version 1.8.1 or - higher to compile this tool. +Install [Go](https://golang.org/doc/install) and some other tools. +Refer to [Prerequisites chapter](./0_Abstract.html#prerequisites) for more details. ### Building -- cgit 1.2.3-korg