src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffGenerator.html

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10437:2f70ca07f0af 10438:4cd7e5a8b3cf
113 <p> 113 <p>
114 Constructor 114 Constructor
115 </p> 115 </p>
116 <dl> 116 <dl>
117 117
118 <dt><i>vcs</i></dt> 118 <dt><i>vcs</i> (Git)</dt>
119 <dd> 119 <dd>
120 reference to the vcs object 120 reference to the vcs object
121 </dd> 121 </dd>
122 <dt><i>parent</i></dt> 122 <dt><i>parent</i> (QWidget)</dt>
123 <dd> 123 <dd>
124 parent widget (QWidget) 124 parent widget
125 </dd> 125 </dd>
126 </dl> 126 </dl>
127 <a NAME="GitDiffGenerator.__procFinished" ID="GitDiffGenerator.__procFinished"></a> 127 <a NAME="GitDiffGenerator.__procFinished" ID="GitDiffGenerator.__procFinished"></a>
128 <h4>GitDiffGenerator.__procFinished</h4> 128 <h4>GitDiffGenerator.__procFinished</h4>
129 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 129 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
131 <p> 131 <p>
132 Private slot connected to the finished signal. 132 Private slot connected to the finished signal.
133 </p> 133 </p>
134 <dl> 134 <dl>
135 135
136 <dt><i>exitCode</i></dt> 136 <dt><i>exitCode</i> (int)</dt>
137 <dd> 137 <dd>
138 exit code of the process (integer) 138 exit code of the process
139 </dd> 139 </dd>
140 <dt><i>exitStatus</i></dt> 140 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
141 <dd> 141 <dd>
142 exit status of the process (QProcess.ExitStatus) 142 exit status of the process
143 </dd> 143 </dd>
144 </dl> 144 </dl>
145 <a NAME="GitDiffGenerator.__processFileLine" ID="GitDiffGenerator.__processFileLine"></a> 145 <a NAME="GitDiffGenerator.__processFileLine" ID="GitDiffGenerator.__processFileLine"></a>
146 <h4>GitDiffGenerator.__processFileLine</h4> 146 <h4>GitDiffGenerator.__processFileLine</h4>
147 <b>__processFileLine</b>(<i>line, isTopDiff</i>) 147 <b>__processFileLine</b>(<i>line, isTopDiff</i>)
149 <p> 149 <p>
150 Private slot to process a line giving the old/new file. 150 Private slot to process a line giving the old/new file.
151 </p> 151 </p>
152 <dl> 152 <dl>
153 153
154 <dt><i>line</i></dt> 154 <dt><i>line</i> (str)</dt>
155 <dd> 155 <dd>
156 line to be processed (string) 156 line to be processed
157 </dd> 157 </dd>
158 <dt><i>isTopDiff</i></dt> 158 <dt><i>isTopDiff</i> (bool)</dt>
159 <dd> 159 <dd>
160 flag indicating to show the output in the top 160 flag indicating to show the output in the top
161 output widget (boolean) 161 output widget
162 </dd> 162 </dd>
163 </dl> 163 </dl>
164 <a NAME="GitDiffGenerator.__processLine" ID="GitDiffGenerator.__processLine"></a> 164 <a NAME="GitDiffGenerator.__processLine" ID="GitDiffGenerator.__processLine"></a>
165 <h4>GitDiffGenerator.__processLine</h4> 165 <h4>GitDiffGenerator.__processLine</h4>
166 <b>__processLine</b>(<i>line, isTopDiff</i>) 166 <b>__processLine</b>(<i>line, isTopDiff</i>)
168 <p> 168 <p>
169 Private method to process one line of output. 169 Private method to process one line of output.
170 </p> 170 </p>
171 <dl> 171 <dl>
172 172
173 <dt><i>line</i></dt> 173 <dt><i>line</i> (str)</dt>
174 <dd> 174 <dd>
175 output line to process (string) 175 output line to process
176 </dd> 176 </dd>
177 <dt><i>isTopDiff</i></dt> 177 <dt><i>isTopDiff</i> (bool)</dt>
178 <dd> 178 <dd>
179 flag indicating to show the output in the top 179 flag indicating to show the output in the top
180 output widget (boolean) 180 output widget
181 </dd> 181 </dd>
182 </dl> 182 </dl>
183 <a NAME="GitDiffGenerator.__readStderr" ID="GitDiffGenerator.__readStderr"></a> 183 <a NAME="GitDiffGenerator.__readStderr" ID="GitDiffGenerator.__readStderr"></a>
184 <h4>GitDiffGenerator.__readStderr</h4> 184 <h4>GitDiffGenerator.__readStderr</h4>
185 <b>__readStderr</b>(<i>process</i>) 185 <b>__readStderr</b>(<i>process</i>)
230 between stage and repo for 'work2stage2repo' mode (empty 230 between stage and repo for 'work2stage2repo' mode (empty
231 otherwise), the list of errors and a list of tuples of filenames 231 otherwise), the list of errors and a list of tuples of filenames
232 and the line into the diff output. 232 and the line into the diff output.
233 </dd> 233 </dd>
234 </dl> 234 </dl>
235 <dl>
236 <dt>Return Type:</dt>
237 <dd>
238 tuple of (list of str, list of str, list of str, list of (str, int))
239 </dd>
240 </dl>
235 <a NAME="GitDiffGenerator.start" ID="GitDiffGenerator.start"></a> 241 <a NAME="GitDiffGenerator.start" ID="GitDiffGenerator.start"></a>
236 <h4>GitDiffGenerator.start</h4> 242 <h4>GitDiffGenerator.start</h4>
237 <b>start</b>(<i>fn, versions=None, diffMode="work2repo", stashName=""</i>) 243 <b>start</b>(<i>fn, versions=None, diffMode="work2repo", stashName=""</i>)
238 244
239 <p> 245 <p>
240 Public slot to start the git diff command. 246 Public slot to start the git diff command.
241 </p> 247 </p>
242 <dl> 248 <dl>
243 249
244 <dt><i>fn</i></dt> 250 <dt><i>fn</i> (str)</dt>
245 <dd> 251 <dd>
246 filename to be diffed (string) 252 filename to be diffed
247 </dd> 253 </dd>
248 <dt><i>versions</i></dt> 254 <dt><i>versions</i> (list of up to 2 str or None)</dt>
249 <dd> 255 <dd>
250 list of versions to be diffed (list of up to 2 strings 256 list of versions to be diffed
251 or None) 257 </dd>
252 </dd> 258 <dt><i>diffMode</i> (str)</dt>
253 <dt><i>diffMode</i></dt>
254 <dd> 259 <dd>
255 indication for the type of diff to be performed ( 260 indication for the type of diff to be performed (
256 'work2repo' compares the working tree with the HEAD commit, 261 'work2repo' compares the working tree with the HEAD commit,
257 'work2stage' compares the working tree with the staging area, 262 'work2stage' compares the working tree with the staging area,
258 'stage2repo' compares the staging area with the HEAD commit, 263 'stage2repo' compares the staging area with the HEAD commit,
259 'work2stage2repo' compares the working tree with the staging area 264 'work2stage2repo' compares the working tree with the staging area
260 and the staging area with the HEAD commit, 265 and the staging area with the HEAD commit,
261 'stash' shows the diff for a stash) 266 'stash' shows the diff for a stash)
262 </dd> 267 </dd>
263 <dt><i>stashName</i></dt> 268 <dt><i>stashName</i> (str)</dt>
264 <dd> 269 <dd>
265 name of the stash to show a diff for (string) 270 name of the stash to show a diff for
266 </dd> 271 </dd>
267 </dl> 272 </dl>
268 <dl> 273 <dl>
269 <dt>Return:</dt> 274 <dt>Return:</dt>
270 <dd> 275 <dd>
271 flag indicating the start status (boolean) 276 flag indicating the start status
277 </dd>
278 </dl>
279 <dl>
280 <dt>Return Type:</dt>
281 <dd>
282 bool
272 </dd> 283 </dd>
273 </dl> 284 </dl>
274 <dl> 285 <dl>
275 286
276 <dt>Raises <b>ValueError</b>:</dt> 287 <dt>Raises <b>ValueError</b>:</dt>

eric ide

mercurial