Code generation documentation #1
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Romain Lebbadi-Breteau <[email protected]> (cherry picked from commit 8fd5822) Co-authored-by: Romain Lebbadi-Breteau <[email protected]>
These reports are important to continue to provide visiblity for ROS 2 as well as maintain the history. Migrating from: https://wiki.ros.org/Metrics
|
I got mermaid working in: ros2#4151 that you can build on top of. |
The import statement `from launch_ros.actions import Node` was missing in line 3 Signed-off-by: Michael Razum <[email protected]>
gonzodepedro
force-pushed
the
code_generation_documentation
branch
2 times, most recently
from
406b22b to
38f2d1f
Compare
tfoote
reviewed
Feb 2, 2024
| of CMake and Ament. To simplify the explanation of this mechanism let's separate ROS2 projects that generate or need code to be generated in two types. | ||
|
|
||
| - ``Generator`` projects, which are the ones that have the templates and logic to generate code. | ||
| - ``Client`` projects, which are the ones that need code to be generated, they have the parameters to generate code. |
There was a problem hiding this comment.
Client as a keyword collides with the "ros client library" verbiage. I might suggest an alternative to client to differentiate from rcl. I would suggest potentially interface projects.
gonzodepedro
commented
Feb 2, 2024
| of CMake and Ament. To simplify the explanation of this mechanism let's separate ROS2 projects that generate or need code to be generated in two types. | ||
|
|
||
| - ``Generator`` projects, which are the ones that have the templates and logic to generate code. | ||
| - ``Client`` projects, which are the ones that need code to be generated, they have the parameters to generate code. |
There was a problem hiding this comment.
Change "client" for "interfaces"
tfoote
reviewed
Feb 2, 2024
| Automatic code generation using template files | ||
| ============================================== | ||
|
|
||
| As mentioned above, in order to deal with different DDS implementations, code has to be generated. Code generation is handled by a clever usage |
There was a problem hiding this comment.
Suggested change
| As mentioned above, in order to deal with different DDS implementations, code has to be generated. Code generation is handled by a clever usage | |
| As mentioned above, in order to deal with different DDS implementations, code has to be generated. Code generation is handled by a combination |
tfoote
reviewed
Feb 2, 2024
| Note right of ament_package: Execute a cmake.in template with variables and a cmake code hook. | ||
|
|
||
|
|
||
| When the *client* package, during its build process, calls the 'rosidl_generate_interfaces' macro, the extensions that were registered for each of the |
There was a problem hiding this comment.
Please wrap on sentence boundaries. That's our standard for documentation. It makes diffs easier to read.
tfoote
reviewed
Feb 2, 2024
| participant generate_arguments_file | ||
| participant rosidl_generator | ||
| project_with_rosidl_files->>rosidl_generate_interfaces: path_to_idl_files | ||
| loop ForEach Hook |
There was a problem hiding this comment.
It would be good to include information about how many times this will loop.
gonzodepedro
force-pushed
the
code_generation_documentation
branch
from
38f2d1f to
2599068
Compare
* Add mermaid support and update pinned version To get mermaid support working I had to do upgrades. I've updated our pins and documented how they're used as well as how to update them too. This will allow us to do integrated mermaid sequence diagrams as well as flow diagrams instead of committing images of them. * clean up docker installation to focus on pip version pinning * Match folders in ignore too Signed-off-by: Tully Foote <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
To get mermaide support working I had to do upgrades. I've updated our pins and documented how they're used as well as how to update them too. This will allow us to do integrated mermaid sequence diagrams as well as flow diagrams instead of committing images of them.
Co-authored-by: Tomoya Fujita <[email protected]> Signed-off-by: Tully Foote <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]> Signed-off-by: Tully Foote <[email protected]>
Signed-off-by: Tully Foote <[email protected]>
Signed-off-by: Gonzalo de Pedro <[email protected]>
gonzodepedro
force-pushed
the
code_generation_documentation
branch
from
2599068 to
d580364
Compare
Signed-off-by: Gonzalo de Pedro <[email protected]>
|
There's some more advanced features here: https://mermaid.js.org/syntax/sequenceDiagram.html |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.