diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/README.md | 2 | ||||
| -rw-r--r-- | docs/part-1/0_Abstract.md | 3 | ||||
| -rw-r--r-- | docs/part-1/4-1_build-first-app-setup.md | 15 | ||||
| -rw-r--r-- | docs/part-1/5-2_debug-first-app-cmd.md | 8 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/3_how-to-run.md | 2 |
6 files changed, 18 insertions, 14 deletions
@@ -4,6 +4,6 @@ This repository holds the XDS documentation. Resulting documentation is available : -- online: [http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide) +- online: [http://docs.automotivelinux.org/master/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/master/docs/devguides/en/dev/#xcross-development-system-user's-guide) - PDF file: [http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf) diff --git a/docs/README.md b/docs/README.md index 89b908c..d689046 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ cross build applications. This documentation is available : -- online: [http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide) +- online: [http://docs.automotivelinux.org/master/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/master/docs/devguides/en/dev/#xcross-development-system-user's-guide) - PDF file: [http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf) <br> diff --git a/docs/part-1/0_Abstract.md b/docs/part-1/0_Abstract.md index e2620e6..c85b0f3 100644 --- a/docs/part-1/0_Abstract.md +++ b/docs/part-1/0_Abstract.md @@ -7,7 +7,8 @@ for cross development with near-zero installation. This documentation is available : -- online: [http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide](http://docs.automotivelinux.org/docs/devguides/en/dev/#xcross-development-system-user's-guide) +- online: [http://docs.automotivelinux.org/docs/en/master/devguides/#xcross-development-system-user's-guide](../../../#xcross-development-system-user's-guide) + - PDF file: [http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf](http://iot.bzh/download/public/XDS/docs/XDS_UsersGuide.pdf) The first goal of XDS is to provide a multi-platform cross development tool with near-zero installation. 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 7b8fff2..9224a77 100644 --- a/docs/part-1/4-1_build-first-app-setup.md +++ b/docs/part-1/4-1_build-first-app-setup.md @@ -8,12 +8,15 @@ Let's use _helloworld-native-application_ project as example, so you need first this project into a directory that will be accessible by `xds-server`. 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) ) + +* 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](./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). +It depends on your [deployment setup](./0_Abstract.html) (Standalone, On-Premise or SaaS). * Standalone : use local path mapping. It makes no sense to use cloud sync as it would add pointless overhead. * On-Premise : use Clound Sync. @@ -21,12 +24,12 @@ It depends on your [deployment setup](http://docs.automotivelinux.org/docs/devgu <!-- section-note --> **Note:** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL -project based on [app-templates](https://git.automotivelinux.org/apps/app-templates/) -(included as a git submodule). This CMake templating, used to develop application +project based on [cmake-apps-module](https://git.automotivelinux.org/src/cmake-apps-module/) (refer to install cmake module [instructions](../../cmakeafbtemplates/dev_guide/installing-cmake.html)). This CMake templating, used to develop application with the AGL Application Framework, will automatically generate makefile rules (eg. `remote-target-populate`) or scripts (eg. `build/target/xxx` scripts). -For more info about app-template, please refer to [this documentation](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/sdk-devkit/docs/part-2/2_4-Use-app-templates.html). +For more info about app-template, please refer to [this documentation](../../../#using-the-cmake-applications-module). + <!-- end-section-note --> ## Clone project diff --git a/docs/part-1/5-2_debug-first-app-cmd.md b/docs/part-1/5-2_debug-first-app-cmd.md index d35b4b2..4d2ca84 100644 --- a/docs/part-1/5-2_debug-first-app-cmd.md +++ b/docs/part-1/5-2_debug-first-app-cmd.md @@ -21,7 +21,7 @@ Now to refer your project, just set `XDS_PROJECT_ID` and `XDS_SDK_ID` variables. You are now ready to use `xds-gdb` to for example cross debug your project. Here is an example to build and debug a project based on CMakefile and -[AGL app-templates](https://git.automotivelinux.org/apps/app-templates/): +[cmake-apps-module](https://git.automotivelinux.org/src/cmake-apps-module/): ```bash # Go into your project directory (for example helloworld-native-application) @@ -56,12 +56,12 @@ xds-gdb -x target/gdb-on-root@myTarget.ini <!-- section-note --> **Note:** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL -project based on [app-templates](https://git.automotivelinux.org/apps/app-templates/) -(included as a git submodule). This CMake templating, used to develop application +project based on [cmake-apps-module](https://git.automotivelinux.org/src/cmake-apps-module/) +(refer to install cmake module [instructions](../../cmakeafbtemplates/dev_guide/installing-cmake.html)). This CMake templating, used to develop application with the AGL Application Framework, will automatically generate makefile rules (eg. `remote-target-populate`) or scripts (eg. `build/target/xxx` scripts). -For more info about app-template, please refer to [this documentation](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/sdk-devkit/docs/part-2/2_4-Use-app-templates.html). +For more info about app-template, please refer to [this documentation](../../../#using-the-cmake-applications-module). <!-- end-section-note --> ## Native debugging diff --git a/docs/part-2/1_xds-server/3_how-to-run.md b/docs/part-2/1_xds-server/3_how-to-run.md index 4e56f3f..88fda21 100644 --- a/docs/part-2/1_xds-server/3_how-to-run.md +++ b/docs/part-2/1_xds-server/3_how-to-run.md @@ -5,7 +5,7 @@ been integrated into AGL SDK docker container. >**Note:** For more info about AGL SDK docker container, please refer to -[AGL SDK Quick Setup](http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/setup-sdk-environment.html) +[AGL SDK Quick Setup](../../../../../getting_started/reference/getting-started/docker-container-setup.html) ## Start xds-server |