Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities</h1> | 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing some common utility functions for the Mercurial package. | 26 Module implementing some common utility functions for the Mercurial package. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 32 <tr><td>None</td></tr> | 36 <tr><td>None</td></tr> |
| 33 </table> | 37 </table> |
| 34 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 | |
| 35 <table> | 40 <table> |
| 41 | |
| 36 <tr> | 42 <tr> |
| 37 <td><a href="#getConfigPath">getConfigPath</a></td> | 43 <td><a href="#getConfigPath">getConfigPath</a></td> |
| 38 <td>Public function to get the filename of the config file.</td> | 44 <td>Public function to get the filename of the config file.</td> |
| 39 </tr><tr> | 45 </tr> |
| 46 <tr> | |
| 40 <td><a href="#hgVersion">hgVersion</a></td> | 47 <td><a href="#hgVersion">hgVersion</a></td> |
| 41 <td>Public method to determine the Mercurial version.</td> | 48 <td>Public method to determine the Mercurial version.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#prepareProcess">prepareProcess</a></td> | 51 <td><a href="#prepareProcess">prepareProcess</a></td> |
| 44 <td>Public function to prepare the given process.</td> | 52 <td>Public function to prepare the given process.</td> |
| 45 </tr> | 53 </tr> |
| 46 </table> | 54 </table> |
| 47 <hr /><hr /> | 55 <hr /> |
| 56 <hr /> | |
| 48 <a NAME="getConfigPath" ID="getConfigPath"></a> | 57 <a NAME="getConfigPath" ID="getConfigPath"></a> |
| 49 <h2>getConfigPath</h2> | 58 <h2>getConfigPath</h2> |
| 50 <b>getConfigPath</b>(<i></i>) | 59 <b>getConfigPath</b>(<i></i>) |
| 60 | |
| 51 <p> | 61 <p> |
| 52 Public function to get the filename of the config file. | 62 Public function to get the filename of the config file. |
| 53 </p><dl> | 63 </p> |
| 64 <dl> | |
| 54 <dt>Returns:</dt> | 65 <dt>Returns:</dt> |
| 55 <dd> | 66 <dd> |
| 56 filename of the config file (string) | 67 filename of the config file (string) |
| 57 </dd> | 68 </dd> |
| 58 </dl> | 69 </dl> |
| 59 <div align="right"><a href="#top">Up</a></div> | 70 <div align="right"><a href="#top">Up</a></div> |
| 60 <hr /><hr /> | 71 <hr /> |
| 72 <hr /> | |
| 61 <a NAME="hgVersion" ID="hgVersion"></a> | 73 <a NAME="hgVersion" ID="hgVersion"></a> |
| 62 <h2>hgVersion</h2> | 74 <h2>hgVersion</h2> |
| 63 <b>hgVersion</b>(<i>plugin</i>) | 75 <b>hgVersion</b>(<i>plugin</i>) |
| 76 | |
| 64 <p> | 77 <p> |
| 65 Public method to determine the Mercurial version. | 78 Public method to determine the Mercurial version. |
| 66 </p><dl> | 79 </p> |
| 80 <dl> | |
| 81 | |
| 67 <dt><i>plugin</i> (VcsMercurialPlugin)</dt> | 82 <dt><i>plugin</i> (VcsMercurialPlugin)</dt> |
| 68 <dd> | 83 <dd> |
| 69 reference to the plugin object | 84 reference to the plugin object |
| 70 </dd> | 85 </dd> |
| 71 </dl><dl> | 86 </dl> |
| 87 <dl> | |
| 72 <dt>Returns:</dt> | 88 <dt>Returns:</dt> |
| 73 <dd> | 89 <dd> |
| 74 tuple containing the Mercurial version as a string and as a tuple | 90 tuple containing the Mercurial version as a string and as a tuple |
| 75 and an error message. | 91 and an error message. |
| 76 </dd> | 92 </dd> |
| 77 </dl><dl> | 93 </dl> |
| 94 <dl> | |
| 78 <dt>Return Type:</dt> | 95 <dt>Return Type:</dt> |
| 79 <dd> | 96 <dd> |
| 80 tuple of str, tuple of int and str | 97 tuple of str, tuple of int and str |
| 81 </dd> | 98 </dd> |
| 82 </dl> | 99 </dl> |
| 83 <div align="right"><a href="#top">Up</a></div> | 100 <div align="right"><a href="#top">Up</a></div> |
| 84 <hr /><hr /> | 101 <hr /> |
| 102 <hr /> | |
| 85 <a NAME="prepareProcess" ID="prepareProcess"></a> | 103 <a NAME="prepareProcess" ID="prepareProcess"></a> |
| 86 <h2>prepareProcess</h2> | 104 <h2>prepareProcess</h2> |
| 87 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>) | 105 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>) |
| 106 | |
| 88 <p> | 107 <p> |
| 89 Public function to prepare the given process. | 108 Public function to prepare the given process. |
| 90 </p><dl> | 109 </p> |
| 110 <dl> | |
| 111 | |
| 91 <dt><i>proc</i></dt> | 112 <dt><i>proc</i></dt> |
| 92 <dd> | 113 <dd> |
| 93 reference to the process to be prepared (QProcess) | 114 reference to the process to be prepared (QProcess) |
| 94 </dd><dt><i>encoding</i></dt> | 115 </dd> |
| 116 <dt><i>encoding</i></dt> | |
| 95 <dd> | 117 <dd> |
| 96 encoding to be used by the process (string) | 118 encoding to be used by the process (string) |
| 97 </dd><dt><i>language</i></dt> | 119 </dd> |
| 120 <dt><i>language</i></dt> | |
| 98 <dd> | 121 <dd> |
| 99 language to be set (string) | 122 language to be set (string) |
| 100 </dd> | 123 </dd> |
| 101 </dl> | 124 </dl> |
| 102 <div align="right"><a href="#top">Up</a></div> | 125 <div align="right"><a href="#top">Up</a></div> |
