|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitUtilities</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitUtilities</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing some common utility functions for the Git package. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 <tr><td>None</td></tr> |
|
23 </table> |
|
24 <h3>Functions</h3> |
|
25 |
|
26 <table> |
|
27 |
|
28 <tr> |
|
29 <td><a href="#getConfigPath">getConfigPath</a></td> |
|
30 <td>Public function to get the filename of the config file.</td> |
|
31 </tr> |
|
32 <tr> |
|
33 <td><a href="#prepareProcess">prepareProcess</a></td> |
|
34 <td>Public function to prepare the given process.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <hr /> |
|
38 <hr /> |
|
39 <a NAME="getConfigPath" ID="getConfigPath"></a> |
|
40 <h2>getConfigPath</h2> |
|
41 <b>getConfigPath</b>(<i></i>) |
|
42 |
|
43 <p> |
|
44 Public function to get the filename of the config file. |
|
45 </p> |
|
46 <dl> |
|
47 <dt>Return:</dt> |
|
48 <dd> |
|
49 filename of the config file (string) |
|
50 </dd> |
|
51 </dl> |
|
52 <div align="right"><a href="#top">Up</a></div> |
|
53 <hr /> |
|
54 <hr /> |
|
55 <a NAME="prepareProcess" ID="prepareProcess"></a> |
|
56 <h2>prepareProcess</h2> |
|
57 <b>prepareProcess</b>(<i>proc, language=""</i>) |
|
58 |
|
59 <p> |
|
60 Public function to prepare the given process. |
|
61 </p> |
|
62 <dl> |
|
63 |
|
64 <dt><i>proc</i></dt> |
|
65 <dd> |
|
66 reference to the process to be prepared (QProcess) |
|
67 </dd> |
|
68 <dt><i>language</i></dt> |
|
69 <dd> |
|
70 language to be set (string) |
|
71 </dd> |
|
72 </dl> |
|
73 <div align="right"><a href="#top">Up</a></div> |
|
74 <hr /> |
|
75 </body></html> |