Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update from fastrtpsgen to fastddsgen #266

Merged
merged 2 commits into from
May 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
#include "HelloWorld.h"

#if !defined(GEN_API_VER) || (GEN_API_VER != 1)
#error Generated HelloWorld is not compatible with current installed Fast-RTPS. Please, regenerate it with fastrtpsgen.
#error Generated HelloWorld is not compatible with current installed Fast-RTPS. Please, regenerate it with fastddsgen.
#endif

/*!
Expand Down
6 changes: 3 additions & 3 deletions docs/fastdds/dds_layer/topic/fastddsgen/fastddsgen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ To learn about all the features that *Fast DDS* offers, please refer to :ref:`Fa
Basic usage
^^^^^^^^^^^

*Fast DDS* can be executed by calling *fastrtpsgen* on Linux or *fastrtpsgen.bat* on Windows.
*Fast DDS* can be executed by calling *fastddsgen* on Linux or *fastddsgen.bat* on Windows.
The IDL file containing the data type definition is given with the ``<IDLfile>`` argument.

+----------------------------------------------------------------------------------------------------------------------+
| **Linux** |
+----------------------------------------------------------------------------------------------------------------------+
| .. code-block:: bash |
| |
| fastrtpsgen [<options>] <IDLfile> [<IDLfile> ...] |
| fastddsgen [<options>] <IDLfile> [<IDLfile> ...] |
+----------------------------------------------------------------------------------------------------------------------+
| **Windows** |
+----------------------------------------------------------------------------------------------------------------------+
| .. code-block:: bash |
| |
| fastrtpsgen.bat [<options>] <IDLfile> [<IDLfile> ...] |
| fastddsgen.bat [<options>] <IDLfile> [<IDLfile> ...] |
+----------------------------------------------------------------------------------------------------------------------+

Among the available arguments defined in :ref:`fastddsgen_usage`, the main *Fast DDS-Gen* options for data type source
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To do this, run the following command from the ``src`` directory.

.. code-block:: bash

<path/to/Fast DDS-Gen>/scripts/fastrtpsgen HelloWorld.idl
<path/to/Fast DDS-Gen>/scripts/fastddsgen HelloWorld.idl

This must have generated the following files:

Expand Down
8 changes: 4 additions & 4 deletions docs/fastddsgen/pubsub_app/includes/first_app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ installation followed and the operating system.

.. code:: bash

<path-to-Fast-DDS-workspace>/src/fastrtpsgen/scripts/fastddsgen -example CMake HelloWorld.idl
<path-to-Fast-DDS-workspace>/src/fastddsgen/scripts/fastddsgen -example CMake HelloWorld.idl

- For a **stand-alone installation**, run:

Expand All @@ -32,7 +32,7 @@ installation followed and the operating system.

.. code:: bash

<path-to-Fast-DDS-workspace>/src/fastrtpsgen/scripts/fastddsgen.bat -example CMake HelloWorld.idl
<path-to-Fast-DDS-workspace>/src/fastddsgen/scripts/fastddsgen.bat -example CMake HelloWorld.idl

- For a **stand-alone installation**, run:

Expand All @@ -44,7 +44,7 @@ installation followed and the operating system.

.. code:: bash

fastrtpsgen.bat -example CMake HelloWorld.idl
fastddsgen.bat -example CMake HelloWorld.idl

.. warning::

Expand All @@ -53,7 +53,7 @@ installation followed and the operating system.

.. code-block:: bash

cd <path-to-Fast-DDS-workspace>/src/fastrtpsgen
cd <path-to-Fast-DDS-workspace>/src/fastddsgen
gradle assemble


Expand Down
8 changes: 4 additions & 4 deletions docs/fastddsgen/usage/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ the following commands:

.. code-block:: bash

$ fastrtpsgen
$ fastddsgen

- Windows:

.. code-block:: bash

> fastrtpsgen.bat
> fastddsgen.bat

.. note::

In case the PATH has not been modified, these scripts can be found in the ``<fastrtpsgen_directory>/scripts``
In case the PATH has not been modified, these scripts can be found in the ``<fastddsgen_directory>/scripts``
directory.


Expand All @@ -42,7 +42,7 @@ The expected argument list of the application is:

.. code-block:: bash

fastrtpsgen [<options>] <IDL file> [<IDL file> ...]
fastddsgen [<options>] <IDL file> [<IDL file> ...]

Where the option choices are:

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/binaries/binaries_linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The :code:`src` folder contains the following packages:
* :code:`fastcdr`, a C++ library for data serialization according to the
`CDR standard <https://www.omg.org/spec/DDSI-RTPS/2.2>`_ (*Section 10.2.1.2 OMG CDR*).
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
* :code:`fastrtpsgen`, a Java application that generates source code using the data types defined in an IDL file.
* :code:`fastddsgen`, a Java application that generates source code using the data types defined in an IDL file.

In case any of these components is unwanted, it can be simply renamed or removed from the :code:`src`
directory.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/binaries/binaries_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ By default, the installation will download all the available packages, namely:
* :code:`fastcdr`, a C++ library that serializes according to the
`standard CDR <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
* :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
* :code:`fastrtpsgen`, a Java application that generates source code using the data types defined in an IDL file.
* :code:`fastddsgen`, a Java application that generates source code using the data types defined in an IDL file.

.. _env_vars_bw:

Expand Down
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.10.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ Several bug fixes on discovery server:
* Fixed timing issues.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.4.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ This release included the following:
* Bug fixing.

**Note:** After upgrading to this release, it is advisable to regenerate generated source from IDL files using
*fastrtpsgen*.
*fastddsgen*.

2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.5.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ This release included the following features:
Also bug fixing.

**Note:** If you are upgrading from an older version than 1.4.0, it is advisable to regenerate generated source from IDL
files using *fastrtpsgen*.
files using *fastddsgen*.

2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.6.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ This release included the following features:
Also bug fixing.

**Note:** If you are upgrading from an older version than 1.4.0, it is advisable to regenerate generated source from IDL
files using *fastrtpsgen*.
files using *fastddsgen*.

2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.7.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ This release included the following features:
Also bug fixing, allocation and performance improvements.

**Note:** If you are upgrading from an older version, it is **required** to regenerate generated source from IDL files
using *fastrtpsgen*.
using *fastddsgen*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.7.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ Some other minor bugs and performance improvements.
and doesn't take history depth into account.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.

2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.7.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ It also has the following improvements:
Some other minor bugs and performance improvements.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.8.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ It also adds the following improvements and bug fixes:
* When using TPC transport, sometimes callbacks are not invoked when removing a participant due to a bug in ASIO.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
4 changes: 2 additions & 2 deletions docs/notes/previous_versions/v1.8.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It also adds the following bug fixes and improvements:
* Fix for race conditions in SubscriberHistory, UDPTransportInterface and StatefulReader.
* Fix for lroundl error on Windows in Time_t.
* CDR & IDL submodules update.
* Use of java 1.8 or greater for fastrtpsgen.jar generation.
* Use of java 1.8 or greater for fastddsgen.jar generation.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
4 changes: 2 additions & 2 deletions docs/notes/previous_versions/v1.8.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It also adds the following bug fixes and improvements:
* Fix for setting `nullptr` in a fixed string.
* Fix for not sending GAP in several cases.
* Solve *Coverity* report issues.
* Fix issue of *fastrtpsgen* failing to open *IDL.g4* file.
* Fix issue of *fastddsgen* failing to open *IDL.g4* file.
* Fix unnamed lock in *AESGCMGMAC_KeyFactory.cpp*.
* Improve *XMLProfiles* example.
* Multicast is now sent through *localhost* too.
Expand All @@ -27,4 +27,4 @@ It also adds the following bug fixes and improvements:
* *WLP* improvements.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*
from IDL files using *fastddsgen*
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.8.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ This release adds the following bug fixes and improvements:
* Bump to IDL-Parser v1.0.1.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*
from IDL files using *fastddsgen*
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.8.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ It also has the following **important bug fixes**:
have been sent, a new subscriber is matched.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*
from IDL files using *fastddsgen*
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.9.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ It also adds the following bug fixes and improvements:
* IDL sub-module updated to current version.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.9.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ It also adds the following bug fixes and improvements:
* Fixed error while setting next deadline event in *create_new_change_with_params*.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.9.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ It also adds the following bug fixes and improvements:
* Bump to IDL-Parser v1.0.1.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.9.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ It also includes the following bug fixes and improvements:


**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v1.9.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ It also includes the following bug fixes and improvements:
* Other minor bug fixes and improvements.

**Note:** If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source
from IDL files using *fastrtpsgen*.
from IDL files using *fastddsgen*.

2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v2.0.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ PRs in merge order:

.. note::
If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
files using *fastrtpsgen*.
files using *fastddsgen*.
If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v2.0.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ This release includes the following improvements:

.. note::
If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
files using *fastrtpsgen*.
files using *fastddsgen*.
If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.
2 changes: 1 addition & 1 deletion docs/notes/previous_versions/v2.1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ Some important **bugfixes** are also included:

.. note::
If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
files using *fastrtpsgen*.
files using *fastddsgen*.
If you are upgrading from a version older than 1.10.0, regenerating the code is *recommended*.
3 changes: 2 additions & 1 deletion docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ executables
extensibility
fastcdr
fastdds
fastrtpsgen
fastddsgen
foonathan
GCM
getter
Expand Down Expand Up @@ -170,6 +170,7 @@ Structs
subfolder
submessage
submessages
submodule
submodules
takeNextData
TCP
Expand Down