Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html
eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing some common utility functions for the Mercurial package. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#getConfigPath">getConfigPath</a></td> | |
| 44 <td>Function to get the filename of the config file.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#getHgExecutable">getHgExecutable</a></td> | |
| 48 <td>Function to get the full path of the Mercurial executable.</td> | |
| 49 </tr> | |
| 50 <tr> | |
| 51 <td><a href="#hgVersion">hgVersion</a></td> | |
| 52 <td>Public method to determine the Mercurial version.</td> | |
| 53 </tr> | |
| 54 <tr> | |
| 55 <td><a href="#prepareProcess">prepareProcess</a></td> | |
| 56 <td>Function to prepare the given process.</td> | |
| 57 </tr> | |
| 58 </table> | |
| 59 <hr /> | |
| 60 <hr /> | |
| 61 <a NAME="getConfigPath" ID="getConfigPath"></a> | |
| 62 <h2>getConfigPath</h2> | |
| 63 <b>getConfigPath</b>(<i></i>) | |
| 64 | |
| 65 <p> | |
| 66 Function to get the filename of the config file. | |
| 67 </p> | |
| 68 <dl> | |
| 69 <dt>Return:</dt> | |
| 70 <dd> | |
| 71 filename of the config file | |
| 72 </dd> | |
| 73 </dl> | |
| 74 <dl> | |
| 75 <dt>Return Type:</dt> | |
| 76 <dd> | |
| 77 str | |
| 78 </dd> | |
| 79 </dl> | |
| 80 <div align="right"><a href="#top">Up</a></div> | |
| 81 <hr /> | |
| 82 <hr /> | |
| 83 <a NAME="getHgExecutable" ID="getHgExecutable"></a> | |
| 84 <h2>getHgExecutable</h2> | |
| 85 <b>getHgExecutable</b>(<i></i>) | |
| 86 | |
| 87 <p> | |
| 88 Function to get the full path of the Mercurial executable. | |
| 89 </p> | |
| 90 <dl> | |
| 91 <dt>Return:</dt> | |
| 92 <dd> | |
| 93 path of the Mercurial executable | |
| 94 </dd> | |
| 95 </dl> | |
| 96 <dl> | |
| 97 <dt>Return Type:</dt> | |
| 98 <dd> | |
| 99 str | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <div align="right"><a href="#top">Up</a></div> | |
| 103 <hr /> | |
| 104 <hr /> | |
| 105 <a NAME="hgVersion" ID="hgVersion"></a> | |
| 106 <h2>hgVersion</h2> | |
| 107 <b>hgVersion</b>(<i>plugin</i>) | |
| 108 | |
| 109 <p> | |
| 110 Public method to determine the Mercurial version. | |
| 111 </p> | |
| 112 <dl> | |
| 113 | |
| 114 <dt><i>plugin</i> (VcsMercurialPlugin)</dt> | |
| 115 <dd> | |
| 116 reference to the plugin object | |
| 117 </dd> | |
| 118 </dl> | |
| 119 <dl> | |
| 120 <dt>Return:</dt> | |
| 121 <dd> | |
| 122 tuple containing the Mercurial version as a string and as a tuple | |
| 123 and an error message. | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <dl> | |
| 127 <dt>Return Type:</dt> | |
| 128 <dd> | |
| 129 tuple of str, tuple of int and str | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <div align="right"><a href="#top">Up</a></div> | |
| 133 <hr /> | |
| 134 <hr /> | |
| 135 <a NAME="prepareProcess" ID="prepareProcess"></a> | |
| 136 <h2>prepareProcess</h2> | |
| 137 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>) | |
| 138 | |
| 139 <p> | |
| 140 Function to prepare the given process. | |
| 141 </p> | |
| 142 <dl> | |
| 143 | |
| 144 <dt><i>proc</i> (QProcess)</dt> | |
| 145 <dd> | |
| 146 reference to the process to be prepared | |
| 147 </dd> | |
| 148 <dt><i>encoding</i> (str)</dt> | |
| 149 <dd> | |
| 150 encoding to be used by the process | |
| 151 </dd> | |
| 152 <dt><i>language</i> (str)</dt> | |
| 153 <dd> | |
| 154 language to be set | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <div align="right"><a href="#top">Up</a></div> | |
| 158 <hr /> | |
| 159 </body></html> |
