Francois Gouget : testbot/VMs: Add documentation for VM::GetAgent().

[Alexandre Julliard]

Module: tools
Branch: master
Commit: 3a661ed93822505924a4857a0ff150787614abe7
URL:    https://source.winehq.org/git/tools.git/?a=commit;h=3a661ed93822505924a4857a0ff150787614abe7

Author: Francois Gouget <fgouget at codeweavers.com>
Date:   Mon Mar 15 10:29:19 2021 +0100

testbot/VMs: Add documentation for VM::GetAgent().

Signed-off-by: Francois Gouget <fgouget at codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard at winehq.org>

---

 testbot/lib/WineTestBot/VMs.pm | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/testbot/lib/WineTestBot/VMs.pm b/testbot/lib/WineTestBot/VMs.pm
index 53f4394..2cc6c67 100644
--- a/testbot/lib/WineTestBot/VMs.pm
+++ b/testbot/lib/WineTestBot/VMs.pm
@@ -208,9 +208,25 @@ sub GetDomain($)
   return LibvirtDomain->new($self);
 }
 
+=pod
+=over 12
+
+=item C<GetAgent()>
+
+Returns a connection to the VM's TestAgent server.
+
+If $Alternate is true, GetAgent() will connect to the TestAgent server running
+on the alternate port. This is typically a server running with higher
+privileges than the one running on the regular port. However note that some
+VMs only run a single TestAgent server with high privileges on the regular
+port.
+
+=back
+=cut
+
 sub GetAgent($;$)
 {
-  my ($self, $Privileged) = @_;
+  my ($self, $Alternate) = @_;
 
   # Use either the tunnel specified in the configuration file
   # or autodetect the settings based on the VM's VirtURI setting.
@@ -227,7 +243,7 @@ sub GetAgent($;$)
     $TunnelInfo->{username} = $ParsedURI->userinfo;
   }
   my $Port = $AgentPort;
-  $Port++ if ($Privileged);
+  $Port++ if ($Alternate);
   return TestAgent->new($self->Hostname, $Port, $TunnelInfo);
 }