niklas/cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

consistently use Eclipse Cyclone DDS in documentation

Browse source 
Signed-off-by: Erik Boasson <eb@ilities.com>
This commit is contained in:
Erik Boasson 2019-02-14 13:03:42 +01:00
parent 753f910aad
commit c7906f296d
13 changed files with 151 additions and 322 deletions
Download patch file Download diff file Expand all files Collapse all files

30
src/examples/examples.rst
View file

@ -23,24 +23,26 @@ Examples
Configuration
*************
Cyclone DDS has various configuration parameters and comes with a default built-in configuration.
To run an example, or any application that uses Cyclone DDS for its data exchange, this default
configuration is usually fine and no further action is required.
Eclipse Cyclone DDS has various configuration parameters and comes with a default built-in
configuration. To run an example, or any application that uses Eclipse Cyclone DDS for its data
exchange, this default configuration is usually fine and no further action is required.
Configuration parameters for CycloneDDS are expressed in XML and grouped together in a single XML file.
To use a custom XML configuration in an application, the ``CYCLONEDDS_URI`` environment variable needs
to be set prior to starting the application and pointed to the location of the configuration file to
be used.
Configuration parameters for Eclipse CycloneDDS are expressed in XML and grouped together in a
single XML file. To use a custom XML configuration in an application, the ``CYCLONEDDS_URI``
environment variable needs to be set prior to starting the application and pointed to the location
of the configuration file to be used.
| *Example*
| **Windows:** ``set CYCLONEDDS_URI=file://%USERPROFILE%/CycloneDDS/my-config.xml``
| **Linux:** ``export CYCLONEDDS_URI="file://$HOME/CycloneDDS/my-config.xml"``
The CycloneDDS installation comes with a set of standard configuration files for common use cases.
You update existing configuration files or create your own by using the CycloneDDS Configurator tool,
which provides context-sensitive help on available configuration parameters and their applicability.
The Eclipse CycloneDDS installation comes with a configuration file that corresponds to the default
behaviour. You can modify it or add your using any text or XML editor, or using by using the
Eclipse CycloneDDS Configurator tool, which provides context-sensitive help on available
configuration parameters and their applicability.
You can start the CycloneDDS Configuration tool through the CycloneDDS Launcher, or from your command-prompt
by entering the tools directory and running ``java -jar cycloneddsconf.jar``. The default location of the tools
directory is ``/usr/share/CycloneDDS/tools`` on Linux or ``C:\Program Files\ADLINK\Vortex DDS\share\CycloneDDS\tools``
on Windows.
One very important part of the configuration settings are the "tracing" settings: these allow
letting Eclipse Cyclone DDS trace very detailed information to a file, and this includes the actual
configuration settings in use, including all those that are set at the default. When editing
configuration files by hand, this overview can be very useful. Increasing the Verbosity from
"warning" to, e.g., "config" already suffices for getting this information written to the log.