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

branch
eric7
changeset 10070
9f5758c0fec1
parent 9971
773ad1f1ed22
child 10259
b51dfacef37f
equal deleted inserted replaced
10069:435cc5875135 10070:9f5758c0fec1
434 <td><a href="#Git.vcsAddTree">vcsAddTree</a></td> 434 <td><a href="#Git.vcsAddTree">vcsAddTree</a></td>
435 <td>Public method to add a directory tree rooted at path to the Git repository.</td> 435 <td>Public method to add a directory tree rooted at path to the Git repository.</td>
436 </tr> 436 </tr>
437 <tr> 437 <tr>
438 <td><a href="#Git.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td> 438 <td><a href="#Git.vcsAllRegisteredStates">vcsAllRegisteredStates</a></td>
439 <td>Public method used to get the registered states of a number of files in the vcs.</td> 439 <td></td>
440 </tr> 440 </tr>
441 <tr> 441 <tr>
442 <td><a href="#Git.vcsCheckout">vcsCheckout</a></td> 442 <td><a href="#Git.vcsCheckout">vcsCheckout</a></td>
443 <td>Public method used to check the project out of a Git repository (clone).</td> 443 <td>Public method used to check the project out of a Git repository (clone).</td>
444 </tr> 444 </tr>
494 <td><a href="#Git.vcsImport">vcsImport</a></td> 494 <td><a href="#Git.vcsImport">vcsImport</a></td>
495 <td>Public method used to import the project into the Git repository.</td> 495 <td>Public method used to import the project into the Git repository.</td>
496 </tr> 496 </tr>
497 <tr> 497 <tr>
498 <td><a href="#Git.vcsInit">vcsInit</a></td> 498 <td><a href="#Git.vcsInit">vcsInit</a></td>
499 <td>Public method used to initialize the Git repository.</td> 499 <td></td>
500 </tr> 500 </tr>
501 <tr> 501 <tr>
502 <td><a href="#Git.vcsInitConfig">vcsInitConfig</a></td> 502 <td><a href="#Git.vcsInitConfig">vcsInitConfig</a></td>
503 <td>Public method to initialize the VCS configuration.</td> 503 <td>Public method to initialize the VCS configuration.</td>
504 </tr> 504 </tr>
1596 list of remote repos (list of string) 1596 list of remote repos (list of string)
1597 </dd> 1597 </dd>
1598 </dl> 1598 </dl>
1599 <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a> 1599 <a NAME="Git.gitGetTagsList" ID="Git.gitGetTagsList"></a>
1600 <h4>Git.gitGetTagsList</h4> 1600 <h4>Git.gitGetTagsList</h4>
1601 <b>gitGetTagsList</b>(<i>repodir, withType=False</i>) 1601 <b>gitGetTagsList</b>(<i>repodir</i>)
1602 1602
1603 <p> 1603 <p>
1604 Public method to get the list of tags. 1604 Public method to get the list of tags.
1605 </p> 1605 </p>
1606 <dl> 1606 <dl>
1607 1607
1608 <dt><i>repodir</i></dt> 1608 <dt><i>repodir</i></dt>
1609 <dd> 1609 <dd>
1610 directory name of the repository (string) 1610 directory name of the repository (string)
1611 </dd>
1612 <dt><i>withType</i></dt>
1613 <dd>
1614 flag indicating to get the tag type as well (boolean)
1615 </dd> 1611 </dd>
1616 </dl> 1612 </dl>
1617 <dl> 1613 <dl>
1618 <dt>Return:</dt> 1614 <dt>Return:</dt>
1619 <dd> 1615 <dd>
2358 </dl> 2354 </dl>
2359 <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a> 2355 <a NAME="Git.vcsAllRegisteredStates" ID="Git.vcsAllRegisteredStates"></a>
2360 <h4>Git.vcsAllRegisteredStates</h4> 2356 <h4>Git.vcsAllRegisteredStates</h4>
2361 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>) 2357 <b>vcsAllRegisteredStates</b>(<i>names, dname, shortcut=True</i>)
2362 2358
2363 <p>
2364 Public method used to get the registered states of a number of files
2365 in the vcs.
2366 </p>
2367 <p>
2368 <b>Note:</b> If a shortcut is to be taken, the code will only check,
2369 if the named directory has been scanned already. If so, it is assumed,
2370 that the states for all files have been populated by the previous run.
2371 </p>
2372 <dl>
2373
2374 <dt><i>names</i></dt>
2375 <dd>
2376 dictionary with all filenames to be checked as keys
2377 </dd>
2378 <dt><i>dname</i></dt>
2379 <dd>
2380 directory to check in (string)
2381 </dd>
2382 <dt><i>shortcut</i></dt>
2383 <dd>
2384 flag indicating a shortcut should be taken (boolean)
2385 </dd>
2386 </dl>
2387 <dl>
2388 <dt>Return:</dt>
2389 <dd>
2390 the received dictionary completed with a combination of
2391 canBeCommited and canBeAdded or None in order to signal an error
2392 </dd>
2393 </dl>
2394 <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a> 2359 <a NAME="Git.vcsCheckout" ID="Git.vcsCheckout"></a>
2395 <h4>Git.vcsCheckout</h4> 2360 <h4>Git.vcsCheckout</h4>
2396 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) 2361 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
2397 2362
2398 <p> 2363 <p>
2696 </dl> 2661 </dl>
2697 <a NAME="Git.vcsInit" ID="Git.vcsInit"></a> 2662 <a NAME="Git.vcsInit" ID="Git.vcsInit"></a>
2698 <h4>Git.vcsInit</h4> 2663 <h4>Git.vcsInit</h4>
2699 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) 2664 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
2700 2665
2701 <p>
2702 Public method used to initialize the Git repository.
2703 </p>
2704 <p>
2705 The initialization is done, when a project is converted into a
2706 Git controlled project. Therefore we always return TRUE without
2707 doing anything.
2708 </p>
2709 <dl>
2710
2711 <dt><i>vcsDir</i></dt>
2712 <dd>
2713 name of the VCS directory (string)
2714 </dd>
2715 <dt><i>noDialog</i></dt>
2716 <dd>
2717 flag indicating quiet operations (boolean)
2718 </dd>
2719 </dl>
2720 <dl>
2721 <dt>Return:</dt>
2722 <dd>
2723 always TRUE
2724 </dd>
2725 </dl>
2726 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a> 2666 <a NAME="Git.vcsInitConfig" ID="Git.vcsInitConfig"></a>
2727 <h4>Git.vcsInitConfig</h4> 2667 <h4>Git.vcsInitConfig</h4>
2728 <b>vcsInitConfig</b>(<i>project</i>) 2668 <b>vcsInitConfig</b>(<i>project</i>)
2729 2669
2730 <p> 2670 <p>

eric ide

mercurial