[tools] testbot/VMs: Add documentation for VM::GetAgent().
Francois Gouget
fgouget at codeweavers.com
Mon Mar 15 04:29:19 CDT 2021
Signed-off-by: Francois Gouget <fgouget at codeweavers.com>
---
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 53f43948b..2cc6c678d 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);
}
--
2.20.1
More information about the wine-devel
mailing list