tutorials: Added notices about GZ_PARTITION

Signed-off-by: Martin Pecka <[email protected]>
gazebosim · Sep 15, 2024 · 5c61231 · 5c61231
1 parent 8b184b3
commit 5c61231
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 0 deletions.
diff --git a/tutorials/04_messages.md b/tutorials/04_messages.md
@@ -148,6 +148,20 @@ cmake --build . --config Release
 
 ## Running the examples
 
+> **NOTE**
+> It is essential to have a valid value of `GZ_PARTITION` environment variable
+> and to have it set to the same value in all open terminals. As `GZ_PARTITION`
+> is based on hostname and username, especially Windows and Mac users might
+> have problems due to spaces in their username, which are not a valid character
+> in `GZ_PARTITION`. gz-transport prints error `Invalid partition name` in such
+> case. To resolve that, set `GZ_PARTITION` explicitly to a valid value:
+> ```bash
+> # Linux and Mac
+> export GZ_PARTITION=test
+> # Windows
+> set GZ_PARTITION=test
+> ```
+
 Open two new terminals and from your `build/` directory run the executables.
 
 From terminal 1:

diff --git a/tutorials/06_python_support.md b/tutorials/06_python_support.md
@@ -177,6 +177,20 @@ export PYTHONPATH=$PYTHONPATH:<path_install_prefix>/lib/python
 
 ## Running the examples
 
+> **NOTE**
+> It is essential to have a valid value of `GZ_PARTITION` environment variable
+> and to have it set to the same value in all open terminals. As `GZ_PARTITION`
+> is based on hostname and username, especially Windows and Mac users might
+> have problems due to spaces in their username, which are not a valid character
+> in `GZ_PARTITION`. gz-transport prints error `Invalid partition name` in such
+> case. To resolve that, set `GZ_PARTITION` explicitly to a valid value:
+> ```bash
+> # Linux and Mac
+> export GZ_PARTITION=test
+> # Windows
+> set GZ_PARTITION=test
+> ```
+
 Open two new terminals and directly run the Python scripts downloaded previously.
 
 From terminal 1:

diff --git a/tutorials/07_security.md b/tutorials/07_security.md
@@ -37,6 +37,20 @@ password. Also, every subscriber will only connect to secure publishers.
 
 ### Example
 
+> **NOTE**
+> It is essential to have a valid value of `GZ_PARTITION` environment variable
+> and to have it set to the same value in all open terminals. As `GZ_PARTITION`
+> is based on hostname and username, especially Windows and Mac users might
+> have problems due to spaces in their username, which are not a valid character
+> in `GZ_PARTITION`. gz-transport prints error `Invalid partition name` in such
+> case. To resolve that, set `GZ_PARTITION` explicitly to a valid value:
+> ```bash
+> # Linux and Mac
+> export GZ_PARTITION=test
+> # Windows
+> set GZ_PARTITION=test
+> ```
+
 First, let's test unsecure communication. This example requires
 [gz-tools](https://github.com/gazebosim/gz-tools).
 

diff --git a/tutorials/10_logging.md b/tutorials/10_logging.md
@@ -148,6 +148,20 @@ cmake --build . --config Release
 
 ## Running the examples
 
+> **NOTE**
+> It is essential to have a valid value of `GZ_PARTITION` environment variable
+> and to have it set to the same value in all open terminals. As `GZ_PARTITION`
+> is based on hostname and username, especially Windows and Mac users might
+> have problems due to spaces in their username, which are not a valid character
+> in `GZ_PARTITION`. gz-transport prints error `Invalid partition name` in such
+> case. To resolve that, set `GZ_PARTITION` explicitly to a valid value:
+> ```bash
+> # Linux and Mac
+> export GZ_PARTITION=test
+> # Windows
+> set GZ_PARTITION=test
+> ```
+
 Open two new terminals and from your `build/` directory run the recorder.
 
 From terminal 1:

diff --git a/tutorials/23_topic_statistics.md b/tutorials/23_topic_statistics.md
@@ -73,6 +73,20 @@ if (!node.EnableStats(topic, true, "/my_stats", 100))
 
 ### Example
 
+> **NOTE**
+> It is essential to have a valid value of `GZ_PARTITION` environment variable
+> and to have it set to the same value in all open terminals. As `GZ_PARTITION`
+> is based on hostname and username, especially Windows and Mac users might
+> have problems due to spaces in their username, which are not a valid character
+> in `GZ_PARTITION`. gz-transport prints error `Invalid partition name` in such
+> case. To resolve that, set `GZ_PARTITION` explicitly to a valid value:
+> ```bash
+> # Linux and Mac
+> export GZ_PARTITION=test
+> # Windows
+> set GZ_PARTITION=test
+> ```
+
 If you have the Gazebo Transport sources with the example programs built,
 then you can test topic statistics by following these steps.