|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitUtilities</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.vcsGit.GitUtilities</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing some common utility functions for the Git 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>Public function to get the filename of the config file.</td> |
|
45 </tr> |
|
46 <tr> |
|
47 <td><a href="#prepareProcess">prepareProcess</a></td> |
|
48 <td>Public function to prepare the given process.</td> |
|
49 </tr> |
|
50 </table> |
|
51 <hr /> |
|
52 <hr /> |
|
53 <a NAME="getConfigPath" ID="getConfigPath"></a> |
|
54 <h2>getConfigPath</h2> |
|
55 <b>getConfigPath</b>(<i></i>) |
|
56 |
|
57 <p> |
|
58 Public function to get the filename of the config file. |
|
59 </p> |
|
60 <dl> |
|
61 <dt>Return:</dt> |
|
62 <dd> |
|
63 filename of the config file (string) |
|
64 </dd> |
|
65 </dl> |
|
66 <div align="right"><a href="#top">Up</a></div> |
|
67 <hr /> |
|
68 <hr /> |
|
69 <a NAME="prepareProcess" ID="prepareProcess"></a> |
|
70 <h2>prepareProcess</h2> |
|
71 <b>prepareProcess</b>(<i>proc, language=""</i>) |
|
72 |
|
73 <p> |
|
74 Public function to prepare the given process. |
|
75 </p> |
|
76 <dl> |
|
77 |
|
78 <dt><i>proc</i></dt> |
|
79 <dd> |
|
80 reference to the process to be prepared (QProcess) |
|
81 </dd> |
|
82 <dt><i>language</i></dt> |
|
83 <dd> |
|
84 language to be set (string) |
|
85 </dd> |
|
86 </dl> |
|
87 <div align="right"><a href="#top">Up</a></div> |
|
88 <hr /> |
|
89 </body></html> |