diff options
Diffstat (limited to 'docs/part-2')
-rw-r--r-- | docs/part-2/1_xds-server.md | 8 | ||||
-rw-r--r-- | docs/part-2/3_xds-exec.md | 20 | ||||
-rw-r--r-- | docs/part-2/4_xds-gdb.md | 6 |
3 files changed, 12 insertions, 22 deletions
diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md index d7f511a..00b1b27 100644 --- a/docs/part-2/1_xds-server.md +++ b/docs/part-2/1_xds-server.md @@ -15,11 +15,6 @@ exposes a REST interface over HTTP and also provides a Web dashboard to configur `xds-server` uses [Syncthing](https://syncthing.net/) tool to synchronize projects files from user machine to build server machine or container. -> **NOTE**: For now, only Syncthing sharing method is supported to synchronize -projects files. But in a near future and for restricted configurations, `xds-server` -will also support "standard" folder sharing (eg. nfs mount points or docker -volumes). - > **SEE ALSO**: [xds-exec](https://github.com/iotbzh/xds-exec), wrappers on `exec` commands that allows you to send commands to `xds-server` and for example build your application from command-line or from your favorite @@ -79,6 +74,7 @@ This container (ID=0) exposes following ports: #### Manually setup docker user id If you plan to **use path-mapping sharing type for your projects**, you need to have the same user id and group id inside and outside docker. By default user and group name inside docker is set `devel` (id `1664`), use following commands to replace id `1664` with your user/group id: + ```bash # Set docker container name to use (usually agl-xds-xxx where xxx is USERNAME@MACHINENAME-IDX-NAME) seb@laptop ~$ export CONTAINER_NAME=agl-xds-seb@laptop-0-seb @@ -307,7 +303,7 @@ below corresponds to the default values): The server part is written in *Go* and web app / dashboard (client part) in *Angular2*. -``` +```bash | +-- bin/ where xds-server binary file will be built | diff --git a/docs/part-2/3_xds-exec.md b/docs/part-2/3_xds-exec.md index 7487947..96f3968 100644 --- a/docs/part-2/3_xds-exec.md +++ b/docs/part-2/3_xds-exec.md @@ -9,12 +9,6 @@ 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` -> **SEE ALSO**: -> - [xds-agent](https://github.com/iotbzh/xds-agent), an agent that should run -on your local host in order to use XDS. -> - [xds-server](https://github.com/iotbzh/xds-server), a web server -used to remotely cross build applications. - ## Configuration `xds-exec` configuration is defined either by environment variables or by @@ -43,12 +37,12 @@ Env config file to source on startup Logging level, supported levels are: -* panic, -* fatal, -* error, -* warn, -* info, -* debug +- panic, +- fatal, +- error, +- warn, +- info, +- debug Default level is "error". @@ -98,7 +92,7 @@ So you should replace `xds-server` in `vendor` directory by a symlink. So clone first `xds-server` sources next to `xds-exec` directory. You should have the following tree: -``` +```bash > tree -L 3 src src |-- github.com diff --git a/docs/part-2/4_xds-gdb.md b/docs/part-2/4_xds-gdb.md index 9905eee..529dc51 100644 --- a/docs/part-2/4_xds-gdb.md +++ b/docs/part-2/4_xds-gdb.md @@ -39,7 +39,7 @@ wrappers on `exec` command that allows to cross build your application through ` `XDS_CONFIG` : Config file defining `XDS_xxx` configuration variables. Variables of this file - will overwrite inherited environment variables. Variables definition may be + will overwrite inherited environment variables. Variables definition may be prefixed or not by "export" keyword. Here is an example of config file @@ -81,8 +81,8 @@ Remote XDS server url ### Configuration variables set within gdb init command file -Above `XDS_xxx` variables may also be defined within gdb init command file -(see --command or -x option of genuine Gdb). +Above `XDS_xxx` variables may also be defined within gdb init command file +(see --command or -x option of genuine Gdb). You must respect the following syntax: commented line including `:XDS-ENV:` tag Example of gdb init file where we define project and sdk ID: |