Sat, 26 Apr 2025 12:34:32 +0200
MicroPython
- Added a configuration option to disable the support for the no longer produced Pimoroni Pico Wireless Pack.
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric7.Plugins.VcsPlugins.vcsGit.GitUtilities</title> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
8596
d64760b2da50
Documentation Generator: streamlined the code to use an external style sheet file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
8372
diff
changeset
|
5 | <link rel="stylesheet" href="styles.css"> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | </head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | <body> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | <a NAME="top" ID="top"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | <h1>eric7.Plugins.VcsPlugins.vcsGit.GitUtilities</h1> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | Module implementing some common utility functions for the Git package. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10438
diff
changeset
|
13 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | <h3>Global Attributes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10438
diff
changeset
|
18 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | <h3>Classes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10438
diff
changeset
|
23 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <h3>Functions</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <td><a href="#getConfigPath">getConfigPath</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <td>Public function to get the filename of the config file.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <td><a href="#prepareProcess">prepareProcess</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <td>Public function to prepare the given process.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10438
diff
changeset
|
35 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <a NAME="getConfigPath" ID="getConfigPath"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <h2>getConfigPath</h2> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | <b>getConfigPath</b>(<i></i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | Public function to get the filename of the config file. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10438
diff
changeset
|
44 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | <dt>Return:</dt> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | <dd> |
10438
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
48 | filename of the config file |
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
49 | </dd> |
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
50 | </dl> |
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
51 | <dl> |
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
52 | <dt>Return Type:</dt> |
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
53 | <dd> |
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
54 | str |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | <div align="right"><a href="#top">Up</a></div> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | <a NAME="prepareProcess" ID="prepareProcess"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | <h2>prepareProcess</h2> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | <b>prepareProcess</b>(<i>proc, language=""</i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | Public function to prepare the given process. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10438
diff
changeset
|
66 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | |
10438
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
69 | <dt><i>proc</i> (QProcess)</dt> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | <dd> |
10438
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
71 | reference to the process to be prepared |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | </dd> |
10438
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
73 | <dt><i>language</i> (str)</dt> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | <dd> |
10438
4cd7e5a8b3cf
Converted some source code documentation to the new style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
75 | language to be set |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | </dd> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | </dl> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | <div align="right"><a href="#top">Up</a></div> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79 | <hr /> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10438
diff
changeset
|
80 | </body></html> |