From f0f383cd7b79ee6d69abc7e00f33ccd74815355f Mon Sep 17 00:00:00 2001
From: Felix Schumacher <felix.schumacher@internetallee.de>
Date: Thu, 31 Dec 2020 14:57:20 +0100
Subject: [PATCH] Add documentation for the property client.rmi.localport

Bugzilla Id: 65028
---
 bin/jmeter.properties                     | 5 +++--
 xdocs/changes.xml                         | 1 +
 xdocs/usermanual/properties_reference.xml | 4 ++--
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/bin/jmeter.properties b/bin/jmeter.properties
index 7683c28278..8b3a430604 100644
--- a/bin/jmeter.properties
+++ b/bin/jmeter.properties
@@ -285,8 +285,9 @@ remote_hosts=127.0.0.1
 # On the client:
 # - set remote_hosts=server:1234
 
-# Parameter that controls the RMI port used by RemoteSampleListenerImpl (The Controller)
-# Default value is 0 which means port is randomly assigned
+# Parameter that controls the base for RMI ports used by RemoteSampleListenerImpl and RemoteThreadsListenerImpl (The Controller)
+# Default value is 0 which means ports are randomly assigned
+# If you specify a base port, JMeter will (at the moment) use the ports that start one after the given base.
 # You may need to open Firewall port on the Controller machine
 #client.rmi.localport=0
 
diff --git a/xdocs/changes.xml b/xdocs/changes.xml
index 6a0668938d..5f5ecb8b09 100644
--- a/xdocs/changes.xml
+++ b/xdocs/changes.xml
@@ -111,6 +111,7 @@ Summary
 
 <h3>General</h3>
 <ul>
+  <li><bug>65028</bug>Add documentation for the property <code>client.rmi.localport</code></li>
 </ul>
 
 <ch_section>Non-functional changes</ch_section>
diff --git a/xdocs/usermanual/properties_reference.xml b/xdocs/usermanual/properties_reference.xml
index 21174b4754..de95a86ff6 100644
--- a/xdocs/usermanual/properties_reference.xml
+++ b/xdocs/usermanual/properties_reference.xml
@@ -343,8 +343,8 @@ JMETER-SERVER</source>
     Defaults to: <code>1099</code>
 </property>
 <property name="client.rmi.localport">
-    Parameter that controls the RMI port used by the <code>RemoteSampleListenerImpl</code> (The Controller)<br/>
-    Default value is <code>0</code>, which means port is randomly assigned.
+    Parameter that controls the RMI ports used by <code>RemoteSampleListenerImpl</code> and <code>RemoteThreadsListenerImpl</code> (The Controller)<br/>
+    Default value is <code>0</code>, which means ports are randomly assigned.
     If this is non-zero, it will be used as the base for local port numbers for the client engine.
     At the moment JMeter will open up to three ports beginning with the port defined in this property.
     <note>You may need to open corresponding ports in the firewall on the Controller machine.</note>