aboutsummaryrefslogtreecommitdiffstats
path: root/docs/part-1
diff options
context:
space:
mode:
authorJohann CAHIER <johann.cahier@iot.bzh>2018-10-09 10:45:08 +0200
committerJohann CAHIER <johann.cahier@iot.bzh>2018-10-11 13:38:39 +0200
commitbbbe9c168526bbb729022f9de903aff5690b328d (patch)
treee20b465e03d23d4c85a62dbfbc2aa1d8f8c13a4f /docs/part-1
parent48374d29bcc3bcf2b055b49d56eac49247772271 (diff)
Improves documentation
* Describes better available source tree sharing method (between xds-agent and xds-server), and which to prefer depending on the deployment setup. * Gives indication about how to pass RSYNC_TARGET and RSYNC_PREFIX env vars to the helloworld-native-application build process. * Swap chapter order (build before config) Change-Id: Ie4c22f277a59b0405744d71b0fadff67c5d5d025 Signed-off-by: Johann CAHIER <johann.cahier@iot.bzh>
Diffstat (limited to 'docs/part-1')
-rw-r--r--docs/part-1/4-1_build-first-app-setup.md17
-rw-r--r--docs/part-1/4-2_build-first-app-cmd.md8
-rw-r--r--docs/part-1/4-3_build-first-app-dashboard.md6
3 files changed, 26 insertions, 5 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 ![](./pictures/xds-dashboard-icon-3.png){:: style="display:inline; padding:0;"},
then select your **Project** and the **Cross SDK** you want to use and click on