summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-05 17:39:36 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2018-01-05 17:39:36 +0100
commit9358c9fb4b198adf8594cedd6b8941d88dec63e9 (patch)
tree807dc35de2dccbf6e96d498a0d01eece293f2ecb /docs
parentfb3fdb7bc37627489eda28c374177af879c924af (diff)
XDS sources are now hold under AGL Gerrit (update refs).
Diffstat (limited to 'docs')
-rw-r--r--docs/part-1/1_install-client.md10
-rw-r--r--docs/part-2/1_xds-server.md12
-rw-r--r--docs/part-2/2_xds-agent.md14
-rw-r--r--docs/part-2/3_xds-cli.md11
-rw-r--r--docs/part-2/4_xds-gdb.md15
-rw-r--r--docs/part-2/5_xds-exec.md118
6 files changed, 32 insertions, 148 deletions
diff --git a/docs/part-1/1_install-client.md b/docs/part-1/1_install-client.md
index 304b46a..b482dc9 100644
--- a/docs/part-1/1_install-client.md
+++ b/docs/part-1/1_install-client.md
@@ -1,6 +1,6 @@
# Installing XDS client tools
-[xds-agent](https://github.com/iotbzh/xds-agent) is a client tool that must run
+[xds-agent](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-agent.git) is a client tool that must run
on your machine (user / developer host) to be able to use XDS.
You should establish the following chain:
@@ -14,12 +14,8 @@ and default url/port mentioned in schema below can be change using config files.
Installation of other XDS client tools, such as `xds-cli` or `xds-gdb` is
optional and depends of what you want to do :
-- [xds-cli](https://github.com/iotbzh/xds-cli) : command line tool to used to interact with XDS (also used by IDE integration).
-- [xds-gdb](https://github.com/iotbzh/xds-gdb) : requested for debugging application.
-
-> [xds-exec](https://github.com/iotbzh/xds-exec) is another tool used to interact
-> with XDS before that `xds-cli` exists. `xds-exec` is deprecated and you should
-> now use `xds-cli exec` command instead.
+- [xds-cli](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-cli.git) : command line tool to used to interact with XDS (also used by IDE integration).
+- [xds-gdb](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-gdb.git) : requested for debugging application.
## Install packages for debian distro type
diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md
index 3ed32c9..310cbc6 100644
--- a/docs/part-2/1_xds-server.md
+++ b/docs/part-2/1_xds-server.md
@@ -25,7 +25,7 @@ to setup the following connection chain:
xds-cli <---> xds-agent <-|-> xds-server
```
-**SEE ALSO**: [xds-cli](https://github.com/iotbzh/xds-cli),
+**SEE ALSO**: [xds-cli](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-cli.git),
a command-line tool that allows you to send commands to `xds-agent / xds-server`
and for example build your application from command-line or from your favorite
IDE (such as Netbeans or Visual Studio Code) through `xds-agent <=> xds-server`.
@@ -322,7 +322,6 @@ List of installed SDKs:
87f0400b AGL-release-dab-3.99.3-m3ulcb-nogfx Installed 3.99.3 aarch64
352c0584 poky-agl-corei7-64-3.99.2+snapshot Installed 3.99.2+snapshot corei7-64
d65fe750 AGL-release-eel-latest-qemux86-64 Installed 4.99.5 corei7-64
- 74f78335 poky-agl-aarch64.libmicrohttp_0.9.55-3.99.1+snapshot Installed 3.99.1+snapshot aarch64.libmicrohttp_0.9.55
# Un-install a SDK
xds-cli sdks uninstall d65fe750
@@ -397,12 +396,13 @@ Create a GOPATH variable(must be a full path):
export GOPATH=$(realpath ~/workspace_go)
```
-Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
+Clone this repo into your `$GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds` and use delivered Makefile:
```bash
- mkdir -p $GOPATH/src/github.com/iotbzh
- cd $GOPATH/src/github.com/iotbzh
- git clone https://github.com/iotbzh/xds-server.git
+ mkdir -p $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ cd $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ git clone https://gerrit.automotivelinux.org/gerrit/src/xds/xds-server
+ # or git clone ssh://YOUR_USERNAME@gerrit.automotivelinux.org:29418/src/xds/xds-server
cd xds-server
make all
```
diff --git a/docs/part-2/2_xds-agent.md b/docs/part-2/2_xds-agent.md
index abe3d15..5c9e114 100644
--- a/docs/part-2/2_xds-agent.md
+++ b/docs/part-2/2_xds-agent.md
@@ -6,7 +6,7 @@ This agent takes care, among others, of starting [Syncthing](https://syncthing.n
tool to synchronize your project files from your local host to XDS build server
machine or container (where `xds-server` is running).
-> **SEE ALSO**: [xds-server](https://github.com/iotbzh/xds-server), a web server
+> **SEE ALSO**: [xds-server](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-server.git), a web server
used to remotely cross build applications.
## Configuration
@@ -66,7 +66,6 @@ Simply to start `xds-agent` executable
`--log <level>`, supported *level* are: panic, fatal, error, warn, info, debug.
You can now use XDS dashboard and check that connection with `xds-agent` is up.
-(see also [xds-server README](https://github.com/iotbzh/xds-server/blob/master/README.md#xds-dashboard))
## Build xds-agent from scratch
@@ -101,12 +100,13 @@ Don't forget to open new user session after installing the packages.
### Building
-Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
+Clone this repo into your `$GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds` and use delivered Makefile:
```bash
- mkdir -p $GOPATH/src/github.com/iotbzh
- cd $GOPATH/src/github.com/iotbzh
- git clone https://github.com/iotbzh/xds-agent.git
+ mkdir -p $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ cd $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ git clone https://gerrit.automotivelinux.org/gerrit/src/xds/xds-agent
+ # or git clone ssh://YOUR_USERNAME@gerrit.automotivelinux.org:29418/src/xds/xds-agent
cd xds-agent
make all
```
@@ -201,6 +201,6 @@ Then invoke `vendor/debug` Makefile rule to create a symlink inside vendor
directory :
```bash
-cd src/github.com/iotbzh/xds-agent
+cd src/gerrit.automotivelinux.org/gerrit/src/xds/xds-agent
make vendor/debug
```
diff --git a/docs/part-2/3_xds-cli.md b/docs/part-2/3_xds-cli.md
index a5610c1..74903f8 100644
--- a/docs/part-2/3_xds-cli.md
+++ b/docs/part-2/3_xds-cli.md
@@ -172,13 +172,14 @@ xds-cli misc sts
### Building
-Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
+Clone this repo into your `$GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds` and use delivered Makefile:
```bash
export GOPATH=$(realpath ~/workspace_go)
- mkdir -p $GOPATH/src/github.com/iotbzh
- cd $GOPATH/src/github.com/iotbzh
- git clone https://github.com/iotbzh/xds-cli.git
+ mkdir -p $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ cd $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ git clone https://gerrit.automotivelinux.org/gerrit/src/xds/xds-cli
+ # or git clone ssh://YOUR_USERNAME@gerrit.automotivelinux.org:29418/src/xds/xds-cli
cd xds-cli
make
```
@@ -207,6 +208,6 @@ Then invoke `vendor/debug` Makefile rule to create a symlink inside vendor
directory :
```bash
-cd src/github.com/iotbzh/xds-cli
+cd src/gerrit.automotivelinux.org/gerrit/src/xds/xds-cli
make vendor/debug
```
diff --git a/docs/part-2/4_xds-gdb.md b/docs/part-2/4_xds-gdb.md
index 6e5b57d..8bb47aa 100644
--- a/docs/part-2/4_xds-gdb.md
+++ b/docs/part-2/4_xds-gdb.md
@@ -14,11 +14,11 @@ Two debugging models are supported:
By default XDS debug model is used and you need to define `XDS_NATIVE_GDB`
variable to use native gdb debug mode instead.
-> **SEE ALSO**: [xds-agent](https://github.com/iotbzh/xds-agent), a local agent
+> **SEE ALSO**: [xds-agent](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-agent.git), a local agent
used to interface xds-server.
-> **SEE ALSO**: [xds-server](https://github.com/iotbzh/xds-server), a REST API server
+> **SEE ALSO**: [xds-server](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-server.git), a REST API server
used to remotely cross build applications.
-> **SEE ALSO**: [xds-cli](https://github.com/iotbzh/xds-cli), XDS command line tool.
+> **SEE ALSO**: [xds-cli](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/xds/xds-cli.git), XDS command line tool.
## Configuration
@@ -101,13 +101,14 @@ Example of gdb init file where we define project and sdk ID:
### Building
-Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
+Clone this repo into your `$GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds` and use delivered Makefile:
```bash
export GOPATH=$(realpath ~/workspace_go)
- mkdir -p $GOPATH/src/github.com/iotbzh
- cd $GOPATH/src/github.com/iotbzh
- git clone https://github.com/iotbzh/xds-gdb.git
+ mkdir -p $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ cd $GOPATH/src/gerrit.automotivelinux.org/gerrit/src/xds
+ git clone https://gerrit.automotivelinux.org/gerrit/src/xds/xds-gdb
+ # or git clone ssh://YOUR_USERNAME@gerrit.automotivelinux.org:29418/src/xds/xds-gdb
cd xds-gdb
make
```
diff --git a/docs/part-2/5_xds-exec.md b/docs/part-2/5_xds-exec.md
index cc31a40..f656534 100644
--- a/docs/part-2/5_xds-exec.md
+++ b/docs/part-2/5_xds-exec.md
@@ -1,119 +1,5 @@
# xds-exec: wrapper on exec for XDS
-`xds-exec` is a wrapper on exec linux command for X(cross) Development System.
+`xds-exec` is now deprecated and has been replaced `exec` command of `xds-cli`.
-As well as `xds-exec` is a wrapper on exec command and can be use to execute any
-command on a remote `xds-server`.
-
-This tool can be used in lieu of "standard" `exec` command to execute any
-command on a remote `xds-server`. For example you can trig your project build by
-executing : `xds-exec --config conf.env -- make build`
-
-## Configuration
-
-`xds-exec` configuration is defined either by environment variables or by
-setting command line options (see listed below).
-
-Configuration through environment variables may also be defined in a file that
-will be sourced on `xds-exec` start-up. Use `--config|-c` option or set
-`XDS_CONFIG` environment variable to specify the config filename.
-
-So configuration is driven either by environment variables or by command line
-options or using a config file knowing that the following priority order is used:
-
-1. use option value (for example use project ID set by `--id` option),
-1. else use variable `XDS_xxx` (for example `XDS_PROJECT_ID` variable) when a
- config file is specified with `--config|-c` option,
-1. else use `XDS_xxx` (for example `XDS_PROJECT_ID`) environment variable
-
-<!-- note -->
-**Note:** all parameters after a double dash (--) are considered as the command
-to execute on xds-server.
-<!-- endnote -->
-
-### Configuration Options/Variables
-
-__`--id` option or `XDS_PROJECT_ID` env variable **(mandatory)**__
-
-Project ID you want to build
-
-__`--config|-c` option or `XDS_CONFIG` env variable__
-
-Env config file to source on startup
-
-__`--log|-l` option or `XDS_LOGLEVEL` env variable__
-
-Logging level, supported levels are:
-
-- panic,
-- fatal,
-- error,
-- warn,
-- info,
-- debug
-
-Default level is "error".
-
-__`--rpath` option or `XDS_PATH` env variable__
-
-Relative path into project
-
-__`sdkid` option or `XDS_SDK_ID` env variable **(mandatory)**__
-
-Cross Sdk ID to use to build project
-
-__`timestamp|-ts` option or `XDS_TIMESTAMP` env variable__
-
-Prefix output with timestamp
-
-__`url` option or `XDS_AGENT_URL` env variable__
-
-Local XDS agent url (default: "localhost:8800")
-
-## How to build
-
-### Prerequisites
-
- You must install and setup [Go](https://golang.org/doc/install) version 1.8.1 or
- higher to compile this tool.
-
-### Building
-
-Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
-
-```bash
- export GOPATH=$(realpath ~/workspace_go)
- mkdir -p $GOPATH/src/github.com/iotbzh
- cd $GOPATH/src/github.com/iotbzh
- git clone https://github.com/iotbzh/xds-exec.git
- cd xds-exec
- make
-```
-
-## Debug
-
-Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
-
->**Tricks:** To debug both `xds-exec` and `xds-agent` (REST API part) or common
-code `xds-common`, it may be useful use the same local sources.
-So you should replace `xds-agent` + `xds-common` in `vendor` directory by a symlink.
-So clone first `xds-agent` + `xds-common` sources next to `xds-exec` directory.
-You should have the following tree:
-
-```bash
-> tree -L 3 src
-src
-|-- github.com
- |-- iotbzh
- |-- xds-agent
- |-- xds-common
- |-- xds-exec
-```
-
-Then invoke `vendor/debug` Makefile rule to create a symlink inside vendor
-directory :
-
-```bash
-cd src/github.com/iotbzh/xds-exec
-make vendor/debug
-```
+Please refer to [xds-cli documentation](./3_xds-cli.md) for more details.