eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html

changeset 8288
809d5d5ac2ba
parent 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html	Mon May 03 19:58:28 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html	Tue May 04 19:30:25 2021 +0200
@@ -41,7 +41,11 @@
 
 <tr>
 <td><a href="#getConfigPath">getConfigPath</a></td>
-<td>Public function to get the filename of the config file.</td>
+<td>Function to get the filename of the config file.</td>
+</tr>
+<tr>
+<td><a href="#getHgExecutable">getHgExecutable</a></td>
+<td>Function to get the full path of the Mercurial executable.</td>
 </tr>
 <tr>
 <td><a href="#hgVersion">hgVersion</a></td>
@@ -49,7 +53,7 @@
 </tr>
 <tr>
 <td><a href="#prepareProcess">prepareProcess</a></td>
-<td>Public function to prepare the given process.</td>
+<td>Function to prepare the given process.</td>
 </tr>
 </table>
 <hr />
@@ -59,12 +63,40 @@
 <b>getConfigPath</b>(<i></i>)
 
 <p>
-    Public function to get the filename of the config file.
+    Function to get the filename of the config file.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
-filename of the config file (string)
+filename of the config file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getHgExecutable" ID="getHgExecutable"></a>
+<h2>getHgExecutable</h2>
+<b>getHgExecutable</b>(<i></i>)
+
+<p>
+    Function to get the full path of the Mercurial executable.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+path of the Mercurial executable
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -105,21 +137,21 @@
 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>)
 
 <p>
-    Public function to prepare the given process.
+    Function to prepare the given process.
 </p>
 <dl>
 
-<dt><i>proc</i></dt>
+<dt><i>proc</i> (QProcess)</dt>
 <dd>
-reference to the process to be prepared (QProcess)
+reference to the process to be prepared
 </dd>
-<dt><i>encoding</i></dt>
+<dt><i>encoding</i> (str)</dt>
 <dd>
-encoding to be used by the process (string)
+encoding to be used by the process
 </dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-language to be set (string)
+language to be set
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial