Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ros2: add basic support for ROS 2 traces
This adds the basic elements for a new ROS 2 plugin and defines the basic layout for ROS 2 traces. Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com> Change-Id: Ib59efa443a30951d4d9e4906858bcdc9ce25569c Reviewed-on: https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/192541 Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org> Tested-by: Matthew Khouzam <matthew.khouzam@ericsson.com> Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
- Loading branch information
1 parent
cda8ff7
commit a577af8
Showing
82 changed files
with
4,247 additions
and
0 deletions.
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/.gitignore
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| index/ |
22 changes: 22 additions & 0 deletions
22
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/.project
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <projectDescription> | ||
| <name>org.eclipse.tracecompass.incubator.ros2.doc.user</name> | ||
| <comment></comment> | ||
| <projects> | ||
| </projects> | ||
| <buildSpec> | ||
| <buildCommand> | ||
| <name>org.eclipse.pde.ManifestBuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.pde.SchemaBuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| </buildSpec> | ||
| <natures> | ||
| <nature>org.eclipse.pde.PluginNature</nature> | ||
| </natures> | ||
| </projectDescription> |
2 changes: 2 additions & 0 deletions
2
...g.eclipse.tracecompass.incubator.ros2.doc.user/.settings/org.eclipse.core.resources.prefs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| eclipse.preferences.version=1 | ||
| encoding/<project>=UTF-8 |
2 changes: 2 additions & 0 deletions
2
...org.eclipse.tracecompass.incubator.ros2.doc.user/.settings/org.eclipse.core.runtime.prefs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| eclipse.preferences.version=1 | ||
| line.separator=\n |
2 changes: 2 additions & 0 deletions
2
...pse.tracecompass.incubator.ros2.doc.user/.settings/org.eclipse.ltk.core.refactoring.prefs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| eclipse.preferences.version=1 | ||
| org.eclipse.ltk.core.refactoring.enable.project.refactoring.history=false |
9 changes: 9 additions & 0 deletions
9
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/META-INF/MANIFEST.MF
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| Manifest-Version: 1.0 | ||
| Bundle-ManifestVersion: 2 | ||
| Bundle-Name: %Bundle-Name | ||
| Bundle-Vendor: %Bundle-Vendor | ||
| Bundle-Version: 0.3.0.qualifier | ||
| Bundle-Localization: plugin | ||
| Bundle-SymbolicName: org.eclipse.tracecompass.incubator.ros2.doc.user;singleton:=true | ||
| Require-Bundle: org.eclipse.help | ||
| Automatic-Module-Name: org.eclipse.tracecompass.incubator.ros2.doc.user |
36 changes: 36 additions & 0 deletions
36
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/about.html
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | ||
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> | ||
| <title>About</title> | ||
| </head> | ||
| <body lang="EN-US"> | ||
| <h2>About This Content</h2> | ||
|
|
||
| <p>November 30, 2017</p> | ||
| <h3>License</h3> | ||
|
|
||
| <p> | ||
| The Eclipse Foundation makes available all content in this plug-in | ||
| ("Content"). Unless otherwise indicated below, the Content | ||
| is provided to you under the terms and conditions of the Eclipse | ||
| Public License Version 2.0 ("EPL"). A copy of the EPL is | ||
| available at <a href="http://www.eclipse.org/legal/epl-2.0">http://www.eclipse.org/legal/epl-2.0</a>. | ||
| For purposes of the EPL, "Program" will mean the Content. | ||
| </p> | ||
|
|
||
| <p> | ||
| If you did not receive this Content directly from the Eclipse | ||
| Foundation, the Content is being redistributed by another party | ||
| ("Redistributor") and different terms and conditions may | ||
| apply to your use of any object code in the Content. Check the | ||
| Redistributor's license that was provided with the Content. If no such | ||
| license exists, contact the Redistributor. Unless otherwise indicated | ||
| below, the terms and conditions of the EPL still apply to any source | ||
| code in the Content and such source code may be obtained at <a | ||
| href="http://www.eclipse.org/">http://www.eclipse.org</a>. | ||
| </p> | ||
|
|
||
| </body> | ||
| </html> |
59 changes: 59 additions & 0 deletions
59
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/book.css
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /* following font face declarations need to be removed for DBCS */ | ||
|
|
||
|
|
||
| body, h1, h2, h3, h4, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, sans-serif; color: #000000} | ||
| pre { font-family: Courier, monospace} | ||
|
|
||
| /* end font face declarations */ | ||
|
|
||
| /* following font size declarations should be OK for DBCS */ | ||
| body, h1, h2, h3, h4, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 12pt; } | ||
| pre { font-size: 12pt} | ||
|
|
||
| /* end font size declarations */ | ||
|
|
||
| body { background: #FFFFFF} | ||
| h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 } | ||
| h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 } | ||
| h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 } | ||
| h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic } | ||
| h5 { font size: 13.5pt; } | ||
| p { font-size: 12pt; } | ||
| pre { margin-left: 6; font-size: 9pt } | ||
|
|
||
| a:link { color: #006699 } | ||
| a:visited { color: #996699 } | ||
| a:hover { color: #006699 } | ||
|
|
||
| ul { margin-top: 0; margin-bottom: 10 } | ||
| li { margin-top: 0; margin-bottom: 0 } | ||
| li p { margin-top: 0; margin-bottom: 0 } | ||
| ol { margin-top: 0; margin-bottom: 10 } | ||
| dl { margin-top: 0; margin-bottom: 10 } | ||
| dt { margin-top: 0; margin-bottom: 0; font-weight: bold } | ||
| dd { margin-top: 0; margin-bottom: 0 } | ||
| strong { font-weight: bold} | ||
| em { font-style: italic} | ||
| var { font-style: italic} | ||
| div.revision { border-left-style: solid; border-left-width: thin; | ||
| border-left-color: #7B68EE; padding-left:5 } | ||
| th { font-weight: bold } | ||
| .hidden { | ||
| display: none; | ||
| } | ||
|
|
||
| /* Mike Behm's addition to the style sheet */ | ||
| .userinput { font-family: monospace; } | ||
| .guitab, .important, .guibutton, .selectblue, .guimenu, .guilabel, | ||
| .notetitle { | ||
| color: #000000; | ||
| font-family: helvetica, arial, sans-serif; | ||
| font-weight: bold; | ||
| } | ||
| div.linux {display:none;} | ||
| .firsterm {font-style:italic;} | ||
|
|
||
| .typewriter {font-family:monospace;} | ||
| .bold {font-weight:600;} | ||
| .linethrough {text-decoration: line-through;} | ||
| .underline {text-decoration: underline;} |
18 changes: 18 additions & 0 deletions
18
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/build.properties
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| ############################################################################### | ||
| # Copyright (c) 2022 École Polytechnique de Montréal | ||
| # | ||
| # All rights reserved. This program and the accompanying materials | ||
| # are made available under the terms of the Eclipse Public License 2.0 | ||
| # which accompanies this distribution, and is available at | ||
| # https://www.eclipse.org/legal/epl-2.0 | ||
| # | ||
| # SPDX-License-Identifier: EPL-2.0 | ||
| ############################################################################### | ||
|
|
||
| bin.includes = plugin.xml,\ | ||
| META-INF/,\ | ||
| about.html,\ | ||
| plugin.properties,\ | ||
| book.css,\ | ||
| doc/ | ||
| src.includes = about.html |
51 changes: 51 additions & 0 deletions
51
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/build.xml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project name="org.eclipse.tracecompass.incubator.ros2.doc.user" default="build" basedir="."> | ||
| <description> | ||
| Generate Eclipse help content for the ROS 2 User Guide | ||
| </description> | ||
|
|
||
| <property name="document.title" value="Trace Compass ROS 2 User Guide" /> | ||
|
|
||
| <taskdef resource="org/eclipse/mylyn/wikitext/ant/tasks.properties"/> | ||
|
|
||
| <target name="build" description="Generate Eclipse help content for the Trace Compass Incubator ROS 2 User Guide"> | ||
| <wikitext-to-eclipse-help markupLanguage="MediaWiki" | ||
| validate="true" | ||
| failonvalidationerror="true" | ||
| overwrite="true" | ||
| multipleOutputFiles="true" | ||
| navigationimages="true" | ||
| title="${document.title}" | ||
| formatoutput="true" | ||
| helpPrefix="doc"> | ||
| <fileset dir="doc"> | ||
| <include name="User-Guide.mediawiki" /> | ||
| </fileset> | ||
| <stylesheet url="book.css" /> | ||
| </wikitext-to-eclipse-help> | ||
| <antcall target="test" /> | ||
| </target> | ||
|
|
||
| <target name="test" description="Verify that all of the HTML files are well-formed XML"> | ||
| <!-- | ||
| Don't bother with DTD validation: we only care if the files are well-formed. | ||
| We therefore provide an empty DTD | ||
| --> | ||
| <xmlvalidate lenient="true"> | ||
| <fileset dir="doc"> | ||
| <include name="**/*.html" /> | ||
| </fileset> | ||
| <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="../.empty.dtd" /> | ||
| </xmlvalidate> | ||
| </target> | ||
|
|
||
| <target name ="clean" description="Delete all generated files"> | ||
| <delete failonerror="false"> | ||
| <fileset dir="doc" includes="**/*.html" /> | ||
| <fileset dir="doc" includes="**/*.xml" /> | ||
| </delete> | ||
| </target> | ||
| <target name="build.index" description="Builds search index for the plug-in" if="eclipse.running"> | ||
| <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" /> | ||
| </target> | ||
| </project> |
2 changes: 2 additions & 0 deletions
2
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/doc/.gitignore
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| *.html | ||
| *.xml |
7 changes: 7 additions & 0 deletions
7
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/doc/User-Guide.mediawiki
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
|
|
||
| = ROS 2 traces and analyses = | ||
|
|
||
|
|
||
| See the [https://github.com/christophebedard/ros2-message-flow-analysis message flow analysis instructions]. | ||
|
|
||
| ROS and the "nine dots" ROS logo is a trademark of Open Robotics. |
Binary file added
BIN
+582 Bytes
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/doc/images/home.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+327 Bytes
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/doc/images/next.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+327 Bytes
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/doc/images/prev.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions
13
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/plugin.properties
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| ############################################################################### | ||
| # Copyright (c) 2022 École Polytechnique de Montréal | ||
| # | ||
| # All rights reserved. This program and the accompanying materials | ||
| # are made available under the terms of the Eclipse Public License 2.0 | ||
| # which accompanies this distribution, and is available at | ||
| # https://www.eclipse.org/legal/epl-2.0 | ||
| # | ||
| # SPDX-License-Identifier: EPL-2.0 | ||
| ############################################################################### | ||
|
|
||
| Bundle-Vendor = Eclipse Trace Compass Incubator | ||
| Bundle-Name = Trace Compass ROS 2 User Guide (Incubation) |
13 changes: 13 additions & 0 deletions
13
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/plugin.xml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <plugin> | ||
| <!-- This part should be in a documentation plugin --> | ||
| <!-- Configure the help contribution for this plugin --> | ||
| <extension point="org.eclipse.help.toc"> | ||
| <toc | ||
| file="doc/User-Guide-toc.xml" | ||
| primary="true" /> | ||
| <index | ||
| path="index/"> | ||
| </index> | ||
| </extension> | ||
| </plugin> |
125 changes: 125 additions & 0 deletions
125
doc/org.eclipse.tracecompass.incubator.ros2.doc.user/pom.xml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| Copyright (C) 2014, Ericsson | ||
| All rights reserved. This program and the accompanying materials | ||
| are made available under the terms of the Eclipse Public License 2.0 | ||
| which accompanies this distribution, and is available at | ||
| https://www.eclipse.org/legal/epl-2.0/ | ||
| SPDX-License-Identifier: EPL-2.0 | ||
| --> | ||
| <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <parent> | ||
| <artifactId>org.eclipse.tracecompass.incubator.doc</artifactId> | ||
| <groupId>org.eclipse.tracecompass.incubator</groupId> | ||
| <version>0.3.0-SNAPSHOT</version> | ||
| </parent> | ||
|
|
||
| <artifactId>org.eclipse.tracecompass.incubator.ros2.doc.user</artifactId> | ||
| <packaging>eclipse-plugin</packaging> | ||
|
|
||
| <name>Trace Compass Incubator ROS 2 User Guide</name> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-antrun-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>generate-documentation</id> | ||
| <phase>generate-sources</phase> | ||
| <configuration> | ||
| <target> | ||
| <property name="compile_classpath" refid="maven.compile.classpath" /> | ||
| <ant target="build" inheritRefs="true" antfile="build.xml" /> | ||
| </target> | ||
| </configuration> | ||
| <goals> | ||
| <goal>run</goal> | ||
| </goals> | ||
| </execution> | ||
| <execution> | ||
| <id>clean-documentation</id> | ||
| <phase>clean</phase> | ||
| <configuration> | ||
| <target> | ||
| <ant target="clean" antfile="build.xml" /> | ||
| </target> | ||
| </configuration> | ||
| <goals> | ||
| <goal>run</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <!-- Build help index --> | ||
| <plugin> | ||
| <groupId>org.eclipse.tycho.extras</groupId> | ||
| <artifactId>tycho-eclipserun-plugin</artifactId> | ||
| <configuration> | ||
| <appArgLine>-application org.eclipse.ant.core.antRunner -buildfile build.xml build.index</appArgLine> | ||
| </configuration> | ||
| </plugin> | ||
| <!-- We don't use the ant file to clean because of http://jira.codehaus.org/browse/MANTRUN-78 --> | ||
| <plugin> | ||
| <artifactId>maven-clean-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>clean-index</id> | ||
| <phase>clean</phase> | ||
| <configuration> | ||
| <filesets> | ||
| <fileset><directory>index/</directory></fileset> | ||
| </filesets> | ||
| </configuration> | ||
| <goals> | ||
| <goal>clean</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
|
|
||
| <profiles> | ||
| <profile> | ||
| <id>deploy-doc</id> | ||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <artifactId>maven-antrun-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>deploy</id> | ||
| <phase>install</phase> | ||
| <goals> | ||
| <goal>run</goal> | ||
| </goals> | ||
| <configuration> | ||
| <target> | ||
| <mkdir dir="${docDestination}/org.eclipse.tracecompass.incubator.ros2.doc.user" /> | ||
| <delete includeemptydirs="false"> | ||
| <fileset | ||
| dir="${docDestination}/org.eclipse.tracecompass.incubator.ros2.doc.user"> | ||
| <include name="**" /> | ||
| </fileset> | ||
| </delete> | ||
| <copy includeemptydirs="false" todir="${docDestination}/org.eclipse.tracecompass.incubator.ros2.doc.user"> | ||
| <fileset dir="doc" includes="*.html,images/**"/> | ||
| </copy> | ||
| </target> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </profile> | ||
| </profiles> | ||
|
|
||
| </project> |
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
Oops, something went wrong.