eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitUtilities.html

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
parent 7989
a21d673a8f99
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitUtilities</title>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
21 <body>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
22 <a NAME="top" ID="top"></a>
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitUtilities</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
24
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module implementing some common utility functions for the Git package.
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
29
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
34
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <tr><td>None</td></tr>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 </table>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Functions</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
39
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
41
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <tr>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <td><a href="#getConfigPath">getConfigPath</a></td>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <td>Public function to get the filename of the config file.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
45 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
46 <tr>
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <td><a href="#prepareProcess">prepareProcess</a></td>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <td>Public function to prepare the given process.</td>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 </tr>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
51 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
52 <hr />
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <a NAME="getConfigPath" ID="getConfigPath"></a>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <h2>getConfigPath</h2>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <b>getConfigPath</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
56
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <p>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 Public function to get the filename of the config file.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
59 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
60 <dl>
7989
a21d673a8f99 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
61 <dt>Return:</dt>
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <dd>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 filename of the config file (string)
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 </dd>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </dl>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
67 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
68 <hr />
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <a NAME="prepareProcess" ID="prepareProcess"></a>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <h2>prepareProcess</h2>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <b>prepareProcess</b>(<i>proc, language=""</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
72
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <p>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 Public function to prepare the given process.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
75 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
76 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
77
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <dt><i>proc</i></dt>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <dd>
6062
926d2ad79e6d Fixed an issue in the git plug-in differentiating between local and remote branches and fixed some typos.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6020
diff changeset
80 reference to the process to be prepared (QProcess)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
81 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
82 <dt><i>language</i></dt>
6020
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <dd>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 language to be set (string)
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 </dd>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </dl>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <div align="right"><a href="#top">Up</a></div>
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <hr />
baf6da1ae288 Added the git plug-in to the core plug-ins.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </body></html>

eric ide

mercurial