aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--book.json8
-rw-r--r--docs/part-1/2-1_install-xds-server-docker.md12
-rw-r--r--docs/part-1/2-3_install-xds-server-native.md4
-rw-r--r--docs/part-1/3_install-sdks.md4
-rw-r--r--docs/part-1/4-1_build-first-app-setup.md4
-rw-r--r--docs/part-1/4-2_build-first-app-cmd.md12
-rw-r--r--docs/part-1/4-3_build-first-app-dashboard.md4
-rw-r--r--docs/part-1/5-2_debug-first-app-cmd.md4
-rw-r--r--docs/part-2/1_xds-server/1_config.md8
-rw-r--r--docs/part-2/1_xds-server/2_how-to-run.md12
-rw-r--r--docs/part-2/1_xds-server/3_build.md8
-rw-r--r--docs/part-2/2_xds-agent/2_start.md4
-rw-r--r--docs/part-2/3_xds-cli/1_config.md4
-rw-r--r--docs/part-2/3_xds-cli/2_commands.md4
14 files changed, 46 insertions, 46 deletions
diff --git a/book.json b/book.json
index bca8e4b..3b13733 100644
--- a/book.json
+++ b/book.json
@@ -52,22 +52,22 @@
"substitute": "</div>"
},
{
- "pattern": "<!-- note -->",
+ "pattern": "<!-- section-note -->",
"flags": "g",
"substitute": "<div class=\"note\">"
},
{
- "pattern": "<!-- endnote -->",
+ "pattern": "<!-- end-section-note -->",
"flags": "g",
"substitute": "</div>"
},
{
- "pattern": "<!-- warning -->",
+ "pattern": "<!-- section-warning -->",
"flags": "g",
"substitute": "<div class=\"warning\">"
},
{
- "pattern": "<!-- endwarning -->",
+ "pattern": "<!-- end-section-warning -->",
"flags": "g",
"substitute": "</div>"
},
diff --git a/docs/part-1/2-1_install-xds-server-docker.md b/docs/part-1/2-1_install-xds-server-docker.md
index 2823e79..37e1fba 100644
--- a/docs/part-1/2-1_install-xds-server-docker.md
+++ b/docs/part-1/2-1_install-xds-server-docker.md
@@ -55,7 +55,7 @@ inside and outside docker):
| $HOME/xds-workspace/.xdt_0 | /xdt | location to store SDKs |
| $USER_VOLUME | $USER_VOLUME | user path, see `--volume` option of `xds-docker-create-container.sh` script |
-<!-- note -->
+<!-- section-note -->
**Note:**
You can add a new shared directory using `--volume` option in order
@@ -77,16 +77,16 @@ docker ps | grep worker-xds
f67079db4339 docker.automotivelinux.org/agl/worker-xds:5.0 "/usr/bin/wait_for..." About a minute ago Up 34 seconds 0.0.0.0:(2222+ID)->22/tcp, 0.0.0.0:(69+ID)->69/udp, 0.0.0.0:(8000+ID)->8000/tcp, 0.0.0.0:(10809+ID)->10809/tcp agl-xds-HOSTNAME-ID-USERNAME
```
-<!-- endnote -->
+<!-- end-section-note -->
### Manually setup docker user id
-<!-- note -->
+<!-- section-note -->
**Note:**
If you used `xds-docker-create-container.sh` script to create XDS
docker container, user uid/gid inside docker has already been changed by this script.
-<!-- endnote -->
+<!-- end-section-note -->
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.
@@ -147,6 +147,6 @@ ssh -p 2222 devel@localhost journalctl --user --unit=xds-server.service --output
`xds-server` is now up and running, you can now install AGL SDKs, please refer
to next chapter named [Installing AGL SDKs](./3_install-sdks.html)
-<!-- note -->
+<!-- section-note -->
Please refer to [xds-server configuration](../part-2/1_xds-server/1_config.html) chapter for additional info about xds-server settings.
-<!-- endnote -->
+<!-- end-section-note -->
diff --git a/docs/part-1/2-3_install-xds-server-native.md b/docs/part-1/2-3_install-xds-server-native.md
index ffdbc7c..c7bfd55 100644
--- a/docs/part-1/2-3_install-xds-server-native.md
+++ b/docs/part-1/2-3_install-xds-server-native.md
@@ -33,9 +33,9 @@ sudo zypper install agl-xds-server
## Configure xds-server
-<!-- note -->
+<!-- section-note -->
**Optional step**: skip this chapter if you plan to use default settings
-<!-- endnote -->
+<!-- end-section-note -->
Please refer to [Configuration chapter of xds-server](../part-2/1_xds-server/1_config.html)
documentation for more details about JSON configuration file.
diff --git a/docs/part-1/3_install-sdks.md b/docs/part-1/3_install-sdks.md
index 8fc0774..36ee48e 100644
--- a/docs/part-1/3_install-sdks.md
+++ b/docs/part-1/3_install-sdks.md
@@ -68,10 +68,10 @@ xds-cli sdks install --file $HOME/xds-workspace/sdks/poky-agl-glibc-x86_64-agl-d
```
-<!-- note -->
+<!-- section-note -->
Installation based on a local SDK package is only supported when SDK file package
is located in `$HOME/xds-workspace/sdks` directory
-<!-- endnote -->
+<!-- end-section-note -->
## Install a new SDK from XDS Dashboard
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 f974b9e..1458e4e 100644
--- a/docs/part-1/4-1_build-first-app-setup.md
+++ b/docs/part-1/4-1_build-first-app-setup.md
@@ -8,7 +8,7 @@ Depending of the project sharing method:
- Cloud sync: you can clone project anywhere on your local disk,
- Path mapping: you must clone project into `$HOME/xds-workspace` directory.
-<!-- note -->
+<!-- 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
@@ -16,7 +16,7 @@ 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).
-<!-- endnote -->
+<!-- end-section-note -->
## Clone project
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 02de723..fbfdc41 100644
--- a/docs/part-1/4-2_build-first-app-cmd.md
+++ b/docs/part-1/4-2_build-first-app-cmd.md
@@ -35,14 +35,14 @@ If it is not the case, just add it manually using `export PATH=${PATH}:/opt/AGL/
Now to refer your project, just use --id option or use `XDS_PROJECT_ID`
environment variable.
-<!-- note -->
+<!-- section-note -->
**Note:**
Short id notation is also supported as soon as given id value is non ambiguous.
For example, to refer to Project_helloworld-native-application project listed
in above command, you can simply use --id 40 instead of --id 4021617e-ced0-11e7-acd2-3c970e49ad9b
-<!-- endnote -->
+<!-- end-section-note -->
You also need to determine the ID of the cross SDK you want to use to cross build
you application.
@@ -74,10 +74,10 @@ xds-cli exec --id=4021617e --sdkid=c226821b -- "cd build && cmake .."
xds-cli exec --id=4021617e --sdkid=c226821b -- "cd build && make all"
```
-<!-- note -->
+<!-- section-note -->
**Note:** If you use `&&`, `||` or `;` statement in the executed command line,
you need to double quote the command, for example `"cd build && make`.
-<!-- endnote -->
+<!-- end-section-note -->
To avoid to set project id, sdks id, url, ... for each command line, you can
define these settings as environment variables within an env file and just set
@@ -111,7 +111,7 @@ xds-cli exec "mkdir -p build && cd build && cmake .."
cd build && xds-cli exec "make all"
```
-<!-- note -->
+<!-- section-note -->
**Note:** all parameters after a double dash (--) are considered as the command
to execute.
-<!-- endnote -->
+<!-- end-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 4519f54..468d9c0 100644
--- a/docs/part-1/4-3_build-first-app-dashboard.md
+++ b/docs/part-1/4-3_build-first-app-dashboard.md
@@ -23,7 +23,7 @@ when you declare a new project.
This file may be very useful when you plan to use XDS client tools such as `xds-cli` or `xds-gdb`.
-<!-- note -->
+<!-- section-note -->
**Note:**
When `Path mapping` type is selected, you must clone your project into
@@ -35,7 +35,7 @@ project directory name.
If you select `Cloud Sync`, you can clone your project wherever you want on
your local disk.
-<!-- endnote -->
+<!-- end-section-note -->
## Build from XDS dashboard
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 8d0d764..d35b4b2 100644
--- a/docs/part-1/5-2_debug-first-app-cmd.md
+++ b/docs/part-1/5-2_debug-first-app-cmd.md
@@ -54,7 +54,7 @@ xds-cli exec -- make remote-target-populate
xds-gdb -x target/gdb-on-root@myTarget.ini
```
-<!-- note -->
+<!-- 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
@@ -62,7 +62,7 @@ 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).
-<!-- endnote -->
+<!-- end-section-note -->
## Native debugging
diff --git a/docs/part-2/1_xds-server/1_config.md b/docs/part-2/1_xds-server/1_config.md
index 594bdf2..fc82807 100644
--- a/docs/part-2/1_xds-server/1_config.md
+++ b/docs/part-2/1_xds-server/1_config.md
@@ -50,11 +50,11 @@ are set into `/etc/default/xds-server` file.
`xds-server` configuration is also driven by a JSON config file (`server-config.json`),
and default JSON config is `/etc/xds/server/server-config.json`.
-<!-- note -->
+<!-- section-note -->
**Note:**
You can use your own JSON config by settings `APP_CONFIG` variable of
`/etc/default/xds-server` file to your file, for example `/home/MYUSER/.xds/server/server-config.json`
-<!-- endnote -->
+<!-- end-section-note -->
## Disable syncthing
@@ -78,9 +78,9 @@ Here is a JSON configuration file example where syncthing key as been renamed:
On benefit to do that is to increase XDS-Server startup time.
-<!-- note -->
+<!-- section-note -->
**Note:**
- `CloudSync` (AKA syncthing) synchronization type can also be disabled when `"syncthing"` key is not defined in JSON configuration file.
-<!-- endnote -->
+<!-- end-section-note -->
diff --git a/docs/part-2/1_xds-server/2_how-to-run.md b/docs/part-2/1_xds-server/2_how-to-run.md
index 5ca8d28..8c6aa55 100644
--- a/docs/part-2/1_xds-server/2_how-to-run.md
+++ b/docs/part-2/1_xds-server/2_how-to-run.md
@@ -77,21 +77,21 @@ On **Windows**, simply execute `xds-server` executable:
C:\AGL\bin\xds-server.exe
```
-<!-- note -->
+<!-- section-note -->
**Note:**
Invoke `xds-server --help` to get more details about possible options that allow
for example to change logging level or select another configuration file.
-<!-- endnote -->
+<!-- end-section-note -->
## SDK cross-toolchain Management
### Setup to add support of a new SDK family
-<!-- note -->
+<!-- section-note -->
**Optional step**: read this chapter only if you plan to add a new SDK family.
-<!-- endnote -->
+<!-- end-section-note -->
`xds-server` dynamically detects supported SDKs by scanning sub-directories of
`sdkScriptsDir` directory (see [Configuration chapter](1_config.html)).
@@ -199,10 +199,10 @@ xds-cli sdks install --file $HOME/xds-workspace/sdks/poky-agl-glibc-x86_64-agl-d
```
-<!-- note -->
+<!-- section-note -->
Installation based on a local SDK package is only supported when SDK file package
is located in `$HOME/xds-workspace/sdks` directory
-<!-- endnote -->
+<!-- end-section-note -->
### Install a new SDK from XDS Dashboard
diff --git a/docs/part-2/1_xds-server/3_build.md b/docs/part-2/1_xds-server/3_build.md
index 8be3b33..92a90ea 100644
--- a/docs/part-2/1_xds-server/3_build.md
+++ b/docs/part-2/1_xds-server/3_build.md
@@ -36,16 +36,16 @@ And to install `xds-server` (by default in `/opt/AGL/xds/server`):
make install
```
-<!-- warning -->
+<!-- section-warning -->
**Warning:**
Makefile install rule and default values in configuration file are set
to fit the docker setup.
So you may need to adapt some settings when you want to install xds-server natively.
-<!-- endwarning -->
+<!-- end-section-warning -->
-<!-- note -->
+<!-- section-note -->
**Note:**
Used `DESTDIR` to specify another install directory
@@ -54,7 +54,7 @@ Used `DESTDIR` to specify another install directory
make install DESTDIR=$HOME/opt/xds-server
```
-<!-- endnote -->
+<!-- end-section-note -->
### XDS docker image
diff --git a/docs/part-2/2_xds-agent/2_start.md b/docs/part-2/2_xds-agent/2_start.md
index 7d6735d..c537c93 100644
--- a/docs/part-2/2_xds-agent/2_start.md
+++ b/docs/part-2/2_xds-agent/2_start.md
@@ -40,7 +40,7 @@ depending where you installed/unzipped xds-agent tarball):
C:\AGL\bin\xds-agent.exe
```
-<!-- note -->
+<!-- section-note -->
**Note:**
If need be, you can increase log level by setting option
@@ -49,4 +49,4 @@ If need be, you can increase log level by setting option
Invoke `xds-agent --help` to get more details about possible options that allow
for example to change logging level or select a specific configuration file.
-<!-- endnote -->
+<!-- end-section-note -->
diff --git a/docs/part-2/3_xds-cli/1_config.md b/docs/part-2/3_xds-cli/1_config.md
index 6dc7993..82506ee 100644
--- a/docs/part-2/3_xds-cli/1_config.md
+++ b/docs/part-2/3_xds-cli/1_config.md
@@ -16,12 +16,12 @@ options or using a config file knowing that the following priority order is used
config file is specified with `--config|-c` option,
1. else use `XDS_xxx` (for example `XDS_PROJECT_ID`) environment variable
-<!-- note -->
+<!-- section-note -->
**Note:**
All parameters after a double dash (--) are considered as the command
to execute on xds-server.
-<!-- endnote -->
+<!-- end-section-note -->
## Global Options / Configuration variables
diff --git a/docs/part-2/3_xds-cli/2_commands.md b/docs/part-2/3_xds-cli/2_commands.md
index b5e0c0a..599906c 100644
--- a/docs/part-2/3_xds-cli/2_commands.md
+++ b/docs/part-2/3_xds-cli/2_commands.md
@@ -51,12 +51,12 @@ xds-cli sdks ls
xds-cli sdks get c64d
```
-<!-- note -->
+<!-- section-note -->
**Note:**
Please also refer to [Installing AGL SDKs](../../part-1/3_install-sdks.html) chapter for more details about sdks installation.
-<!-- endnote -->
+<!-- end-section-note -->
## exec