diff options
| -rw-r--r-- | docs/part-1/4-1_build-first-app-setup.md | 17 | ||||
| -rw-r--r-- | docs/part-1/4-2_build-first-app-cmd.md | 8 | ||||
| -rw-r--r-- | docs/part-1/4-3_build-first-app-dashboard.md | 6 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/0_abstract.md | 7 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/1_build.md (renamed from docs/part-2/1_xds-server/3_build.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/2_config.md (renamed from docs/part-2/1_xds-server/1_config.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/3_how-to-run.md (renamed from docs/part-2/1_xds-server/2_how-to-run.md) | 4 | ||||
| -rw-r--r-- | docs/part-2/2_xds-agent/0_abstract.md | 6 | ||||
| -rw-r--r-- | docs/part-2/2_xds-agent/1_build.md (renamed from docs/part-2/2_xds-agent/3_build.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/2_xds-agent/2_config.md (renamed from docs/part-2/2_xds-agent/1_config.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/2_xds-agent/3_start.md (renamed from docs/part-2/2_xds-agent/2_start.md) | 2 | ||||
| -rw-r--r-- | docs/part-2/3_xds-cli/0_abstract.md | 6 | ||||
| -rw-r--r-- | docs/part-2/3_xds-cli/1_build.md (renamed from docs/part-2/3_xds-cli/3_build.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/3_xds-cli/2_config.md (renamed from docs/part-2/3_xds-cli/1_config.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/3_xds-cli/3_commands.md (renamed from docs/part-2/3_xds-cli/2_commands.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/4_xds-gdb/0_abstract.md | 4 | ||||
| -rw-r--r-- | docs/part-2/4_xds-gdb/1_build.md (renamed from docs/part-2/4_xds-gdb/2_build.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/4_xds-gdb/2_config.md (renamed from docs/part-2/4_xds-gdb/1_config.md) | 0 |
18 files changed, 41 insertions, 19 deletions
diff --git a/docs/part-1/4-1_build-first-app-setup.md b/docs/part-1/4-1_build-first-app-setup.md index 1458e4e..7b8fff2 100644 --- a/docs/part-1/4-1_build-first-app-setup.md +++ b/docs/part-1/4-1_build-first-app-setup.md @@ -1,12 +1,23 @@ # Setup +## Sources Sharing Methods + +### What are possible ways to share source trees ? + Let's use _helloworld-native-application_ project as example, so you need first to clone this project into a directory that will be accessible by `xds-server`. -Depending of the project sharing method: +There are two possible methods to share sources between your host and the XDS server: +- Cloud sync: implies your local directory will be sent to and replicated on the server. This method lets you clone project anywhere on your local disk, +- Path mapping: apply when the xds-server is running locally. This method uses a volume shared between your host and the server, typically `$HOME/xds-workspace` directory. It is much more efficient as there is no replication onto the server ; but you must clone project under the shared directory (`$HOME/xds-workspace` is a good choice because it is shared by default. To create more shared volumes, See --volume option of [container creation script](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/xds/part-1/1-1_install-xds-server-docker.html#create-and-start-a-new-container) ) + +### Which one should I choose ? + +It depends on your [deployment setup](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/xds/part-1/0_Abstract.html) (Standalone, On-Premise or SaaS). -- Cloud sync: you can clone project anywhere on your local disk, -- Path mapping: you must clone project into `$HOME/xds-workspace` directory. +* Standalone : use local path mapping. It makes no sense to use cloud sync as it would add pointless overhead. +* On-Premise : use Clound Sync. +* SaaS : use Cloud Sync. This is the only way to achieve source sharing in this deployment setup. <!-- section-note --> **Note:** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL diff --git a/docs/part-1/4-2_build-first-app-cmd.md b/docs/part-1/4-2_build-first-app-cmd.md index fbfdc41..c878d08 100644 --- a/docs/part-1/4-2_build-first-app-cmd.md +++ b/docs/part-1/4-2_build-first-app-cmd.md @@ -63,15 +63,19 @@ You are now ready to use XDS to for example cross build your project. Here is an example to build a project based on CMakefile: ```bash +# First, grab your target IP address, or it's DNS name +export TARGET_ADDRESS=<target_adress> + # Go into your project directory and create a build directory cd $MY_PROJECT_DIR mkdir build # Generate build system using cmake -xds-cli exec --id=4021617e --sdkid=c226821b -- "cd build && cmake .." +# RSYNC_* variables must be set to allow deployment/populate widgets on target (see app-template doc for more info) +xds-cli exec --id=4021617e --sdkid=c226821b -- "export RSYNC_TARGET=root@${TARGET_ADDRESS} ; export RSYNC_PREFIX=/opt ; cd build && cmake .." # Build the project -xds-cli exec --id=4021617e --sdkid=c226821b -- "cd build && make all" +xds-cli exec --id=4021617e --sdkid=c226821b -- "cd build && make widget" ``` <!-- section-note --> diff --git a/docs/part-1/4-3_build-first-app-dashboard.md b/docs/part-1/4-3_build-first-app-dashboard.md index 1f43715..076be94 100644 --- a/docs/part-1/4-3_build-first-app-dashboard.md +++ b/docs/part-1/4-3_build-first-app-dashboard.md @@ -39,6 +39,12 @@ your local disk. ## Build from XDS dashboard +<!-- section-note --> +**Note:** _helloworld-native-application_ requires few configuration items to be able to walkthrough the whole process. +To pass some environment variables, use the `Settings` window in the `Build` tab. The `Env variables` field allows to pass a list of environment variables (semi-colon separated) that will be set on the server prior to any build action. +For the _helloworld-native-application_ you have to pass something like `RSYNC_TARGET=root@mytarget;RSYNC_PREFIX=/opt` (please replace `mytarget` by a valid target IP address or DNS name entry). +<!-- end-section-note --> + Open the build page build entry of left sidebar {:: style="display:inline; padding:0;"}, then select your **Project** and the **Cross SDK** you want to use and click on diff --git a/docs/part-2/1_xds-server/0_abstract.md b/docs/part-2/1_xds-server/0_abstract.md index 07dd057..8e8d9a4 100644 --- a/docs/part-2/1_xds-server/0_abstract.md +++ b/docs/part-2/1_xds-server/0_abstract.md @@ -35,7 +35,8 @@ IDE (such as Netbeans or Visual Studio Code) through `xds-agent <=> xds-server`. Links to subchapters : -- [Configuration](./1_config.html) -- [How to run](./2_how-to-run.html) -- [Build from scratch](./3_build.html) +- [Build from scratch](./1_build.html) +- [Configuration](./2_config.html) +- [How to run](./3_how-to-run.html) - [Debugging](./4_debug.html) +- [Tests](./5_test.html) diff --git a/docs/part-2/1_xds-server/3_build.md b/docs/part-2/1_xds-server/1_build.md index 5c5059f..5c5059f 100644 --- a/docs/part-2/1_xds-server/3_build.md +++ b/docs/part-2/1_xds-server/1_build.md diff --git a/docs/part-2/1_xds-server/1_config.md b/docs/part-2/1_xds-server/2_config.md index ad86043..ad86043 100644 --- a/docs/part-2/1_xds-server/1_config.md +++ b/docs/part-2/1_xds-server/2_config.md diff --git a/docs/part-2/1_xds-server/2_how-to-run.md b/docs/part-2/1_xds-server/3_how-to-run.md index a3ae22b..4e56f3f 100644 --- a/docs/part-2/1_xds-server/2_how-to-run.md +++ b/docs/part-2/1_xds-server/3_how-to-run.md @@ -118,7 +118,7 @@ See also [xds-agent documentation](../2_xds-agent/0_abstract.html) for more deta <!-- end-section-note --> `xds-server` dynamically detects supported SDKs by scanning sub-directories of -`sdkScriptsDir` directory (see [Configuration chapter](1_config.html)). +`sdkScriptsDir` directory (see [Configuration chapter](2_config.html)). Each sub-directory (usually name is the same as the SDK family) of `sdkScriptsDir` must contain a set of scripts that will be called by `xds-server` to managed SDKs @@ -159,7 +159,7 @@ On startup `xds-server` will call in order: - `sdks/*/get-family-config` to get configuration of each SDK family. - `sdks/*/db-update` to update database (only when `SdkDbUpdate` is set to ̀`startup`, - see [Configuration chapter](1_config.html) for more details) + see [Configuration chapter](2_config.html) for more details) - `sdks/*/db-dump` scripts to get the initial list of available and installed SDKs. Please refer to `sdks/README.md` for more information about scripts definition diff --git a/docs/part-2/2_xds-agent/0_abstract.md b/docs/part-2/2_xds-agent/0_abstract.md index d73bdb9..b867d89 100644 --- a/docs/part-2/2_xds-agent/0_abstract.md +++ b/docs/part-2/2_xds-agent/0_abstract.md @@ -13,7 +13,7 @@ used to remotely cross build applications. Links to subchapters : -- [Configuration](./1_config.html) -- [Start-up](./2_start.html) -- [Build from scratch](./3_build.html) +- [Build from scratch](./1_build.html) +- [Configuration](./2_config.html) +- [Start-up](./3_start.html) - [Debugging](./4_debug.html) diff --git a/docs/part-2/2_xds-agent/3_build.md b/docs/part-2/2_xds-agent/1_build.md index 842f582..842f582 100644 --- a/docs/part-2/2_xds-agent/3_build.md +++ b/docs/part-2/2_xds-agent/1_build.md diff --git a/docs/part-2/2_xds-agent/1_config.md b/docs/part-2/2_xds-agent/2_config.md index 9e912cb..9e912cb 100644 --- a/docs/part-2/2_xds-agent/1_config.md +++ b/docs/part-2/2_xds-agent/2_config.md diff --git a/docs/part-2/2_xds-agent/2_start.md b/docs/part-2/2_xds-agent/3_start.md index c537c93..d750fac 100644 --- a/docs/part-2/2_xds-agent/2_start.md +++ b/docs/part-2/2_xds-agent/3_start.md @@ -23,7 +23,7 @@ systemctl --user stop xds-agent Default settings are defined in `/etc/default/xds-agent` file but these settings you can overwritten by `$HOME/.xds/agent/agent-config.json` file, -see [Configuration chapter](./1_config.html) for more details. +see [Configuration chapter](./2_config.html) for more details. ## Manual start-up diff --git a/docs/part-2/3_xds-cli/0_abstract.md b/docs/part-2/3_xds-cli/0_abstract.md index df7db6c..ef86c49 100644 --- a/docs/part-2/3_xds-cli/0_abstract.md +++ b/docs/part-2/3_xds-cli/0_abstract.md @@ -9,7 +9,7 @@ line. Links to subchapters : -- [Configuration](./1_config.html) -- [Start-up](./2_commands.html) -- [Build from scratch](./3_build.html) +- [Build from scratch](./1_build.html) +- [Configuration](./2_config.html) +- [Start-up](./3_commands.html) - [Debugging](./4_debug.html) diff --git a/docs/part-2/3_xds-cli/3_build.md b/docs/part-2/3_xds-cli/1_build.md index b42b00c..b42b00c 100644 --- a/docs/part-2/3_xds-cli/3_build.md +++ b/docs/part-2/3_xds-cli/1_build.md diff --git a/docs/part-2/3_xds-cli/1_config.md b/docs/part-2/3_xds-cli/2_config.md index 82506ee..82506ee 100644 --- a/docs/part-2/3_xds-cli/1_config.md +++ b/docs/part-2/3_xds-cli/2_config.md diff --git a/docs/part-2/3_xds-cli/2_commands.md b/docs/part-2/3_xds-cli/3_commands.md index 599906c..599906c 100644 --- a/docs/part-2/3_xds-cli/2_commands.md +++ b/docs/part-2/3_xds-cli/3_commands.md diff --git a/docs/part-2/4_xds-gdb/0_abstract.md b/docs/part-2/4_xds-gdb/0_abstract.md index d282efa..e5f0c25 100644 --- a/docs/part-2/4_xds-gdb/0_abstract.md +++ b/docs/part-2/4_xds-gdb/0_abstract.md @@ -19,6 +19,6 @@ variable to use native gdb debug mode instead. Links to subchapters : -- [Configuration](./1_config.html) -- [Build from scratch](./2_build.html) +- [Build from scratch](./1_build.html) +- [Configuration](./2_config.html) - [Debugging](./3_debug.html) diff --git a/docs/part-2/4_xds-gdb/2_build.md b/docs/part-2/4_xds-gdb/1_build.md index 9ec91b3..9ec91b3 100644 --- a/docs/part-2/4_xds-gdb/2_build.md +++ b/docs/part-2/4_xds-gdb/1_build.md diff --git a/docs/part-2/4_xds-gdb/1_config.md b/docs/part-2/4_xds-gdb/2_config.md index 8568f18..8568f18 100644 --- a/docs/part-2/4_xds-gdb/1_config.md +++ b/docs/part-2/4_xds-gdb/2_config.md |