Skip to content

Commit 4b2d1f7

Browse files
committed
Fix: changes word 'ROS 2' to 'ROS2'
Signed-off-by: h-suzuki <h-suzuki@isp.co.jp>
1 parent 787da6c commit 4b2d1f7

File tree

16 files changed

+66
-66
lines changed

16 files changed

+66
-66
lines changed

docs/configuration/intra_node_data_path.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ CARET maps mechanically messages of `/pong` topic to messages of `/ping` which f
116116
`callback_chain` looks the best choice. However, it has several drawbacks.
117117

118118
- It is not designed for node which have multiple callbacks running at parallel, and response time might be longer than actual
119-
- It is not able to detect actual time when buffered data are consumed because only CARET does not trace user code on ROS 2
119+
- It is not able to detect actual time when buffered data are consumed because only CARET does not trace user code on ROS2
120120
- Users are expected to know node structure beforehand
121121

122122
<prettier-ignore-start>

docs/design/configuration/architecture_file.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ nodes:
115115
116116
## Callback identification
117117
118-
It's convenient for users to give a name to a callback function for its identification. However, in the context of ROS 2, only an address is given to a callback.
118+
It's convenient for users to give a name to a callback function for its identification. However, in the context of ROS2, only an address is given to a callback.
119119
120120
Addresses change with each launch of an application.
121121
This makes it difficult to handle callbacks by address when evaluating performance of them.

docs/design/event_and_latency_definitions/communication.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -88,48 +88,48 @@ A simplified sequence diagram focusing only on the relevant data flow is shown b
8888
title: Definition of major tracepoints
8989
9090
participant UserCode
91-
participant ROS 2
91+
participant ROS2
9292
participant DDS
9393
participant LTTng
9494
9595
== Publisher Side ==
9696
9797
98-
activate ROS 2
98+
activate ROS2
9999
activate UserCode
100-
UserCode -> ROS 2: publish()
101-
activate ROS 2
102-
ROS 2 -> LTTng: sample rclcpp_publish
100+
UserCode -> ROS2: publish()
101+
activate ROS2
102+
ROS2 -> LTTng: sample rclcpp_publish
103103
104104
105-
ROS 2 -> DDS: dds_write()
106-
deactivate ROS 2
105+
ROS2 -> DDS: dds_write()
106+
deactivate ROS2
107107
activate DDS
108108
DDS -> LTTng: sample dds_write
109109
DDS -> LTTng: sample dds_bind_addr_to_stamp
110110
111-
UserCode -> ROS 2 : callback_end
111+
UserCode -> ROS2 : callback_end
112112
deactivate UserCode
113-
deactivate ROS 2
113+
deactivate ROS2
114114
115115
116116
== Subscription Side ==
117117
118118
119-
DDS -> ROS 2: <notify> on_data_available
120-
activate ROS 2
119+
DDS -> ROS2: <notify> on_data_available
120+
activate ROS2
121121
122-
ROS 2 -> DDS : take messages
123-
DDS -> ROS 2
122+
ROS2 -> DDS : take messages
123+
DDS -> ROS2
124124
deactivate DDS
125-
ROS 2 -> LTTng: sample dispatch_subscription_callback
126-
ROS 2 -> LTTng: sample [callback_start
127-
ROS 2 -> UserCode: callback start
125+
ROS2 -> LTTng: sample dispatch_subscription_callback
126+
ROS2 -> LTTng: sample callback_start
127+
ROS2 -> UserCode: callback start
128128
activate UserCode
129-
UserCode -> ROS 2: callback end
129+
UserCode -> ROS2: callback end
130130
deactivate UserCode
131131
132-
deactivate ROS 2
132+
deactivate ROS2
133133
@enduml
134134
```
135135

docs/design/event_and_latency_definitions/index.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -57,59 +57,59 @@ Below is a detailed sequence diagram of the SingleThreadedExecutor, from publish
5757
title: Definition of major tracepoints
5858
5959
participant UserCode
60-
participant ROS 2
60+
participant ROS2
6161
participant DDS
6262
participant LTTng
6363
6464
== Publisher Side ==
6565
66-
activate ROS 2
66+
activate ROS2
6767
activate UserCode
68-
UserCode -> ROS 2: publish()
69-
activate ROS 2
70-
ROS 2 -> LTTng: sample rclcpp_publish \n sample rclcpp_intra_publish
68+
UserCode -> ROS2: publish()
69+
activate ROS2
70+
ROS2 -> LTTng: sample rclcpp_publish \n sample rclcpp_intra_publish
7171
7272
73-
ROS 2 -> DDS: dds_write()
74-
deactivate ROS 2
73+
ROS2 -> DDS: dds_write()
74+
deactivate ROS2
7575
activate DDS
7676
DDS -> LTTng: sample dds_write
7777
78-
UserCode -> ROS 2 : callback_end
78+
UserCode -> ROS2 : callback_end
7979
deactivate UserCode
80-
deactivate ROS 2
80+
deactivate ROS2
8181
deactivate DDS
8282
8383
8484
== Subscription Side ==
8585
86-
UserCode -> ROS 2 : spin()
86+
UserCode -> ROS2 : spin()
8787
activate DDS
88-
activate ROS 2
88+
activate ROS2
8989
9090
loop
91-
ROS 2 -> ROS 2 : wait until next event
92-
activate ROS 2
93-
DDS -> ROS 2: <notify> on_data_available
94-
ROS 2 -> LTTng : sample on_data_available
95-
deactivate ROS 2
91+
ROS2 -> ROS2 : wait until next event
92+
activate ROS2
93+
DDS -> ROS2: <notify> on_data_available
94+
ROS2 -> LTTng : sample on_data_available
95+
deactivate ROS2
9696
9797
deactivate DDS
98-
ROS 2 -> DDS : reset ready-set, take messages
98+
ROS2 -> DDS : reset ready-set, take messages
9999
activate DDS
100-
DDS -> ROS 2
100+
DDS -> ROS2
101101
deactivate DDS
102102
103103
group execute timer callbacks
104104
end
105105
106106
group execute subscription callbacks
107-
ROS 2 -> LTTng: sample callback_start
108-
ROS 2 -> UserCode: callback start
107+
ROS2 -> LTTng: sample callback_start
108+
ROS2 -> UserCode: callback start
109109
activate UserCode
110-
UserCode -> ROS 2: callback end
110+
UserCode -> ROS2: callback end
111111
deactivate UserCode
112-
ROS 2 -> LTTng: sample callback_end
112+
ROS2 -> LTTng: sample callback_end
113113
end
114114
115115
group execute service callbacks
@@ -119,14 +119,14 @@ loop
119119
end
120120
end
121121
122-
deactivate ROS 2
122+
deactivate ROS2
123123
@enduml
124124
```
125125

126126
Here, each element indicates the following
127127

128128
- UserCode is a callback
129-
- ROS 2 is rclcpp, rcl, and rmw
129+
- ROS2 is rclcpp, rcl, and rmw
130130
- DDS is FastDDS or CycloneDDS
131131
- LTTng is the output destination for tracepoints
132132

docs/design/event_and_latency_definitions/node.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ $$
66
l_{node} = t_{transfer} - t_{receive}
77
$$
88

9-
As transmission is replaced by publish and reception is subscription in the context of ROS 2, the equation is translated into the next one.
9+
As transmission is replaced by publish and reception is subscription in the context of ROS2, the equation is translated into the next one.
1010

1111
$$
1212
l_{node} = t_{pub} - t_{sub}

docs/design/trace_points/diff.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<prettier-ignore-start>
44
!!! note
5-
This section explains differences between v0.2 implementation of CARET and implementation of ROS 2 Galactic. The explanation is not up-to-date from viewpoints of implementation, but it is enough for readers to understand differences from viewpoints of design.
5+
This section explains differences between v0.2 implementation of CARET and implementation of ROS2 Galactic. The explanation is not up-to-date from viewpoints of implementation, but it is enough for readers to understand differences from viewpoints of design.
66
<prettier-ignore-end>
77

88
## v0.2 vs galactic
@@ -13,7 +13,7 @@
1313
- <https://github.com/tier4/rclcpp/tree/galactic_tracepoint_added>
1414
- <https://github.com/tier4/ros2_tracing/tree/galactic_tracepoint_added>
1515

16-
They are cloned from original ROS 2 repositories, respectively. This section describes the differences from originals.
16+
They are cloned from original ROS2 repositories, respectively. This section describes the differences from originals.
1717

1818
### rcl
1919

docs/design/trace_points/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ Each tracepoint for CARET is added by one of following methods.
2828
![builtin_and_extended_tracepoints](../../imgs/builtin_and_extended_trace_points.drawio.png)
2929

3030
- Built-in tracepoints
31-
- tracepoints embedded in original ROS 2 middleware which are utilized by ros2-tracing
31+
- tracepoints embedded in original ROS2 middleware which are utilized by ros2-tracing
3232
- some of tracepoints, for service, action and lifecycle node, are not utilized by current CARET
3333
- Hooked tracepoints
3434
- CARET-dedicated tracepoints introduced by function hooking with LD_PRELOAD
3535
- Extended tracepoints
3636
- CARET-dedicated tracepoints added to the fork of rclcpp
3737

38-
CARET utilizes some of the tracepoints built-in original ROS 2.
39-
Some of the tracepoints are added by hooking with LD_PRELOAD, and rest tracepoints are added to the fork of ROS 2's rclcpp.
38+
CARET utilizes some of the tracepoints built-in original ROS2.
39+
Some of the tracepoints are added by hooking with LD_PRELOAD, and rest tracepoints are added to the fork of ROS2's rclcpp.
4040

4141
<prettier-ignore-start>
4242
!!! info

docs/faq/faq.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
### Setup fails
66

77
- In case you encounter errors during setup or build process, please make sure to use an appropriate branch for your environment
8-
- ROS 2 Humble, Ubuntu 22.04: main branch
9-
- ROS 2 Iron, Ubuntu 22.04: main branch
8+
- ROS2 Humble, Ubuntu 22.04: main branch
9+
- ROS2 Iron, Ubuntu 22.04: main branch
1010
- It's also important to delete `./build` `./install` and `./src` directory before rebuilding CARET if you have built CARET using wrong settings
1111

1212
### CLI tool doesn't work

docs/faq/known_issues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
- Cause
4343
- Python3 deprecates building with `setup.py`
44-
- However, `setup.py` is used to build ROS 2 by colcon
44+
- However, `setup.py` is used to build ROS2 by colcon
4545
- Workaround
4646
- This warning does not prevent CARET from working and does not require any action
4747
- However, if you really want to remove the warning, the following steps can be taken to suppress the warning

docs/installation/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CARET is confirmed to run on the platforms shown in the following table with sup
1212
| Linux Kernel | 5.15.x |
1313
| Python3 | 3.10.x |
1414

15-
The recent version, after v0.3.0, of CARET supports only the combination of ROS 2 Humble and Ubuntu 22.04.
15+
The recent version, after v0.3.0, of CARET supports only the combination of ROS2 Humble and Ubuntu 22.04.
1616
We have added an experimental implementation to work with iron.
1717
To install for iron, open `for iron` in the Installation section below and follow the instructions.
1818

docs/installation/manual_installation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ sudo apt-get install python3-babeltrace python3-lttng
1515

1616
### Install packages to build CARET
1717

18-
Install ROS 2 Humble and related packages.
19-
See also [the official document for ROS 2](https://docs.ros.org/en/humble/Installation/Ubuntu-Development-Setup.html).
18+
Install ROS2 Humble and related packages.
19+
See also [the official document for ROS2](https://docs.ros.org/en/humble/Installation/Ubuntu-Development-Setup.html).
2020

2121
```bash
2222
sudo apt update && sudo apt install -y \

docs/recording/build_check.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44

55
A target application should be built with CARET/rclcpp to record trace data. If you have already built the application without CARET/rclcpp, you have to build the application with CARET/rclcpp again.
66

7-
For building the application with CARET/rclcpp, CARET's `local_setup.bash` should be applied along with ROS 2's `setup.bash` as shown below. Also, `-DBUILD_TESTING=OFF` should be given to build option.
7+
For building the application with CARET/rclcpp, CARET's `local_setup.bash` should be applied along with ROS2's `setup.bash` as shown below. Also, `-DBUILD_TESTING=OFF` should be given to build option.
88

99
```sh
1010
cd <path-to-workspace>
1111

1212
source /opt/ros/humble/setup.bash
13-
source ~/ros2_caret_ws/install/local_setup.bash # please keep the order after ROS 2's setup.bash
13+
source ~/ros2_caret_ws/install/local_setup.bash # please keep the order after ROS2's setup.bash
1414

1515
colcon build --symlink-install --cmake-args -DBUILD_TESTING=OFF
1616
```
1717

1818
<prettier-ignore-start>
1919
!!!info "Reason for building a target application with CARET/rclcpp"
20-
CARET/rclcpp is a fork of [ROS 2-based rclcpp](https://github.com/ros2/rclcpp) which has some additional tracepoints defined by CARET.
20+
CARET/rclcpp is a fork of [ROS2-based rclcpp](https://github.com/ros2/rclcpp) which has some additional tracepoints defined by CARET.
2121
Some tracepoints must be added to template implementation, which is referred by rclcpp header files, for CARET to record a target application.
2222
In order to apply rclcpp which has the additional tracepoints, the application have to be built with CARET/rclcpp again.
2323
Therefore, CARET cannot trace the application provided by Ubuntu's aptitude such as `demo_nodes_cpp`.
@@ -51,7 +51,7 @@ ros2 caret check_caret_rclcpp <path-to-workspace>
5151
In case CARET/rclcpp is not applied to the package you want to analyze, you need to fix it. The followings show possible causes and solutions.
5252

5353
- Case 1: All packages are listed as CARET/rclcpp is not applied
54-
- Make sure you applied CARET's `local_setup.bash` after ROS 2's `setup.bash` (keep the order)
54+
- Make sure you applied CARET's `local_setup.bash` after ROS2's `setup.bash` (keep the order)
5555
- Case 2: Some, but not all, packages are listed as CARET/rclcpp is not applied
5656
- Make sure you have the following line in `package.xml` in the listed package
5757
- `<depend>rclcpp</depend>`

docs/recording/recording.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Two terminals are needed for this method; one for executing a target application
1313

1414
1. Open a terminal and launch a target application
1515

16-
- Perform environment settings in the same order as below. CARET's `local_setup.bash` should be applied along with ROS 2's `setup.bash` as the target application refers to CARET/rclcpp
16+
- Perform environment settings in the same order as below. CARET's `local_setup.bash` should be applied along with ROS2's `setup.bash` as the target application refers to CARET/rclcpp
1717

1818
```sh
1919
# Environment settings (keep the order as below)

docs/recording/validating.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ ros2 caret check_ctf <path-to-trace-data>
9292
### `Failed to find callback group`
9393

9494
- Cause
95-
- CARET failed to bind callback groups, callbacks and executors. It mainly because of ROS 2 "service". "Service" is not supported by CARET
95+
- CARET failed to bind callback groups, callbacks and executors. It mainly because of ROS2 "service". "Service" is not supported by CARET
9696
- Solution
9797
- There is no solution at the moment. This warning can be ignored in most cases

docs/tutorials/recording.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ See [Recording](../recording/index.md) to find more details.
77

88
## Building application with CARET
99

10-
To trace a target application, the target should be built with CARET/rclcpp. If you have already built the target without CARET/rclcpp, you have to build the target with CARET/rclcpp again. For building the application with CARET/rclcpp, CARET's `local_setup.bash` should be applied along with ROS 2's `setup.bash` as shown below.
10+
To trace a target application, the target should be built with CARET/rclcpp. If you have already built the target without CARET/rclcpp, you have to build the target with CARET/rclcpp again. For building the application with CARET/rclcpp, CARET's `local_setup.bash` should be applied along with ROS2's `setup.bash` as shown below.
1111

1212
```bash
1313
mkdir -p ~/ros2_ws/src
@@ -63,7 +63,7 @@ There is no need to run following command.
6363
ros2 caret check_caret_rclcpp ~/ros2_ws/
6464
```
6565

66-
CARET does not require a build using caret-rclcpp with ROS 2 Distributions after iron.
66+
CARET does not require a build using caret-rclcpp with ROS2 Distributions after iron.
6767

6868
</details>
6969

docs/visualization/premise_of_communication.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
This premise section may be boring for some users. If you don't have much time, please feel free to skip the section.
88
<prettier-ignore-end>
99

10-
In ROS 2, nodes communicate each other via topic messages. The topic messages are transmitted by publishers and received by subscriptions. The following figure shows the simplest example where one node sends topic message and the other node receives it.
10+
In ROS2, nodes communicate each other via topic messages. The topic messages are transmitted by publishers and received by subscriptions. The following figure shows the simplest example where one node sends topic message and the other node receives it.
1111

1212
![simple communication](./imgs/simple_communication.svg)
1313

@@ -17,7 +17,7 @@ Topic messages have possibility to be lost in communication path as they are tra
1717

1818
## Many-to-many communication
1919

20-
ROS 2 allows topic messages to be published from multiple nodes and to be received by multiple nodes. Topic messages who share a same topic are transmitted and received among many nodes as the following figure shows.
20+
ROS2 allows topic messages to be published from multiple nodes and to be received by multiple nodes. Topic messages who share a same topic are transmitted and received among many nodes as the following figure shows.
2121

2222
![many-to-many communication](./imgs/many_to_many_communication.svg)
2323

0 commit comments

Comments
 (0)