Mercurial > hg4j
changeset 380:9517df1ef7ec
Comments/javadoc
| author | Artem Tikhomirov <tikhomirov.artem@gmail.com> |
|---|---|
| date | Thu, 09 Feb 2012 18:57:14 +0100 |
| parents | fa2be7a05af6 |
| children | 6e37c7168585 |
| files | TODO src/org/tmatesoft/hg/core/HgChangeset.java src/org/tmatesoft/hg/core/HgIncomingCommand.java src/org/tmatesoft/hg/core/HgLogCommand.java src/org/tmatesoft/hg/core/HgOutgoingCommand.java src/org/tmatesoft/hg/repo/HgDataFile.java |
| diffstat | 6 files changed, 28 insertions(+), 20 deletions(-) [+] |
line wrap: on
line diff
--- a/TODO Thu Feb 09 16:47:17 2012 +0100 +++ b/TODO Thu Feb 09 18:57:14 2012 +0100 @@ -55,6 +55,10 @@ - Revlog iteration in reversed order (either support internally in RevlogStream or externally, windowed access) +RELEASE NOTES 1.0 +* Known issues and limitations: + ** Configuration files listed under HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial are not processed + Read-only support, version 1.1 ============================== Committed:
--- a/src/org/tmatesoft/hg/core/HgChangeset.java Thu Feb 09 16:47:17 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgChangeset.java Thu Feb 09 18:57:14 2012 +0100 @@ -144,7 +144,7 @@ /** * @return never <code>null</code> - * @throws HgInvalidControlFileException FIXME + * @throws HgInvalidControlFileException if access to revlog index/data entry failed */ public Nodeid getFirstParentRevision() throws HgInvalidControlFileException { if (parentHelper != null) { @@ -161,7 +161,7 @@ /** * @return never <code>null</code> - * @throws HgInvalidControlFileException FIXME + * @throws HgInvalidControlFileException if access to revlog index/data entry failed */ public Nodeid getSecondParentRevision() throws HgInvalidControlFileException { if (parentHelper != null) {
--- a/src/org/tmatesoft/hg/core/HgIncomingCommand.java Thu Feb 09 16:47:17 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgIncomingCommand.java Thu Feb 09 18:57:14 2012 +0100 @@ -100,8 +100,8 @@ * * @return list of nodes present at remote and missing locally * @throws HgRemoteConnectionException when failed to communicate with remote repository - * @throws HgInvalidControlFileException FIXME - * @throws CancelledException + * @throws HgInvalidControlFileException if access to revlog index/data entry failed + * @throws CancelledException if execution of the command was cancelled */ public List<Nodeid> executeLite() throws HgRemoteConnectionException, HgInvalidControlFileException, CancelledException { LinkedHashSet<Nodeid> result = new LinkedHashSet<Nodeid>(); @@ -122,10 +122,10 @@ * Full information about incoming changes * * @throws HgRemoteConnectionException when failed to communicate with remote repository - * @throws HgInvalidControlFileException FIXME + * @throws HgInvalidControlFileException if access to revlog index/data entry failed * @throws HgInvalidFileException to indicate failure working with locally downloaded changes in a bundle file * @throws HgCallbackTargetException to re-throw exception from the handler - * @throws CancelledException + * @throws CancelledException if execution of the command was cancelled */ public void executeFull(final HgChangesetHandler handler) throws HgRemoteConnectionException, HgInvalidControlFileException, HgInvalidFileException, HgCallbackTargetException, CancelledException { if (handler == null) {
--- a/src/org/tmatesoft/hg/core/HgLogCommand.java Thu Feb 09 16:47:17 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgLogCommand.java Thu Feb 09 18:57:14 2012 +0100 @@ -203,9 +203,9 @@ /** * * @param handler callback to process changesets. - * @throws HgCallbackTargetException FIXME + * @throws HgCallbackTargetException to re-throw exception from the handler * @throws HgException FIXME - * @throws CancelledException FIXME + * @throws CancelledException if execution of the command was cancelled * @throws IllegalArgumentException when inspector argument is null * @throws ConcurrentModificationException if this log command instance is already running */ @@ -263,11 +263,11 @@ } /** - * + * TODO documentation * @param handler - * @throws HgCallbackTargetException - * @throws HgException - * @throws CancelledException + * @throws HgCallbackTargetException to re-throw exception from the handler + * @throws HgException FIXME + * @throws CancelledException if execution of the command was cancelled */ public void execute(HgChangesetTreeHandler handler) throws HgCallbackTargetException, HgException, CancelledException { if (handler == null) {
--- a/src/org/tmatesoft/hg/core/HgOutgoingCommand.java Thu Feb 09 16:47:17 2012 +0100 +++ b/src/org/tmatesoft/hg/core/HgOutgoingCommand.java Thu Feb 09 18:57:14 2012 +0100 @@ -93,9 +93,9 @@ * Reported changes are from any branch (limits set by {@link #branch(String)} are not taken into account. * * @return list on local nodes known to be missing at remote server - * @throws HgRemoteConnectionException FIXME - * @throws HgInvalidControlFileException FIXME - * @throws CancelledException FIXME + * @throws HgRemoteConnectionException when failed to communicate with remote repository + * @throws HgInvalidControlFileException if access to revlog index/data entry failed + * @throws CancelledException if execution of the command was cancelled */ public List<Nodeid> executeLite() throws HgRemoteConnectionException, HgInvalidControlFileException, CancelledException { final ProgressSupport ps = getProgressSupport(null); @@ -111,6 +111,10 @@ * Complete information about outgoing changes * * @param handler delegate to process changes + * @throws HgRemoteConnectionException when failed to communicate with remote repository + * @throws HgInvalidControlFileException if access to revlog index/data entry failed + * @throws HgCallbackTargetException to re-throw exception from the handler + * @throws CancelledException if execution of the command was cancelled */ public void executeFull(final HgChangesetHandler handler) throws HgRemoteConnectionException, HgInvalidControlFileException, HgCallbackTargetException, CancelledException { if (handler == null) {
--- a/src/org/tmatesoft/hg/repo/HgDataFile.java Thu Feb 09 16:47:17 2012 +0100 +++ b/src/org/tmatesoft/hg/repo/HgDataFile.java Thu Feb 09 18:57:14 2012 +0100 @@ -92,7 +92,7 @@ * @param nodeid revision of the file * * @return size of the file content at the given revision - * @throws HgInvalidRevisionException if supplied argument doesn't represent revision index in this revlog + * @throws HgInvalidRevisionException if supplied nodeid doesn't identify any revision from this revlog * @throws HgDataStreamException if attempt to access file metadata failed * @throws HgInvalidControlFileException if access to revlog index/data entry failed */ @@ -127,7 +127,7 @@ * * @param sink where to pipe content to * @throws HgDataStreamException to indicate troubles reading repository file - * @throws CancelledException if operation was cancelled + * @throws CancelledException if execution of the operation was cancelled */ public void workingCopy(ByteChannel sink) throws HgDataStreamException, HgInvalidControlFileException, CancelledException { File f = getRepo().getFile(this); @@ -205,9 +205,9 @@ * @param fileRevisionIndex - revision local index, non-negative. From predefined constants, {@link HgRepository#TIP} and {@link HgRepository#WORKING_COPY} make sense. * @param sink * @throws HgDataStreamException FIXME - * @throws HgInvalidControlFileException - * @throws CancelledException - * @throws HgInvalidRevisionException + * @throws HgInvalidControlFileException if access to revlog index/data entry failed + * @throws CancelledException if execution of the operation was cancelled + * @throws HgInvalidRevisionException if supplied argument doesn't represent revision index in this revlog */ public void content(int fileRevisionIndex, ByteChannel sink) throws HgDataStreamException, HgInvalidControlFileException, CancelledException, HgInvalidRevisionException { // for data files need to check heading of the file content for possible metadata