diff -r ce4c3c401482 -r 8cacde11f4fd eric7/Documentation/Source/eric7.VCS.VersionControl.html --- a/eric7/Documentation/Source/eric7.VCS.VersionControl.html Mon Sep 27 16:41:31 2021 +0200 +++ b/eric7/Documentation/Source/eric7.VCS.VersionControl.html Mon Sep 27 16:44:54 2021 +0200 @@ -81,7 +81,7 @@ <h3>Class Attributes</h3> <table> -<tr><td>canBeAdded</td></tr><tr><td>canBeCommitted</td></tr> +<tr><td>canBeAdded</td></tr><tr><td>canBeCommitted</td></tr><tr><td>commitHistoryData</td></tr><tr><td>commitHistoryLock</td></tr> </table> <h3>Class Methods</h3> @@ -117,6 +117,18 @@ <td>Protected method to create an instance of the VCS status monitor thread.</td> </tr> <tr> +<td><a href="#VersionControl._vcsAddProjectCommitMessage">_vcsAddProjectCommitMessage</a></td> +<td>Protected method to add a commit message to the list of project specific saved messages.</td> +</tr> +<tr> +<td><a href="#VersionControl._vcsClearProjectCommitMessages">_vcsClearProjectCommitMessages</a></td> +<td>Protected method to clear the list of project specific saved messages.</td> +</tr> +<tr> +<td><a href="#VersionControl._vcsProjectCommitMessages">_vcsProjectCommitMessages</a></td> +<td>Protected method to get the list of saved commit messages.</td> +</tr> +<tr> <td><a href="#VersionControl.addArguments">addArguments</a></td> <td>Public method to add an argument list to the already present arguments.</td> </tr> @@ -177,6 +189,10 @@ <td>Public method used to add a file/directory in binary mode in the vcs.</td> </tr> <tr> +<td><a href="#VersionControl.vcsAddCommitMessage">vcsAddCommitMessage</a></td> +<td>Public method to add a commit message to the list of saved messages.</td> +</tr> +<tr> <td><a href="#VersionControl.vcsAddTree">vcsAddTree</a></td> <td>Public method to add a directory tree rooted at path in the vcs.</td> </tr> @@ -193,6 +209,10 @@ <td>Public method used to cleanup the local copy.</td> </tr> <tr> +<td><a href="#VersionControl.vcsClearCommitMessages">vcsClearCommitMessages</a></td> +<td>Public method to clear the list of saved messages.</td> +</tr> +<tr> <td><a href="#VersionControl.vcsCommandLine">vcsCommandLine</a></td> <td>Public method used to execute arbitrary vcs commands.</td> </tr> @@ -201,6 +221,10 @@ <td>Public method used to make the change of a file/directory permanent in the vcs.</td> </tr> <tr> +<td><a href="#VersionControl.vcsCommitMessages">vcsCommitMessages</a></td> +<td>Public method to get the list of saved commit messages.</td> +</tr> +<tr> <td><a href="#VersionControl.vcsConvertProject">vcsConvertProject</a></td> <td>Public method to convert an uncontrolled project to a version controlled project.</td> </tr> @@ -463,6 +487,71 @@ reference to the monitor thread (QThread) </dd> </dl> +<a NAME="VersionControl._vcsAddProjectCommitMessage" ID="VersionControl._vcsAddProjectCommitMessage"></a> +<h4>VersionControl._vcsAddProjectCommitMessage</h4> +<b>_vcsAddProjectCommitMessage</b>(<i>message</i>) + +<p> + Protected method to add a commit message to the list of project + specific saved messages. +</p> +<dl> + +<dt><i>message</i> (str)</dt> +<dd> +message to be added +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="VersionControl._vcsClearProjectCommitMessages" ID="VersionControl._vcsClearProjectCommitMessages"></a> +<h4>VersionControl._vcsClearProjectCommitMessages</h4> +<b>_vcsClearProjectCommitMessages</b>(<i></i>) + +<p> + Protected method to clear the list of project specific saved messages. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="VersionControl._vcsProjectCommitMessages" ID="VersionControl._vcsProjectCommitMessages"></a> +<h4>VersionControl._vcsProjectCommitMessages</h4> +<b>_vcsProjectCommitMessages</b>(<i></i>) + +<p> + Protected method to get the list of saved commit messages. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of saved commit messages +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> <a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a> <h4>VersionControl.addArguments</h4> <b>addArguments</b>(<i>args, argslist</i>) @@ -728,6 +817,28 @@ implemented by a subclass </dd> </dl> +<a NAME="VersionControl.vcsAddCommitMessage" ID="VersionControl.vcsAddCommitMessage"></a> +<h4>VersionControl.vcsAddCommitMessage</h4> +<b>vcsAddCommitMessage</b>(<i>message</i>) + +<p> + Public method to add a commit message to the list of saved messages. +</p> +<dl> + +<dt><i>message</i> (str)</dt> +<dd> +message to be added +</dd> +</dl> +<dl> + +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +to indicate that this method must be + implemented by a subclass +</dd> +</dl> <a NAME="VersionControl.vcsAddTree" ID="VersionControl.vcsAddTree"></a> <h4>VersionControl.vcsAddTree</h4> <b>vcsAddTree</b>(<i>path</i>) @@ -842,6 +953,21 @@ implemented by a subclass </dd> </dl> +<a NAME="VersionControl.vcsClearCommitMessages" ID="VersionControl.vcsClearCommitMessages"></a> +<h4>VersionControl.vcsClearCommitMessages</h4> +<b>vcsClearCommitMessages</b>(<i></i>) + +<p> + Public method to clear the list of saved messages. +</p> +<dl> + +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +to indicate that this method must be + implemented by a subclass +</dd> +</dl> <a NAME="VersionControl.vcsCommandLine" ID="VersionControl.vcsCommandLine"></a> <h4>VersionControl.vcsCommandLine</h4> <b>vcsCommandLine</b>(<i>name</i>) @@ -901,6 +1027,33 @@ implemented by a subclass </dd> </dl> +<a NAME="VersionControl.vcsCommitMessages" ID="VersionControl.vcsCommitMessages"></a> +<h4>VersionControl.vcsCommitMessages</h4> +<b>vcsCommitMessages</b>(<i></i>) + +<p> + Public method to get the list of saved commit messages. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of saved commit messages +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<dl> + +<dt>Raises <b>RuntimeError</b>:</dt> +<dd> +to indicate that this method must be + implemented by a subclass +</dd> +</dl> <a NAME="VersionControl.vcsConvertProject" ID="VersionControl.vcsConvertProject"></a> <h4>VersionControl.vcsConvertProject</h4> <b>vcsConvertProject</b>(<i>vcsDataDict, project, addAll=True</i>)